mirror of
https://github.com/pacnpal/django-anymail.git
synced 2025-12-20 03:41:05 -05:00
6b6793016e
[RFC-5322 allows](https://tools.ietf.org/html/rfc5322#section-3.6.2) multiple addresses in the From header. Django's SMTP backend supports this, as a single comma-separated string (*not* a list of strings like the recipient params): from_email='one@example.com, two@example.com' to=['one@example.com', 'two@example.com'] Both Mailgun and SparkPost support multiple From addresses (and Postmark accepts them, though truncates to the first one on their end). For compatibility with Django -- and because Anymail attempts to support all ESP features -- Anymail now allows multiple From addresses, too, for ESPs that support it. Note: as a practical matter, deliverability with multiple From addresses is pretty bad. (Google outright rejects them.) This change also reworks Anymail's internal ParsedEmail object, and approach to parsing addresses, for better consistency with Django's SMTP backend and improved error messaging. In particular, Django (and now Anymail) allows multiple email addresses in a single recipient string: to=['one@example.com', 'two@example.com, three@example.com'] len(to) == 2 # but there will be three recipients Fixes #60
179 lines
8.5 KiB
Python
179 lines
8.5 KiB
Python
import os
|
|
import logging
|
|
import unittest
|
|
from datetime import datetime, timedelta
|
|
from time import mktime, sleep
|
|
|
|
import requests
|
|
from django.test import SimpleTestCase
|
|
from django.test.utils import override_settings
|
|
|
|
from anymail.exceptions import AnymailAPIError
|
|
from anymail.message import AnymailMessage
|
|
|
|
from .utils import AnymailTestMixin, sample_image_path, RUN_LIVE_TESTS
|
|
|
|
MAILGUN_TEST_API_KEY = os.getenv('MAILGUN_TEST_API_KEY')
|
|
MAILGUN_TEST_DOMAIN = os.getenv('MAILGUN_TEST_DOMAIN')
|
|
|
|
|
|
@unittest.skipUnless(RUN_LIVE_TESTS, "RUN_LIVE_TESTS disabled in this environment")
|
|
@unittest.skipUnless(MAILGUN_TEST_API_KEY and MAILGUN_TEST_DOMAIN,
|
|
"Set MAILGUN_TEST_API_KEY and MAILGUN_TEST_DOMAIN environment variables "
|
|
"to run Mailgun integration tests")
|
|
@override_settings(ANYMAIL={'MAILGUN_API_KEY': MAILGUN_TEST_API_KEY,
|
|
'MAILGUN_SENDER_DOMAIN': MAILGUN_TEST_DOMAIN,
|
|
'MAILGUN_SEND_DEFAULTS': {'esp_extra': {'o:testmode': 'yes'}}},
|
|
EMAIL_BACKEND="anymail.backends.mailgun.EmailBackend")
|
|
class MailgunBackendIntegrationTests(SimpleTestCase, AnymailTestMixin):
|
|
"""Mailgun API integration tests
|
|
|
|
These tests run against the **live** Mailgun API, using the
|
|
environment variable `MAILGUN_TEST_API_KEY` as the API key
|
|
and `MAILGUN_TEST_DOMAIN` as the sender domain.
|
|
If those variables are not set, these tests won't run.
|
|
|
|
"""
|
|
|
|
def setUp(self):
|
|
super(MailgunBackendIntegrationTests, self).setUp()
|
|
self.message = AnymailMessage('Anymail integration test', 'Text content',
|
|
'from@example.com', ['to@example.com'])
|
|
self.message.attach_alternative('<p>HTML content</p>', "text/html")
|
|
|
|
def fetch_mailgun_events(self, message_id, event=None,
|
|
initial_delay=2, retry_delay=2, max_retries=5):
|
|
"""Return list of Mailgun events related to message_id"""
|
|
url = "https://api.mailgun.net/v3/%s/events" % MAILGUN_TEST_DOMAIN
|
|
auth = ("api", MAILGUN_TEST_API_KEY)
|
|
|
|
# Despite the docs, Mailgun's events API actually expects the message-id
|
|
# without the <...> brackets (so, not exactly "as returned by the messages API")
|
|
# https://documentation.mailgun.com/api-events.html#filter-field
|
|
params = {'message-id': message_id[1:-1]} # strip <...>
|
|
if event is not None:
|
|
params['event'] = event
|
|
|
|
# It can take a few seconds for the events to show up
|
|
# in Mailgun's logs, so retry a few times if necessary:
|
|
sleep(initial_delay)
|
|
response = None
|
|
for retry in range(max_retries):
|
|
if retry > 0:
|
|
sleep(retry_delay)
|
|
response = requests.get(url, auth=auth, params=params)
|
|
if 200 == response.status_code:
|
|
items = response.json()["items"]
|
|
if len(items) > 0:
|
|
return items
|
|
# else no matching events found yet, so try again after delay
|
|
elif 500 <= response.status_code < 600:
|
|
# server error (hopefully transient); try again after delay
|
|
pass
|
|
elif 403 == response.status_code:
|
|
# "forbidden": this may be related to API throttling; try again after delay
|
|
pass
|
|
else:
|
|
response.raise_for_status()
|
|
# Max retries exceeded:
|
|
if response is not None and 200 != response.status_code:
|
|
logging.warning("Ignoring Mailgun events API error %d:\n%s"
|
|
% (response.status_code, response.text))
|
|
return None
|
|
|
|
def test_simple_send(self):
|
|
# Example of getting the Mailgun send status and message id from the message
|
|
sent_count = self.message.send()
|
|
self.assertEqual(sent_count, 1)
|
|
|
|
anymail_status = self.message.anymail_status
|
|
sent_status = anymail_status.recipients['to@example.com'].status
|
|
message_id = anymail_status.recipients['to@example.com'].message_id
|
|
|
|
self.assertEqual(sent_status, 'queued') # Mailgun always queues
|
|
self.assertGreater(len(message_id), 0) # don't know what it'll be, but it should exist
|
|
|
|
self.assertEqual(anymail_status.status, {sent_status}) # set of all recipient statuses
|
|
self.assertEqual(anymail_status.message_id, message_id)
|
|
|
|
def test_all_options(self):
|
|
send_at = datetime.now().replace(microsecond=0) + timedelta(minutes=2)
|
|
send_at_timestamp = mktime(send_at.timetuple()) # python3: send_at.timestamp()
|
|
message = AnymailMessage(
|
|
subject="Anymail all-options integration test",
|
|
body="This is the text body",
|
|
from_email="Test From <from@example.com>, also-from@example.com",
|
|
to=["to1@example.com", "Recipient 2 <to2@example.com>"],
|
|
cc=["cc1@example.com", "Copy 2 <cc2@example.com>"],
|
|
bcc=["bcc1@example.com", "Blind Copy 2 <bcc2@example.com>"],
|
|
reply_to=["reply1@example.com", "Reply 2 <reply2@example.com>"],
|
|
headers={"X-Anymail-Test": "value"},
|
|
|
|
metadata={"meta1": "simple string", "meta2": 2},
|
|
send_at=send_at,
|
|
tags=["tag 1", "tag 2"],
|
|
track_clicks=False,
|
|
track_opens=True,
|
|
)
|
|
message.attach("attachment1.txt", "Here is some\ntext for you", "text/plain")
|
|
message.attach("attachment2.csv", "ID,Name\n1,3", "text/csv")
|
|
cid = message.attach_inline_image_file(sample_image_path(), domain=MAILGUN_TEST_DOMAIN)
|
|
message.attach_alternative(
|
|
"<div>This is the <i>html</i> body <img src='cid:%s'></div>" % cid,
|
|
"text/html")
|
|
|
|
message.send()
|
|
self.assertEqual(message.anymail_status.status, {'queued'}) # Mailgun always queues
|
|
message_id = message.anymail_status.message_id
|
|
|
|
events = self.fetch_mailgun_events(message_id, event="accepted")
|
|
if events is None:
|
|
self.skipTest("No Mailgun 'accepted' event after 30sec -- can't complete this test")
|
|
return
|
|
|
|
event = events.pop()
|
|
self.assertCountEqual(event["tags"], ["tag 1", "tag 2"]) # don't care about order
|
|
self.assertEqual(event["user-variables"],
|
|
{"meta1": "simple string", "meta2": "2"}) # all metadata values become strings
|
|
|
|
self.assertEqual(event["message"]["scheduled-for"], send_at_timestamp)
|
|
self.assertIn(event["recipient"], ['to1@example.com', 'to2@example.com', 'cc1@example.com',
|
|
'cc2@example.com', 'bcc1@example.com', 'bcc2@example.com'])
|
|
|
|
headers = event["message"]["headers"]
|
|
self.assertEqual(headers["from"], "Test From <from@example.com>, also-from@example.com")
|
|
self.assertEqual(headers["to"], "to1@example.com, Recipient 2 <to2@example.com>")
|
|
self.assertEqual(headers["subject"], "Anymail all-options integration test")
|
|
|
|
attachments = event["message"]["attachments"]
|
|
self.assertEqual(len(attachments), 2) # because inline image shouldn't be an attachment
|
|
self.assertEqual(attachments[0]["filename"], "attachment1.txt")
|
|
self.assertEqual(attachments[0]["content-type"], "text/plain")
|
|
self.assertEqual(attachments[1]["filename"], "attachment2.csv")
|
|
self.assertEqual(attachments[1]["content-type"], "text/csv")
|
|
|
|
# No other fields are verifiable from the event data.
|
|
# (We could try fetching the message from event["storage"]["url"]
|
|
# to verify content and other headers.)
|
|
|
|
# As of Anymail 0.10, this test is no longer possible, because
|
|
# Anymail now raises AnymailInvalidAddress without even calling Mailgun
|
|
# def test_invalid_from(self):
|
|
# self.message.from_email = 'webmaster'
|
|
# with self.assertRaises(AnymailAPIError) as cm:
|
|
# self.message.send()
|
|
# err = cm.exception
|
|
# self.assertEqual(err.status_code, 400)
|
|
# self.assertIn("'from' parameter is not a valid address", str(err))
|
|
|
|
@override_settings(ANYMAIL={'MAILGUN_API_KEY': "Hey, that's not an API key",
|
|
'MAILGUN_SENDER_DOMAIN': MAILGUN_TEST_DOMAIN,
|
|
'MAILGUN_SEND_DEFAULTS': {'esp_extra': {'o:testmode': 'yes'}}})
|
|
def test_invalid_api_key(self):
|
|
with self.assertRaises(AnymailAPIError) as cm:
|
|
self.message.send()
|
|
err = cm.exception
|
|
self.assertEqual(err.status_code, 401)
|
|
# Mailgun doesn't offer any additional explanation in its response body
|
|
# self.assertIn("Forbidden", str(err))
|