Add support for attachments (tuples and MIMEBase instances)

Author: Nikolay Blokhin

djcelery_email/utils.py

@@ -1,4 +1,6 @@
 import copy
+import base64
+from email.mime.base import MIMEBase
 
 from django.conf import settings
 from django.core.mail import EmailMultiAlternatives, EmailMessage
@@ -31,7 +33,7 @@ def email_to_dict(message):
                     'to': message.to,
                     'bcc': message.bcc,
                     # ignore connection
-                    'attachments': message.attachments,
+                    'attachments': [],
                     'headers': message.extra_headers,
                     'cc': message.cc}
 
@@ -47,6 +49,17 @@ def email_to_dict(message):
     if message.mixed_subtype != EmailMessage.mixed_subtype:
         message_dict["mixed_subtype"] = message.mixed_subtype
 
+    attachments = message.attachments
+    for attachment in attachments:
+        if isinstance(attachment, MIMEBase):
+            filename = attachment.get_filename('')
+            binary_contents = attachment.get_payload(decode=True)
+            mimetype = attachment.get_content_type()
+        else:
+            filename, binary_contents, mimetype = attachment
+        contents = base64.b64encode(binary_contents).decode('ascii')
+        message_dict['attachments'].append((filename, contents, mimetype))
+
     if settings.CELERY_EMAIL_MESSAGE_EXTRA_ATTRIBUTES:
         for attr in settings.CELERY_EMAIL_MESSAGE_EXTRA_ATTRIBUTES:
             if hasattr(message, attr):
@@ -62,6 +75,13 @@ def dict_to_email(messagedict):
         for attr in settings.CELERY_EMAIL_MESSAGE_EXTRA_ATTRIBUTES:
             if attr in messagedict:
                 extra_attrs[attr] = messagedict.pop(attr)
+    attachments = messagedict.pop('attachments')
+    messagedict['attachments'] = []
+    for attachment in attachments:
+        filename, contents, mimetype = attachment
+        binary_contents = base64.b64decode(contents.encode('ascii'))
+        messagedict['attachments'].append(
+            (filename, binary_contents, mimetype))
     if isinstance(messagedict, dict) and "content_subtype" in messagedict:
         content_subtype = messagedict["content_subtype"]
         del messagedict["content_subtype"]

tests/image.png

@@ -1,3 +1,7 @@
+import json
+import os.path
+from email.mime.image import MIMEImage
+
 from django.core import mail
 from django.core.mail.backends.base import BaseEmailBackend
 from django.core.mail.backends import locmem
@@ -44,6 +48,41 @@ def test_dict_to_email_extra_attrs(self):
 
         self.assertEquals(email_to_dict(dict_to_email(msg_dict)), msg_dict)
 
+    def check_json_of_msg(self, msg):
+        serialized = json.dumps(email_to_dict(msg))
+        self.assertEqual(
+            email_to_dict(dict_to_email(json.loads(serialized))),
+            email_to_dict(msg))
+
+    def test_email_with_attachment(self):
+        file_path = os.path.join(os.path.dirname(__file__), 'image.png')
+        with open(file_path, 'rb') as file:
+            file_contents = file.read()
+        msg = mail.EmailMessage(
+            'test', 'Testing with Celery! w00t!!', '[email protected]',
+            ['[email protected]'])
+        msg.attach('image.png', file_contents)
+        self.check_json_of_msg(msg)
+
+    def test_email_with_mime_attachment(self):
+        file_path = os.path.join(os.path.dirname(__file__), 'image.png')
+        with open(file_path, 'rb') as file:
+            file_contents = file.read()
+        mimg = MIMEImage(file_contents)
+        msg = mail.EmailMessage(
+            'test', 'Testing with Celery! w00t!!', '[email protected]',
+            ['[email protected]'])
+        msg.attach(mimg)
+        self.check_json_of_msg(msg)
+
+    def test_email_with_attachment_from_file(self):
+        file_path = os.path.join(os.path.dirname(__file__), 'image.png')
+        msg = mail.EmailMessage(
+            'test', 'Testing with Celery! w00t!!', '[email protected]',
+            ['[email protected]'])
+        msg.attach_file(file_path)
+        self.check_json_of_msg(msg)
+
 
 class TaskTests(TestCase):
     """