pacnpal/django-anymail
1
0
Fork 0
mirror of https://github.com/pacnpal/django-anymail.git synced 2025-12-20 11:51:05 -05:00
Code Issues Packages Projects Releases Wiki Activity

Mandrill: don't send unnecessary empty fields

Browse Source 
Don't add empty Reply-To header and empty display names
to Mandrill send API data.

Fixes #262
This commit is contained in:
medmunds
2022-02-02 16:16:28 -08:00
committed by Mike Edmunds
parent 5fdc285e82
commit 41147b581c
2 changed files with 29 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
anymail/backends/mandrill.py
View File

@@ -104,8 +104,11 @@ class MandrillPayload(RequestsPayload):
def add_recipient(self, recipient_type, email):
assert recipient_type in ["to", "cc", "bcc"]
recipient_data = {"email": email.addr_spec, "type": recipient_type}
if email.display_name:
recipient_data["name"] = email.display_name
to_list = self.data["message"].setdefault("to", [])
to_list.append({"email": email.addr_spec, "name": email.display_name, "type": recipient_type})
to_list.append(recipient_data)
def set_subject(self, subject):
if getattr(self.message, "use_template_subject", False):
@@ -114,8 +117,9 @@ class MandrillPayload(RequestsPayload):
self.data["message"]["subject"] = subject
def set_reply_to(self, emails):
reply_to = ", ".join([str(email) for email in emails])
self.data["message"].setdefault("headers", {})["Reply-To"] = reply_to
if emails:
reply_to = ", ".join([str(email) for email in emails])
self.data["message"].setdefault("headers", {})["Reply-To"] = reply_to
def set_extra_headers(self, headers):
self.data["message"].setdefault("headers", {}).update(headers)

29
tests/test_mandrill_backend.py
View File

@@ -47,7 +47,7 @@ class MandrillBackendStandardEmailTests(MandrillBackendMockAPITestCase):
self.assertEqual(data['message']['text'], "Here is the message.")
self.assertNotIn('from_name', data['message'])
self.assertEqual(data['message']['from_email'], "from@example.com")
self.assertEqual(data['message']['to'], [{'email': 'to@example.com', 'name': '', 'type': 'to'}])
self.assertEqual(data['message']['to'], [{'email': 'to@example.com', 'type': 'to'}])
def test_name_addr(self):
"""Make sure RFC2822 name-addr format (with display-name) is allowed
@@ -66,11 +66,11 @@ class MandrillBackendStandardEmailTests(MandrillBackendMockAPITestCase):
self.assertEqual(data['message']['from_email'], "from@example.com")
self.assertEqual(data['message']['to'], [
{'email': 'to1@example.com', 'name': 'Recipient #1', 'type': 'to'},
{'email': 'to2@example.com', 'name': '', 'type': 'to'},
{'email': 'to2@example.com', 'type': 'to'},
{'email': 'cc1@example.com', 'name': 'Carbon Copy', 'type': 'cc'},
{'email': 'cc2@example.com', 'name': '', 'type': 'cc'},
{'email': 'cc2@example.com', 'type': 'cc'},
{'email': 'bcc1@example.com', 'name': 'Blind Copy', 'type': 'bcc'},
{'email': 'bcc2@example.com', 'name': '', 'type': 'bcc'},
{'email': 'bcc2@example.com', 'type': 'bcc'},
])
def test_email_message(self):
@@ -94,11 +94,11 @@ class MandrillBackendStandardEmailTests(MandrillBackendMockAPITestCase):
'Message-ID': 'mycustommsgid@example.com'})
# Verify recipients correctly identified as "to", "cc", or "bcc"
self.assertEqual(data['message']['to'], [
{'email': 'to1@example.com', 'name': '', 'type': 'to'},
{'email': 'to1@example.com', 'type': 'to'},
{'email': 'to2@example.com', 'name': 'Also To', 'type': 'to'},
{'email': 'cc1@example.com', 'name': '', 'type': 'cc'},
{'email': 'cc1@example.com', 'type': 'cc'},
{'email': 'cc2@example.com', 'name': 'Also CC', 'type': 'cc'},
{'email': 'bcc1@example.com', 'name': '', 'type': 'bcc'},
{'email': 'bcc1@example.com', 'type': 'bcc'},
{'email': 'bcc2@example.com', 'name': 'Also BCC', 'type': 'bcc'},
])
# Don't use Mandrill's bcc_address "logging" feature for bcc's:
@@ -551,6 +551,21 @@ class MandrillBackendAnymailFeatureTests(MandrillBackendMockAPITestCase):
self.assertIn("Don't know how to send this data to Mandrill", str(err)) # our added context
self.assertRegex(str(err), r"Decimal.*is not JSON serializable") # original message
def test_no_extraneous_fields(self):
"""Don't send empty fields that have no effect on sending"""
mail.send_mail("Subject", "Body", "from@example.com", ["to@example.com"])
data = self.get_api_call_json()
# Simple send should contain exactly this, nothing more:
self.assertEqual(data, {
"key": "test_api_key",
"message": {
"from_email": "from@example.com",
"to": [{"email": "to@example.com", "type": "to"}],
"subject": "Subject",
"text": "Body",
},
})
@tag('mandrill')
class MandrillBackendRecipientsRefusedTests(MandrillBackendMockAPITestCase):