Changeset 5548

Timestamp:

06/27/07 07:18:05 (1 year ago)

Author:

mtredinnick

Message:

Added support for creating multipart/alternative email messages. Also allow
tweaking of main body MIME subtype for brave people. Fixed #3605.

Files:

• django/trunk/django/core/mail.py (modified) (4 diffs)
• django/trunk/docs/email.txt (modified) (1 diff)

django/trunk/django/core/mail.py

@@ -170 +170 @@
-    A container for email information.
-    """
+    content_subtype = 'plain'
+    multipart_subtype = 'mixed'
+
-    def __init__(self, subject='', body='', from_email=None, to=None, bcc=None,
-            connection=None, attachments=None):
@@ -186 +189 @@
-
-    def message(self):
-'plain'
+self.content_subtype
-        if self.attachments:
-            body_msg = msg
-
+_subtype=self.multipart_subtype
-            if self.body:
-                msg.attach(body_msg)
@@ -217 +220 @@
-        return self.get_connection(fail_silently).send_messages([self])
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-        """
-        if isinstance(filename, MIMEBase):
+            assert content == mimetype == None
-            self.attachements.append(filename)
-        else:
@@ -253 +259 @@
-            attachment.set_payload(content)
-            Encoders.encode_base64(attachment)
-
+
+
-        return attachment
+
+class EmailMultiAlternatives(EmailMessage):
+    """
+    A version of EmailMessage that makes it easy to send multipart/alternative
+    messages. For example, including text and HTML versions of the text is
+    made easier.
+    """
+    multipart_subtype = 'alternative'
+
+    def attach_alternative(self, content, mimetype=None):
+        """Attach an alternative content representation."""
+        self.attach(content=content, mimetype=mimetype)
-
-def send_mail(subject, message, from_email, recipient_list, fail_silently=False, auth_user=None, auth_password=None):

django/trunk/docs/email.txt

@@ -282 +282 @@
-        message.attach_file('/images/weather_map.png')
-
+Sending alternative content types
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+It is often useful to include multiple versions of the content in an e-mail.
+For instance, sending both text and HTML versions of an e-mail. You can do
+this using the ``EmailMultiAlternatives`` class. This sub-class of
+``EmailMessage`` has an ``attach_alternative()`` method for including
+extra versions of the message body in the e-mail. All the other methods
+(including the class initialization) are inherited directly from
+``EmailMessage``.
+
+To send a text and HTML combination, you could write::
+
+    from django.core.mail import EmailMultiAlternatives
+
+    subject, from_email, to = ...
+    text_content = "This is an important message."
+    html_content = "<p>This is an <strong>important</strong> message."
+    msg = EmailMultiAlternatives(subject, text_content, from_email, to)
+    msg.attach_alternative(html_content, "text/html")
+    msg.send()
+
+
+
+By default, the MIME type of the ``body`` parameter in an ``EmailMessage`` is
+``"text/plain"``. It is good practice to leave this alone, since it guarantees
+that any recipient will be able to read the e-mail, regardless of their mail
+client. However, if you are confident that your recipients can handle an
+alternative content type, you can use the ``content_subtype`` attribute on the
+``EmailMessage`` class to change the main content type. The major type will
+always be ``"text"``, but you can change to the subtype. For example::
+
+    msg = EmailMessage(subject, html_content, from_email, to)
+    msg.content_subtype = "html"  # Main content is now text/html
+    msg.send()
+
-SMTP network connections
--------------------------