mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-22 17:16:24 +00:00
Code Issues 25 Releases Wiki Activity

Cleaned up EmailMultiAlternatives docs.

Browse Source
This commit is contained in:
Sarah Boyce 2024-06-20 10:49:56 +02:00
parent 20c2d625d3
commit 7a0cd09f9f
1 changed files with 21 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
docs/topics/email.txt
View File

@ -397,11 +397,27 @@ Django's email library, you can do this using the
.. class:: EmailMultiAlternatives
A subclass of :class:`~django.core.mail.EmailMessage` that allows
additional versions of the message body in the email via the
``attach_alternative()`` method. This directly inherits all methods
(including the class initialization) from
:class:`~django.core.mail.EmailMessage`.
A subclass of :class:`EmailMessage` that allows additional versions of the
message body in the email via the :meth:`attach_alternative` method. This
directly inherits all methods (including the class initialization) from
:class:`EmailMessage`.
.. attribute:: alternatives
A list of named tuples with attributes ``(content, mimetype)``. This is
particularly useful in tests::
self.assertEqual(len(msg.alternatives), 1)
self.assertEqual(msg.alternatives[0].content, html_content)
self.assertEqual(msg.alternatives[0].mimetype, "text/html")
Alternatives should only be added using the :meth:`attach_alternative`
method.
.. versionchanged:: 5.2
In older versions, ``alternatives`` was a list of regular tuples,
as opposed to named tuples.
.. method:: attach_alternative(content, mimetype)
@ -420,24 +436,6 @@ Django's email library, you can do this using the
msg.attach_alternative(html_content, "text/html")
msg.send()
.. attribute:: alternatives
A list of named tuples with attributes ``(content, mimetype)``. This is
particularly useful in tests::
self.assertEqual(len(msg.alternatives), 1)
self.assertEqual(msg.alternatives[0].content, html_content)
self.assertEqual(msg.alternatives[0].mimetype, "text/html")
Alternatives should only be added using the
:meth:`~django.core.mail.EmailMultiAlternatives.attach_alternative`
method.
.. versionchanged:: 5.2
In older versions, ``alternatives`` was a list of regular tuples, as opposed
to named tuples.
Updating the default content type
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~