mirror of
https://github.com/pacnpal/django-anymail.git
synced 2025-12-20 03:41:05 -05:00
Reformat code with automated tools
Apply standardized code style
This commit is contained in:
medmunds
@@ -1,5 +1,5 @@
|
||||
import json
|
||||
from base64 import b64encode, b64decode
|
||||
from base64 import b64decode, b64encode
|
||||
from datetime import date, datetime, timezone
|
||||
from decimal import Decimal
|
||||
from email.mime.base import MIMEBase
|
||||
@@ -7,47 +7,76 @@ from email.mime.image import MIMEImage
|
||||
|
||||
from django.core import mail
|
||||
from django.test import SimpleTestCase, override_settings, tag
|
||||
from django.utils.timezone import get_fixed_timezone, override as override_current_timezone
|
||||
from django.utils.timezone import (
|
||||
get_fixed_timezone,
|
||||
override as override_current_timezone,
|
||||
)
|
||||
|
||||
from anymail.exceptions import (AnymailAPIError, AnymailConfigurationError, AnymailSerializationError,
|
||||
AnymailUnsupportedFeature)
|
||||
from anymail.exceptions import (
|
||||
AnymailAPIError,
|
||||
AnymailConfigurationError,
|
||||
AnymailSerializationError,
|
||||
AnymailUnsupportedFeature,
|
||||
)
|
||||
from anymail.message import attach_inline_image_file
|
||||
from .mock_requests_backend import RequestsBackendMockAPITestCase, SessionSharingTestCases
|
||||
from .utils import sample_image_content, sample_image_path, SAMPLE_IMAGE_FILENAME, AnymailTestMixin
|
||||
|
||||
from .mock_requests_backend import (
|
||||
RequestsBackendMockAPITestCase,
|
||||
SessionSharingTestCases,
|
||||
)
|
||||
from .utils import (
|
||||
SAMPLE_IMAGE_FILENAME,
|
||||
AnymailTestMixin,
|
||||
sample_image_content,
|
||||
sample_image_path,
|
||||
)
|
||||
|
||||
|
||||
@tag('sendinblue')
|
||||
@override_settings(EMAIL_BACKEND='anymail.backends.sendinblue.EmailBackend',
|
||||
ANYMAIL={'SENDINBLUE_API_KEY': 'test_api_key'})
|
||||
@tag("sendinblue")
|
||||
@override_settings(
|
||||
EMAIL_BACKEND="anymail.backends.sendinblue.EmailBackend",
|
||||
ANYMAIL={"SENDINBLUE_API_KEY": "test_api_key"},
|
||||
)
|
||||
class SendinBlueBackendMockAPITestCase(RequestsBackendMockAPITestCase):
|
||||
# SendinBlue v3 success responses are empty
|
||||
DEFAULT_RAW_RESPONSE = b'{"messageId":"<201801020304.1234567890@smtp-relay.mailin.fr>"}'
|
||||
DEFAULT_STATUS_CODE = 201 # SendinBlue v3 uses '201 Created' for success (in most cases)
|
||||
DEFAULT_RAW_RESPONSE = (
|
||||
b'{"messageId":"<201801020304.1234567890@smtp-relay.mailin.fr>"}'
|
||||
)
|
||||
DEFAULT_STATUS_CODE = (
|
||||
201 # SendinBlue v3 uses '201 Created' for success (in most cases)
|
||||
)
|
||||
|
||||
def setUp(self):
|
||||
super().setUp()
|
||||
# Simple message useful for many tests
|
||||
self.message = mail.EmailMultiAlternatives('Subject', 'Text Body', 'from@example.com', ['to@example.com'])
|
||||
self.message = mail.EmailMultiAlternatives(
|
||||
"Subject", "Text Body", "from@example.com", ["to@example.com"]
|
||||
)
|
||||
|
||||
|
||||
@tag('sendinblue')
|
||||
@tag("sendinblue")
|
||||
class SendinBlueBackendStandardEmailTests(SendinBlueBackendMockAPITestCase):
|
||||
"""Test backend support for Django standard email features"""
|
||||
|
||||
def test_send_mail(self):
|
||||
"""Test basic API for simple send"""
|
||||
mail.send_mail('Subject here', 'Here is the message.',
|
||||
'from@sender.example.com', ['to@example.com'], fail_silently=False)
|
||||
self.assert_esp_called('https://api.sendinblue.com/v3/smtp/email')
|
||||
mail.send_mail(
|
||||
"Subject here",
|
||||
"Here is the message.",
|
||||
"from@sender.example.com",
|
||||
["to@example.com"],
|
||||
fail_silently=False,
|
||||
)
|
||||
self.assert_esp_called("https://api.sendinblue.com/v3/smtp/email")
|
||||
http_headers = self.get_api_call_headers()
|
||||
self.assertEqual(http_headers["api-key"], "test_api_key")
|
||||
self.assertEqual(http_headers["Content-Type"], "application/json")
|
||||
|
||||
data = self.get_api_call_json()
|
||||
self.assertEqual(data['subject'], "Subject here")
|
||||
self.assertEqual(data['textContent'], "Here is the message.")
|
||||
self.assertEqual(data['sender'], {'email': "from@sender.example.com"})
|
||||
self.assertEqual(data['to'], [{'email': "to@example.com"}])
|
||||
self.assertEqual(data["subject"], "Subject here")
|
||||
self.assertEqual(data["textContent"], "Here is the message.")
|
||||
self.assertEqual(data["sender"], {"email": "from@sender.example.com"})
|
||||
self.assertEqual(data["to"], [{"email": "to@example.com"}])
|
||||
|
||||
def test_name_addr(self):
|
||||
"""Make sure RFC2822 name-addr format (with display-name) is allowed
|
||||
@@ -55,77 +84,114 @@ class SendinBlueBackendStandardEmailTests(SendinBlueBackendMockAPITestCase):
|
||||
(Test both sender and recipient addresses)
|
||||
"""
|
||||
msg = mail.EmailMessage(
|
||||
'Subject', 'Message', 'From Name <from@example.com>',
|
||||
['Recipient #1 <to1@example.com>', 'to2@example.com'],
|
||||
cc=['Carbon Copy <cc1@example.com>', 'cc2@example.com'],
|
||||
bcc=['Blind Copy <bcc1@example.com>', 'bcc2@example.com'])
|
||||
"Subject",
|
||||
"Message",
|
||||
"From Name <from@example.com>",
|
||||
["Recipient #1 <to1@example.com>", "to2@example.com"],
|
||||
cc=["Carbon Copy <cc1@example.com>", "cc2@example.com"],
|
||||
bcc=["Blind Copy <bcc1@example.com>", "bcc2@example.com"],
|
||||
)
|
||||
msg.send()
|
||||
data = self.get_api_call_json()
|
||||
self.assertEqual(data['sender'], {'email': "from@example.com", 'name': "From Name"})
|
||||
self.assertEqual(data['to'], [{'email': "to1@example.com", 'name': "Recipient #1"},
|
||||
{'email': "to2@example.com"}])
|
||||
self.assertEqual(data['cc'], [{'email': "cc1@example.com", 'name': "Carbon Copy"},
|
||||
{'email': "cc2@example.com"}])
|
||||
self.assertEqual(data['bcc'], [{'email': "bcc1@example.com", 'name': "Blind Copy"},
|
||||
{'email': "bcc2@example.com"}])
|
||||
self.assertEqual(
|
||||
data["sender"], {"email": "from@example.com", "name": "From Name"}
|
||||
)
|
||||
self.assertEqual(
|
||||
data["to"],
|
||||
[
|
||||
{"email": "to1@example.com", "name": "Recipient #1"},
|
||||
{"email": "to2@example.com"},
|
||||
],
|
||||
)
|
||||
self.assertEqual(
|
||||
data["cc"],
|
||||
[
|
||||
{"email": "cc1@example.com", "name": "Carbon Copy"},
|
||||
{"email": "cc2@example.com"},
|
||||
],
|
||||
)
|
||||
self.assertEqual(
|
||||
data["bcc"],
|
||||
[
|
||||
{"email": "bcc1@example.com", "name": "Blind Copy"},
|
||||
{"email": "bcc2@example.com"},
|
||||
],
|
||||
)
|
||||
|
||||
def test_email_message(self):
|
||||
email = mail.EmailMessage(
|
||||
'Subject', 'Body goes here', 'from@example.com',
|
||||
['to1@example.com', 'Also To <to2@example.com>'],
|
||||
bcc=['bcc1@example.com', 'Also BCC <bcc2@example.com>'],
|
||||
cc=['cc1@example.com', 'Also CC <cc2@example.com>'],
|
||||
headers={'Reply-To': 'another@example.com',
|
||||
'X-MyHeader': 'my value',
|
||||
'Message-ID': '<mycustommsgid@sales.example.com>'}) # should override backend msgid
|
||||
"Subject",
|
||||
"Body goes here",
|
||||
"from@example.com",
|
||||
["to1@example.com", "Also To <to2@example.com>"],
|
||||
bcc=["bcc1@example.com", "Also BCC <bcc2@example.com>"],
|
||||
cc=["cc1@example.com", "Also CC <cc2@example.com>"],
|
||||
headers={
|
||||
"Reply-To": "another@example.com",
|
||||
"X-MyHeader": "my value",
|
||||
# should override backend msgid:
|
||||
"Message-ID": "<mycustommsgid@sales.example.com>",
|
||||
},
|
||||
)
|
||||
email.send()
|
||||
data = self.get_api_call_json()
|
||||
self.assertEqual(data['sender'], {'email': "from@example.com"})
|
||||
self.assertEqual(data['subject'], "Subject")
|
||||
self.assertEqual(data['textContent'], "Body goes here")
|
||||
self.assertEqual(data['replyTo'], {'email': "another@example.com"})
|
||||
self.assertEqual(data['headers'], {
|
||||
'X-MyHeader': "my value",
|
||||
'Message-ID': "<mycustommsgid@sales.example.com>",
|
||||
})
|
||||
self.assertEqual(data["sender"], {"email": "from@example.com"})
|
||||
self.assertEqual(data["subject"], "Subject")
|
||||
self.assertEqual(data["textContent"], "Body goes here")
|
||||
self.assertEqual(data["replyTo"], {"email": "another@example.com"})
|
||||
self.assertEqual(
|
||||
data["headers"],
|
||||
{
|
||||
"X-MyHeader": "my value",
|
||||
"Message-ID": "<mycustommsgid@sales.example.com>",
|
||||
},
|
||||
)
|
||||
|
||||
def test_html_message(self):
|
||||
text_content = 'This is an important message.'
|
||||
html_content = '<p>This is an <strong>important</strong> message.</p>'
|
||||
email = mail.EmailMultiAlternatives('Subject', text_content,
|
||||
'from@example.com', ['to@example.com'])
|
||||
text_content = "This is an important message."
|
||||
html_content = "<p>This is an <strong>important</strong> message.</p>"
|
||||
email = mail.EmailMultiAlternatives(
|
||||
"Subject", text_content, "from@example.com", ["to@example.com"]
|
||||
)
|
||||
email.attach_alternative(html_content, "text/html")
|
||||
email.send()
|
||||
data = self.get_api_call_json()
|
||||
self.assertEqual(data['textContent'], text_content)
|
||||
self.assertEqual(data['htmlContent'], html_content)
|
||||
self.assertEqual(data["textContent"], text_content)
|
||||
self.assertEqual(data["htmlContent"], html_content)
|
||||
|
||||
# Don't accidentally send the html part as an attachment:
|
||||
self.assertNotIn('attachments', data)
|
||||
self.assertNotIn("attachments", data)
|
||||
|
||||
def test_html_only_message(self):
|
||||
html_content = '<p>This is an <strong>important</strong> message.</p>'
|
||||
email = mail.EmailMessage('Subject', html_content, 'from@example.com', ['to@example.com'])
|
||||
html_content = "<p>This is an <strong>important</strong> message.</p>"
|
||||
email = mail.EmailMessage(
|
||||
"Subject", html_content, "from@example.com", ["to@example.com"]
|
||||
)
|
||||
email.content_subtype = "html" # Main content is now text/html
|
||||
email.send()
|
||||
data = self.get_api_call_json()
|
||||
self.assertEqual(data['htmlContent'], html_content)
|
||||
self.assertNotIn('textContent', data)
|
||||
self.assertEqual(data["htmlContent"], html_content)
|
||||
self.assertNotIn("textContent", data)
|
||||
|
||||
def test_extra_headers(self):
|
||||
self.message.extra_headers = {'X-Custom': 'string', 'X-Num': 123,
|
||||
'Reply-To': '"Do Not Reply" <noreply@example.com>'}
|
||||
self.message.extra_headers = {
|
||||
"X-Custom": "string",
|
||||
"X-Num": 123,
|
||||
"Reply-To": '"Do Not Reply" <noreply@example.com>',
|
||||
}
|
||||
self.message.send()
|
||||
data = self.get_api_call_json()
|
||||
self.assertEqual(data['headers']['X-Custom'], 'string')
|
||||
self.assertEqual(data["headers"]["X-Custom"], "string")
|
||||
# Header values must be strings (changed 11/2022)
|
||||
self.assertEqual(data['headers']['X-Num'], "123")
|
||||
self.assertEqual(data["headers"]["X-Num"], "123")
|
||||
# Reply-To must be moved to separate param
|
||||
self.assertNotIn('Reply-To', data['headers'])
|
||||
self.assertEqual(data['replyTo'], {'name': "Do Not Reply", 'email': "noreply@example.com"})
|
||||
self.assertNotIn("Reply-To", data["headers"])
|
||||
self.assertEqual(
|
||||
data["replyTo"], {"name": "Do Not Reply", "email": "noreply@example.com"}
|
||||
)
|
||||
|
||||
def test_extra_headers_serialization_error(self):
|
||||
self.message.extra_headers = {'X-Custom': Decimal(12.5)}
|
||||
self.message.extra_headers = {"X-Custom": Decimal(12.5)}
|
||||
with self.assertRaisesMessage(AnymailSerializationError, "Decimal"):
|
||||
self.message.send()
|
||||
|
||||
@@ -133,25 +199,37 @@ class SendinBlueBackendStandardEmailTests(SendinBlueBackendMockAPITestCase):
|
||||
self.message.reply_to = ['"Reply recipient" <reply@example.com']
|
||||
self.message.send()
|
||||
data = self.get_api_call_json()
|
||||
self.assertEqual(data['replyTo'], {'name': "Reply recipient", 'email': "reply@example.com"})
|
||||
self.assertEqual(
|
||||
data["replyTo"], {"name": "Reply recipient", "email": "reply@example.com"}
|
||||
)
|
||||
|
||||
def test_multiple_reply_to(self):
|
||||
# SendinBlue v3 only allows a single reply address
|
||||
self.message.reply_to = ['"Reply recipient" <reply@example.com', 'reply2@example.com']
|
||||
self.message.reply_to = [
|
||||
'"Reply recipient" <reply@example.com',
|
||||
"reply2@example.com",
|
||||
]
|
||||
with self.assertRaises(AnymailUnsupportedFeature):
|
||||
self.message.send()
|
||||
|
||||
@override_settings(ANYMAIL_IGNORE_UNSUPPORTED_FEATURES=True)
|
||||
def test_multiple_reply_to_ignore_unsupported(self):
|
||||
# Should use first Reply-To if ignoring unsupported features
|
||||
self.message.reply_to = ['"Reply recipient" <reply@example.com', 'reply2@example.com']
|
||||
self.message.reply_to = [
|
||||
'"Reply recipient" <reply@example.com',
|
||||
"reply2@example.com",
|
||||
]
|
||||
self.message.send()
|
||||
data = self.get_api_call_json()
|
||||
self.assertEqual(data['replyTo'], {'name': "Reply recipient", 'email': "reply@example.com"})
|
||||
self.assertEqual(
|
||||
data["replyTo"], {"name": "Reply recipient", "email": "reply@example.com"}
|
||||
)
|
||||
|
||||
def test_attachments(self):
|
||||
text_content = "* Item one\n* Item two\n* Item three"
|
||||
self.message.attach(filename="test.txt", content=text_content, mimetype="text/plain")
|
||||
self.message.attach(
|
||||
filename="test.txt", content=text_content, mimetype="text/plain"
|
||||
)
|
||||
|
||||
# Should guess mimetype if not provided...
|
||||
png_content = b"PNG\xb4 pretend this is the contents of a png file"
|
||||
@@ -159,31 +237,41 @@ class SendinBlueBackendStandardEmailTests(SendinBlueBackendMockAPITestCase):
|
||||
|
||||
# Should work with a MIMEBase object (also tests no filename)...
|
||||
pdf_content = b"PDF\xb4 pretend this is valid pdf data"
|
||||
mimeattachment = MIMEBase('application', 'pdf')
|
||||
mimeattachment = MIMEBase("application", "pdf")
|
||||
mimeattachment.set_payload(pdf_content)
|
||||
self.message.attach(mimeattachment)
|
||||
|
||||
self.message.send()
|
||||
data = self.get_api_call_json()
|
||||
self.assertEqual(len(data['attachment']), 3)
|
||||
self.assertEqual(len(data["attachment"]), 3)
|
||||
|
||||
attachments = data['attachment']
|
||||
self.assertEqual(attachments[0], {
|
||||
'name': "test.txt",
|
||||
'content': b64encode(text_content.encode('utf-8')).decode('ascii')})
|
||||
self.assertEqual(attachments[1], {
|
||||
'name': "test.png",
|
||||
'content': b64encode(png_content).decode('ascii')})
|
||||
self.assertEqual(attachments[2], {
|
||||
'name': "",
|
||||
'content': b64encode(pdf_content).decode('ascii')})
|
||||
attachments = data["attachment"]
|
||||
self.assertEqual(
|
||||
attachments[0],
|
||||
{
|
||||
"name": "test.txt",
|
||||
"content": b64encode(text_content.encode("utf-8")).decode("ascii"),
|
||||
},
|
||||
)
|
||||
self.assertEqual(
|
||||
attachments[1],
|
||||
{"name": "test.png", "content": b64encode(png_content).decode("ascii")},
|
||||
)
|
||||
self.assertEqual(
|
||||
attachments[2],
|
||||
{"name": "", "content": b64encode(pdf_content).decode("ascii")},
|
||||
)
|
||||
|
||||
def test_unicode_attachment_correctly_decoded(self):
|
||||
self.message.attach("Une pièce jointe.html", '<p>\u2019</p>', mimetype='text/html')
|
||||
self.message.attach(
|
||||
"Une pièce jointe.html", "<p>\u2019</p>", mimetype="text/html"
|
||||
)
|
||||
self.message.send()
|
||||
attachment = self.get_api_call_json()['attachment'][0]
|
||||
self.assertEqual(attachment['name'], 'Une pièce jointe.html')
|
||||
self.assertEqual(b64decode(attachment['content']).decode('utf-8'), '<p>\u2019</p>')
|
||||
attachment = self.get_api_call_json()["attachment"][0]
|
||||
self.assertEqual(attachment["name"], "Une pièce jointe.html")
|
||||
self.assertEqual(
|
||||
b64decode(attachment["content"]).decode("utf-8"), "<p>\u2019</p>"
|
||||
)
|
||||
|
||||
def test_embedded_images(self):
|
||||
# SendinBlue doesn't support inline image
|
||||
@@ -193,7 +281,9 @@ class SendinBlueBackendStandardEmailTests(SendinBlueBackendMockAPITestCase):
|
||||
image_path = sample_image_path(image_filename)
|
||||
|
||||
cid = attach_inline_image_file(self.message, image_path) # Read from a png file
|
||||
html_content = '<p>This has an <img src="cid:%s" alt="inline" /> image.</p>' % cid
|
||||
html_content = (
|
||||
'<p>This has an <img src="cid:%s" alt="inline" /> image.</p>' % cid
|
||||
)
|
||||
self.message.attach_alternative(html_content, "text/html")
|
||||
|
||||
with self.assertRaises(AnymailUnsupportedFeature):
|
||||
@@ -204,28 +294,38 @@ class SendinBlueBackendStandardEmailTests(SendinBlueBackendMockAPITestCase):
|
||||
image_path = sample_image_path(image_filename)
|
||||
image_data = sample_image_content(image_filename)
|
||||
|
||||
self.message.attach_file(image_path) # option 1: attach as a file
|
||||
# option 1: attach as a file
|
||||
self.message.attach_file(image_path)
|
||||
|
||||
image = MIMEImage(image_data) # option 2: construct the MIMEImage and attach it directly
|
||||
# option 2: construct the MIMEImage and attach it directly
|
||||
image = MIMEImage(image_data)
|
||||
self.message.attach(image)
|
||||
|
||||
self.message.send()
|
||||
|
||||
image_data_b64 = b64encode(image_data).decode('ascii')
|
||||
image_data_b64 = b64encode(image_data).decode("ascii")
|
||||
data = self.get_api_call_json()
|
||||
self.assertEqual(data['attachment'][0], {
|
||||
'name': image_filename, # the named one
|
||||
'content': image_data_b64,
|
||||
})
|
||||
self.assertEqual(data['attachment'][1], {
|
||||
'name': '', # the unnamed one
|
||||
'content': image_data_b64,
|
||||
})
|
||||
self.assertEqual(
|
||||
data["attachment"][0],
|
||||
{
|
||||
"name": image_filename, # the named one
|
||||
"content": image_data_b64,
|
||||
},
|
||||
)
|
||||
self.assertEqual(
|
||||
data["attachment"][1],
|
||||
{
|
||||
"name": "", # the unnamed one
|
||||
"content": image_data_b64,
|
||||
},
|
||||
)
|
||||
|
||||
def test_multiple_html_alternatives(self):
|
||||
self.message.body = "Text body"
|
||||
self.message.attach_alternative("<p>First html is OK</p>", "text/html")
|
||||
self.message.attach_alternative("<p>And maybe second html, too</p>", "text/html")
|
||||
self.message.attach_alternative(
|
||||
"<p>And maybe second html, too</p>", "text/html"
|
||||
)
|
||||
|
||||
with self.assertRaises(AnymailUnsupportedFeature):
|
||||
self.message.send()
|
||||
@@ -240,11 +340,17 @@ class SendinBlueBackendStandardEmailTests(SendinBlueBackendMockAPITestCase):
|
||||
def test_api_failure(self):
|
||||
self.set_mock_response(status_code=400)
|
||||
with self.assertRaisesMessage(AnymailAPIError, "SendinBlue API response 400"):
|
||||
mail.send_mail('Subject', 'Body', 'from@example.com', ['to@example.com'])
|
||||
mail.send_mail("Subject", "Body", "from@example.com", ["to@example.com"])
|
||||
|
||||
# Make sure fail_silently is respected
|
||||
self.set_mock_response(status_code=400)
|
||||
sent = mail.send_mail('Subject', 'Body', 'from@example.com', ['to@example.com'], fail_silently=True)
|
||||
sent = mail.send_mail(
|
||||
"Subject",
|
||||
"Body",
|
||||
"from@example.com",
|
||||
["to@example.com"],
|
||||
fail_silently=True,
|
||||
)
|
||||
self.assertEqual(sent, 0)
|
||||
|
||||
def test_api_error_includes_details(self):
|
||||
@@ -267,26 +373,26 @@ class SendinBlueBackendStandardEmailTests(SendinBlueBackendMockAPITestCase):
|
||||
self.message.send()
|
||||
|
||||
|
||||
@tag('sendinblue')
|
||||
@tag("sendinblue")
|
||||
class SendinBlueBackendAnymailFeatureTests(SendinBlueBackendMockAPITestCase):
|
||||
"""Test backend support for Anymail added features"""
|
||||
|
||||
def test_envelope_sender(self):
|
||||
# SendinBlue does not have a way to change envelope sender.
|
||||
self.message.envelope_sender = "anything@bounces.example.com"
|
||||
with self.assertRaisesMessage(AnymailUnsupportedFeature, 'envelope_sender'):
|
||||
with self.assertRaisesMessage(AnymailUnsupportedFeature, "envelope_sender"):
|
||||
self.message.send()
|
||||
|
||||
def test_metadata(self):
|
||||
self.message.metadata = {'user_id': "12345", 'items': 6, 'float': 98.6}
|
||||
self.message.metadata = {"user_id": "12345", "items": 6, "float": 98.6}
|
||||
self.message.send()
|
||||
|
||||
data = self.get_api_call_json()
|
||||
|
||||
metadata = json.loads(data['headers']['X-Mailin-custom'])
|
||||
self.assertEqual(metadata['user_id'], "12345")
|
||||
self.assertEqual(metadata['items'], 6)
|
||||
self.assertEqual(metadata['float'], 98.6)
|
||||
metadata = json.loads(data["headers"]["X-Mailin-custom"])
|
||||
self.assertEqual(metadata["user_id"], "12345")
|
||||
self.assertEqual(metadata["items"], 6)
|
||||
self.assertEqual(metadata["float"], 98.6)
|
||||
|
||||
def test_send_at(self):
|
||||
utc_plus_6 = get_fixed_timezone(6 * 60)
|
||||
@@ -294,47 +400,49 @@ class SendinBlueBackendAnymailFeatureTests(SendinBlueBackendMockAPITestCase):
|
||||
|
||||
with override_current_timezone(utc_plus_6):
|
||||
# Timezone-aware datetime converted to UTC:
|
||||
self.message.send_at = datetime(2016, 3, 4, 5, 6, 7, 8000, tzinfo=utc_minus_8)
|
||||
self.message.send_at = datetime(
|
||||
2016, 3, 4, 5, 6, 7, 8000, tzinfo=utc_minus_8
|
||||
)
|
||||
self.message.send()
|
||||
data = self.get_api_call_json()
|
||||
self.assertEqual(data['scheduledAt'], "2016-03-04T05:06:07.008-08:00")
|
||||
self.assertEqual(data["scheduledAt"], "2016-03-04T05:06:07.008-08:00")
|
||||
|
||||
# Explicit UTC:
|
||||
self.message.send_at = datetime(2016, 3, 4, 5, 6, 7, tzinfo=timezone.utc)
|
||||
self.message.send()
|
||||
data = self.get_api_call_json()
|
||||
self.assertEqual(data['scheduledAt'], "2016-03-04T05:06:07.000+00:00")
|
||||
self.assertEqual(data["scheduledAt"], "2016-03-04T05:06:07.000+00:00")
|
||||
|
||||
# Timezone-naive datetime assumed to be Django current_timezone
|
||||
# (also checks stripping microseconds)
|
||||
self.message.send_at = datetime(2022, 10, 11, 12, 13, 14, 567)
|
||||
self.message.send()
|
||||
data = self.get_api_call_json()
|
||||
self.assertEqual(data['scheduledAt'], "2022-10-11T12:13:14.000+06:00")
|
||||
self.assertEqual(data["scheduledAt"], "2022-10-11T12:13:14.000+06:00")
|
||||
|
||||
# Date-only treated as midnight in current timezone
|
||||
self.message.send_at = date(2022, 10, 22)
|
||||
self.message.send()
|
||||
data = self.get_api_call_json()
|
||||
self.assertEqual(data['scheduledAt'], "2022-10-22T00:00:00.000+06:00")
|
||||
self.assertEqual(data["scheduledAt"], "2022-10-22T00:00:00.000+06:00")
|
||||
|
||||
# POSIX timestamp
|
||||
self.message.send_at = 1651820889 # 2022-05-06 07:08:09 UTC
|
||||
self.message.send()
|
||||
data = self.get_api_call_json()
|
||||
self.assertEqual(data['scheduledAt'], "2022-05-06T07:08:09.000+00:00")
|
||||
self.assertEqual(data["scheduledAt"], "2022-05-06T07:08:09.000+00:00")
|
||||
|
||||
# String passed unchanged (this is *not* portable between ESPs)
|
||||
self.message.send_at = "2022-10-13T18:02:00.123-11:30"
|
||||
self.message.send()
|
||||
data = self.get_api_call_json()
|
||||
self.assertEqual(data['scheduledAt'], "2022-10-13T18:02:00.123-11:30")
|
||||
self.assertEqual(data["scheduledAt"], "2022-10-13T18:02:00.123-11:30")
|
||||
|
||||
def test_tag(self):
|
||||
self.message.tags = ["receipt", "multiple"]
|
||||
self.message.send()
|
||||
data = self.get_api_call_json()
|
||||
self.assertEqual(data['tags'], ["receipt", "multiple"])
|
||||
self.assertEqual(data["tags"], ["receipt", "multiple"])
|
||||
|
||||
def test_tracking(self):
|
||||
# Test one way...
|
||||
@@ -353,36 +461,36 @@ class SendinBlueBackendAnymailFeatureTests(SendinBlueBackendMockAPITestCase):
|
||||
def test_template_id(self):
|
||||
# subject, body, and from_email must be None for SendinBlue template send:
|
||||
message = mail.EmailMessage(
|
||||
subject='My Subject',
|
||||
subject="My Subject",
|
||||
body=None,
|
||||
from_email='from@example.com',
|
||||
to=['Recipient <to@example.com>'], # single 'to' recommended (all 'to' get the same message)
|
||||
cc=['Recipient <cc1@example.com>', 'Recipient <cc2@example.com>'],
|
||||
bcc=['Recipient <bcc@example.com>'],
|
||||
reply_to=['Recipient <reply@example.com>'],
|
||||
from_email="from@example.com",
|
||||
# single 'to' recommended (all 'to' get the same message)
|
||||
to=["Recipient <to@example.com>"],
|
||||
cc=["Recipient <cc1@example.com>", "Recipient <cc2@example.com>"],
|
||||
bcc=["Recipient <bcc@example.com>"],
|
||||
reply_to=["Recipient <reply@example.com>"],
|
||||
)
|
||||
message.template_id = 12 # SendinBlue uses per-account numeric ID to identify templates
|
||||
# SendinBlue uses per-account numeric ID to identify templates:
|
||||
message.template_id = 12
|
||||
message.send()
|
||||
data = self.get_api_call_json()
|
||||
self.assertEqual(data['templateId'], 12)
|
||||
self.assertEqual(data['subject'], 'My Subject')
|
||||
self.assertEqual(data['to'], [{'email': "to@example.com", 'name': 'Recipient'}])
|
||||
self.assertEqual(data["templateId"], 12)
|
||||
self.assertEqual(data["subject"], "My Subject")
|
||||
self.assertEqual(data["to"], [{"email": "to@example.com", "name": "Recipient"}])
|
||||
|
||||
def test_merge_data(self):
|
||||
self.message.merge_data = {
|
||||
'alice@example.com': {':name': "Alice", ':group': "Developers"},
|
||||
'bob@example.com': {':name': "Bob"}, # and leave :group undefined
|
||||
"alice@example.com": {":name": "Alice", ":group": "Developers"},
|
||||
"bob@example.com": {":name": "Bob"}, # and leave :group undefined
|
||||
}
|
||||
with self.assertRaises(AnymailUnsupportedFeature):
|
||||
self.message.send()
|
||||
|
||||
def test_merge_global_data(self):
|
||||
self.message.merge_global_data = {
|
||||
'a': 'b'
|
||||
}
|
||||
self.message.merge_global_data = {"a": "b"}
|
||||
self.message.send()
|
||||
data = self.get_api_call_json()
|
||||
self.assertEqual(data['params'], {'a': 'b'})
|
||||
self.assertEqual(data["params"], {"a": "b"})
|
||||
|
||||
def test_default_omits_options(self):
|
||||
"""Make sure by default we don't send any ESP-specific options.
|
||||
@@ -393,59 +501,74 @@ class SendinBlueBackendAnymailFeatureTests(SendinBlueBackendMockAPITestCase):
|
||||
"""
|
||||
self.message.send()
|
||||
data = self.get_api_call_json()
|
||||
self.assertNotIn('attachment', data)
|
||||
self.assertNotIn('tag', data)
|
||||
self.assertNotIn('headers', data)
|
||||
self.assertNotIn('replyTo', data)
|
||||
self.assertNotIn('atributes', data)
|
||||
self.assertNotIn("attachment", data)
|
||||
self.assertNotIn("tag", data)
|
||||
self.assertNotIn("headers", data)
|
||||
self.assertNotIn("replyTo", data)
|
||||
self.assertNotIn("atributes", data)
|
||||
|
||||
def test_esp_extra(self):
|
||||
# SendinBlue doesn't offer any esp-extra but we will test
|
||||
# with some extra of SendGrid to see if it's work in the future
|
||||
self.message.esp_extra = {
|
||||
'ip_pool_name': "transactional",
|
||||
'asm': { # subscription management
|
||||
'group_id': 1,
|
||||
"ip_pool_name": "transactional",
|
||||
"asm": { # subscription management
|
||||
"group_id": 1,
|
||||
},
|
||||
'tracking_settings': {
|
||||
'subscription_tracking': {
|
||||
'enable': True,
|
||||
'substitution_tag': '[unsubscribe_url]',
|
||||
"tracking_settings": {
|
||||
"subscription_tracking": {
|
||||
"enable": True,
|
||||
"substitution_tag": "[unsubscribe_url]",
|
||||
},
|
||||
},
|
||||
}
|
||||
self.message.send()
|
||||
data = self.get_api_call_json()
|
||||
# merged from esp_extra:
|
||||
self.assertEqual(data['ip_pool_name'], "transactional")
|
||||
self.assertEqual(data['asm'], {'group_id': 1})
|
||||
self.assertEqual(data['tracking_settings']['subscription_tracking'],
|
||||
{'enable': True, 'substitution_tag': "[unsubscribe_url]"})
|
||||
self.assertEqual(data["ip_pool_name"], "transactional")
|
||||
self.assertEqual(data["asm"], {"group_id": 1})
|
||||
self.assertEqual(
|
||||
data["tracking_settings"]["subscription_tracking"],
|
||||
{"enable": True, "substitution_tag": "[unsubscribe_url]"},
|
||||
)
|
||||
|
||||
# noinspection PyUnresolvedReferences
|
||||
def test_send_attaches_anymail_status(self):
|
||||
""" The anymail_status should be attached to the message when it is sent """
|
||||
# the DEFAULT_RAW_RESPONSE above is the *only* success response SendinBlue returns,
|
||||
# so no need to override it here
|
||||
msg = mail.EmailMessage('Subject', 'Message', 'from@example.com', ['to1@example.com'], )
|
||||
"""The anymail_status should be attached to the message when it is sent"""
|
||||
# the DEFAULT_RAW_RESPONSE above is the *only* success response SendinBlue
|
||||
# returns, so no need to override it here
|
||||
msg = mail.EmailMessage(
|
||||
"Subject",
|
||||
"Message",
|
||||
"from@example.com",
|
||||
["to1@example.com"],
|
||||
)
|
||||
sent = msg.send()
|
||||
self.assertEqual(sent, 1)
|
||||
self.assertEqual(msg.anymail_status.status, {'queued'})
|
||||
self.assertEqual(msg.anymail_status.recipients['to1@example.com'].status, 'queued')
|
||||
self.assertEqual(msg.anymail_status.esp_response.content, self.DEFAULT_RAW_RESPONSE)
|
||||
self.assertEqual(msg.anymail_status.status, {"queued"})
|
||||
self.assertEqual(
|
||||
msg.anymail_status.recipients["to1@example.com"].status, "queued"
|
||||
)
|
||||
self.assertEqual(
|
||||
msg.anymail_status.esp_response.content, self.DEFAULT_RAW_RESPONSE
|
||||
)
|
||||
|
||||
self.assertEqual(
|
||||
msg.anymail_status.message_id,
|
||||
json.loads(msg.anymail_status.esp_response.content.decode('utf-8'))['messageId']
|
||||
json.loads(msg.anymail_status.esp_response.content.decode("utf-8"))[
|
||||
"messageId"
|
||||
],
|
||||
)
|
||||
self.assertEqual(
|
||||
msg.anymail_status.recipients['to1@example.com'].message_id,
|
||||
json.loads(msg.anymail_status.esp_response.content.decode('utf-8'))['messageId']
|
||||
msg.anymail_status.recipients["to1@example.com"].message_id,
|
||||
json.loads(msg.anymail_status.esp_response.content.decode("utf-8"))[
|
||||
"messageId"
|
||||
],
|
||||
)
|
||||
|
||||
# noinspection PyUnresolvedReferences
|
||||
def test_send_failed_anymail_status(self):
|
||||
""" If the send fails, anymail_status should contain initial values"""
|
||||
"""If the send fails, anymail_status should contain initial values"""
|
||||
self.set_mock_response(status_code=500)
|
||||
sent = self.message.send(fail_silently=True)
|
||||
self.assertEqual(sent, 0)
|
||||
@@ -455,18 +578,22 @@ class SendinBlueBackendAnymailFeatureTests(SendinBlueBackendMockAPITestCase):
|
||||
|
||||
def test_json_serialization_errors(self):
|
||||
"""Try to provide more information about non-json-serializable data"""
|
||||
self.message.esp_extra = {'total': Decimal('19.99')}
|
||||
self.message.esp_extra = {"total": Decimal("19.99")}
|
||||
with self.assertRaises(AnymailSerializationError) as cm:
|
||||
self.message.send()
|
||||
err = cm.exception
|
||||
self.assertIsInstance(err, TypeError) # compatibility with json.dumps
|
||||
self.assertIn("Don't know how to send this data to SendinBlue", str(err)) # our added context
|
||||
self.assertRegex(str(err), r"Decimal.*is not JSON serializable") # original message
|
||||
# our added context:
|
||||
self.assertIn("Don't know how to send this data to SendinBlue", str(err))
|
||||
# original message
|
||||
self.assertRegex(str(err), r"Decimal.*is not JSON serializable")
|
||||
|
||||
|
||||
@tag('sendinblue')
|
||||
@tag("sendinblue")
|
||||
class SendinBlueBackendRecipientsRefusedTests(SendinBlueBackendMockAPITestCase):
|
||||
"""Should raise AnymailRecipientsRefused when *all* recipients are rejected or invalid"""
|
||||
"""
|
||||
Should raise AnymailRecipientsRefused when *all* recipients are rejected or invalid
|
||||
"""
|
||||
|
||||
# SendinBlue doesn't check email bounce or complaint lists at time of send --
|
||||
# it always just queues the message. You'll need to listen for the "rejected"
|
||||
@@ -474,17 +601,22 @@ class SendinBlueBackendRecipientsRefusedTests(SendinBlueBackendMockAPITestCase):
|
||||
pass # not applicable to this backend
|
||||
|
||||
|
||||
@tag('sendinblue')
|
||||
class SendinBlueBackendSessionSharingTestCase(SessionSharingTestCases, SendinBlueBackendMockAPITestCase):
|
||||
@tag("sendinblue")
|
||||
class SendinBlueBackendSessionSharingTestCase(
|
||||
SessionSharingTestCases, SendinBlueBackendMockAPITestCase
|
||||
):
|
||||
"""Requests session sharing tests"""
|
||||
|
||||
pass # tests are defined in SessionSharingTestCases
|
||||
|
||||
|
||||
@tag('sendinblue')
|
||||
@tag("sendinblue")
|
||||
@override_settings(EMAIL_BACKEND="anymail.backends.sendinblue.EmailBackend")
|
||||
class SendinBlueBackendImproperlyConfiguredTests(AnymailTestMixin, SimpleTestCase):
|
||||
"""Test ESP backend without required settings in place"""
|
||||
|
||||
def test_missing_auth(self):
|
||||
with self.assertRaisesRegex(AnymailConfigurationError, r'\bSENDINBLUE_API_KEY\b'):
|
||||
mail.send_mail('Subject', 'Message', 'from@example.com', ['to@example.com'])
|
||||
with self.assertRaisesRegex(
|
||||
AnymailConfigurationError, r"\bSENDINBLUE_API_KEY\b"
|
||||
):
|
||||
mail.send_mail("Subject", "Message", "from@example.com", ["to@example.com"])
|
||||
|
||||
Reference in New Issue
Block a user