import json from base64 import b64decode, b64encode from datetime import date, datetime, timezone from decimal import Decimal from email.mime.base import MIMEBase 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 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_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"}, ) 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) ) def setUp(self): super().setUp() # Simple message useful for many tests self.message = mail.EmailMultiAlternatives( "Subject", "Text Body", "from@example.com", ["to@example.com"] ) @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") 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"}]) def test_name_addr(self): """Make sure RFC2822 name-addr format (with display-name) is allowed (Test both sender and recipient addresses) """ msg = mail.EmailMessage( "Subject", "Message", "From Name ", ["Recipient #1 ", "to2@example.com"], cc=["Carbon Copy ", "cc2@example.com"], bcc=["Blind Copy ", "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"}, ], ) def test_email_message(self): email = mail.EmailMessage( "Subject", "Body goes here", "from@example.com", ["to1@example.com", "Also To "], bcc=["bcc1@example.com", "Also BCC "], cc=["cc1@example.com", "Also CC "], headers={ "Reply-To": "another@example.com", "X-MyHeader": "my value", # should override backend msgid: "Message-ID": "", }, ) 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": "", }, ) def test_html_message(self): text_content = "This is an important message." html_content = "

This is an important message.

" 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) # Don't accidentally send the html part as an attachment: self.assertNotIn("attachments", data) def test_html_only_message(self): html_content = "

This is an important message.

" 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) def test_extra_headers(self): self.message.extra_headers = { "X-Custom": "string", "X-Num": 123, "Reply-To": '"Do Not Reply" ', } self.message.send() data = self.get_api_call_json() self.assertEqual(data["headers"]["X-Custom"], "string") # Header values must be strings (changed 11/2022) 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"} ) def test_extra_headers_serialization_error(self): self.message.extra_headers = {"X-Custom": Decimal(12.5)} with self.assertRaisesMessage(AnymailSerializationError, "Decimal"): self.message.send() def test_reply_to(self): self.message.reply_to = ['"Reply recipient" \u2019

", 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"), "

\u2019

" ) def test_embedded_images(self): # SendinBlue doesn't support inline image # inline image are just added as a content attachment image_filename = SAMPLE_IMAGE_FILENAME image_path = sample_image_path(image_filename) cid = attach_inline_image_file(self.message, image_path) # Read from a png file html_content = ( '

This has an inline image.

' % cid ) self.message.attach_alternative(html_content, "text/html") with self.assertRaises(AnymailUnsupportedFeature): self.message.send() def test_attached_images(self): image_filename = SAMPLE_IMAGE_FILENAME image_path = sample_image_path(image_filename) image_data = sample_image_content(image_filename) # option 1: attach as a file self.message.attach_file(image_path) # 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") 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, }, ) def test_multiple_html_alternatives(self): self.message.body = "Text body" self.message.attach_alternative("

First html is OK

", "text/html") self.message.attach_alternative( "

And maybe second html, too

", "text/html" ) with self.assertRaises(AnymailUnsupportedFeature): self.message.send() def test_non_html_alternative(self): self.message.body = "Text body" self.message.attach_alternative("{'maybe': 'allowed'}", "application/json") with self.assertRaises(AnymailUnsupportedFeature): self.message.send() 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"]) # 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, ) self.assertEqual(sent, 0) def test_api_error_includes_details(self): """AnymailAPIError should include ESP's error message""" # JSON error response: error_response = b"""{ "code": "invalid_parameter", "message": "valid sender email required" }""" self.set_mock_response(status_code=400, raw=error_response) with self.assertRaises(AnymailAPIError) as cm: self.message.send() err = cm.exception self.assertIn("code", str(err)) self.assertIn("message", str(err)) # No content in the error response: self.set_mock_response(status_code=502, raw=None) with self.assertRaises(AnymailAPIError): self.message.send() @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"): self.message.send() def test_metadata(self): 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) def test_send_at(self): utc_plus_6 = get_fixed_timezone(6 * 60) utc_minus_8 = get_fixed_timezone(-8 * 60) 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() data = self.get_api_call_json() 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") # 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") # 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") # 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") # 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") def test_tag(self): self.message.tags = ["receipt", "multiple"] self.message.send() data = self.get_api_call_json() self.assertEqual(data["tags"], ["receipt", "multiple"]) def test_tracking(self): # Test one way... self.message.track_clicks = False self.message.track_opens = True with self.assertRaises(AnymailUnsupportedFeature): self.message.send() # ...and the opposite way self.message.track_clicks = True self.message.track_opens = False with self.assertRaises(AnymailUnsupportedFeature): self.message.send() def test_template_id(self): # subject, body, and from_email must be None for SendinBlue template send: message = mail.EmailMessage( subject="My Subject", body=None, from_email="from@example.com", # single 'to' recommended (all 'to' get the same message) to=["Recipient "], cc=["Recipient ", "Recipient "], bcc=["Recipient "], reply_to=["Recipient "], ) # 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"}]) 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 } with self.assertRaises(AnymailUnsupportedFeature): self.message.send() def test_merge_global_data(self): self.message.merge_global_data = {"a": "b"} self.message.send() data = self.get_api_call_json() self.assertEqual(data["params"], {"a": "b"}) def test_default_omits_options(self): """Make sure by default we don't send any ESP-specific options. Options not specified by the caller should be omitted entirely from the API call (*not* sent as False or empty). This ensures that your ESP account settings apply by default. """ 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) 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, }, "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]"}, ) # 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"], ) 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.message_id, 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" ], ) # noinspection PyUnresolvedReferences def test_send_failed_anymail_status(self): """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) self.assertIsNone(self.message.anymail_status.status) self.assertEqual(self.message.anymail_status.recipients, {}) self.assertIsNone(self.message.anymail_status.esp_response) def test_json_serialization_errors(self): """Try to provide more information about non-json-serializable data""" 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 # 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") class SendinBlueBackendRecipientsRefusedTests(SendinBlueBackendMockAPITestCase): """ 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" # and "failed" events to detect refused recipients. pass # not applicable to this backend @tag("sendinblue") class SendinBlueBackendSessionSharingTestCase( SessionSharingTestCases, SendinBlueBackendMockAPITestCase ): """Requests session sharing tests""" pass # tests are defined in SessionSharingTestCases @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"])