Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow creation of Mail from EmailMessage #631

Merged
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions sendgrid/helpers/mail/mail.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
"""v3/mail/send response body builder"""
from .personalization import Personalization
from .header import Header
from .email import Email
from .content import Content


class Mail(object):
Expand Down Expand Up @@ -141,3 +143,28 @@ def get(self):

return {key: value for key, value in mail.items()
if value is not None and value != [] and value != {}}

@classmethod
def from_EmailMessage(cls, message):
"""Create a Mail object from an instance of
email.message.EmailMessage.
:type message: email.message.EmailMessage
:rtype: Mail
"""
mail = cls(
from_email=Email(message.get('From')),
subject=message.get('Subject'),
to_email=Email(message.get('To')),
)
try:
body = message.get_content()
except AttributeError:
# Python2
body = message.get_payload()
mail.add_content(Content(
message.get_content_type(),
body.strip()
))
for k, v in message.items():
mail.add_header(Header(k, v))
return mail
30 changes: 30 additions & 0 deletions test/test_mail.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@
import json
import unittest

try:
from email.message import EmailMessage
except ImportError:
# Python2
from email import message
EmailMessage = message.Message

from sendgrid.helpers.mail import (
ASM,
APIKeyIncludedException,
Expand Down Expand Up @@ -557,3 +564,26 @@ def test_disable_tracking(self):
def test_directly_setting_substitutions(self):
personalization = Personalization()
personalization.substitutions = [{'a': 0}]

def test_from_emailmessage(self):
message = EmailMessage()
body = 'message that is not urgent'
try:
message.set_content(body)
except AttributeError:
# Python2
message.set_payload(body)
message.set_default_type('text/plain')
message['Subject'] = 'URGENT TITLE'
message['From'] = 'test@example.com'
message['To'] = 'test@sendgrid.com'
mail = Mail.from_EmailMessage(message)
self.assertEqual(mail.subject, 'URGENT TITLE')
self.assertEqual(mail.from_email.email, 'test@example.com')
self.assertEqual(len(mail.personalizations), 1)
self.assertEqual(len(mail.personalizations[0].tos), 1)
self.assertDictEqual(mail.personalizations[0].tos[0], {'email': 'test@sendgrid.com'})
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Python docs show that assertEqual will already use assertDictEqual to compare dicts by default and that it isn't necessary to call it directly.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to know! I'll make the correction.

self.assertEqual(len(mail.contents), 1)
content = mail.contents[0]
self.assertEqual(content.type, 'text/plain')
self.assertEqual(content.value, 'message that is not urgent')