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

Restructured the EmailMultiAlternatives docs.

Browse Source
This commit is contained in:
Sarah Boyce 2024-06-18 10:34:31 +02:00
parent 38ad710aba
commit 1b21feeb7b
1 changed files with 30 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
docs/topics/email.txt
View File

@ -380,26 +380,43 @@ The class has the following methods:
``attach()``. ``attach()``.
Sending alternative content types Sending alternative content types
---------------------------------
Sending multiple content versions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
It can be useful to include multiple versions of the content in an email; the It can be useful to include multiple versions of the content in an email; the
classic example is to send both text and HTML versions of a message. With classic example is to send both text and HTML versions of a message. With
Django's email library, you can do this using the ``EmailMultiAlternatives`` Django's email library, you can do this using the
class. This subclass of :class:`~django.core.mail.EmailMessage` has an :class:`~django.core.mail.EmailMultiAlternatives` class.
``attach_alternative()`` method for including extra versions of the message
body in the email. All the other methods (including the class initialization)
are inherited directly from :class:`~django.core.mail.EmailMessage`.
To send a text and HTML combination, you could write:: .. class:: EmailMultiAlternatives
from django.core.mail import EmailMultiAlternatives A subclass of :class:`~django.core.mail.EmailMessage` that has an
additional ``attach_alternative()`` method for including extra versions of
the message body in the email. All the other methods (including the class
initialization) are inherited directly from
:class:`~django.core.mail.EmailMessage`.
subject, from_email, to = "hello", "from@example.com", "to@example.com" .. method:: attach_alternative(content, mimetype)
text_content = "This is an important message."
html_content = "<p>This is an <strong>important</strong> message.</p>" Attach an alternative representation of the message body in the email.
msg = EmailMultiAlternatives(subject, text_content, from_email, [to])
msg.attach_alternative(html_content, "text/html") For example, to send a text and HTML combination, you could write::
msg.send()
from django.core.mail import EmailMultiAlternatives
subject = "hello"
from_email = "from@example.com"
to = "to@example.com"
text_content = "This is an important message."
html_content = "<p>This is an <strong>important</strong> message.</p>"
msg = EmailMultiAlternatives(subject, text_content, from_email, [to])
msg.attach_alternative(html_content, "text/html")
msg.send()
Updating the default content type
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
By default, the MIME type of the ``body`` parameter in an By default, the MIME type of the ``body`` parameter in an
:class:`~django.core.mail.EmailMessage` is ``"text/plain"``. It is good :class:`~django.core.mail.EmailMessage` is ``"text/plain"``. It is good