mirror of
https://github.com/pacnpal/django-anymail.git
synced 2025-12-20 11:51:05 -05:00
e3f986df8f
And add some tests for template unsupported feature warnings, recipients in non-template sends.
216 lines
7.6 KiB
Python
216 lines
7.6 KiB
Python
from requests.structures import CaseInsensitiveDict
|
|
|
|
from .base_requests import AnymailRequestsBackend, RequestsPayload
|
|
from ..exceptions import AnymailRequestsAPIError
|
|
from ..message import AnymailRecipientStatus
|
|
from ..utils import get_anymail_setting
|
|
|
|
|
|
class EmailBackend(AnymailRequestsBackend):
|
|
"""
|
|
SendinBlue v3 API Email Backend
|
|
"""
|
|
|
|
esp_name = "SendinBlue"
|
|
|
|
def __init__(self, **kwargs):
|
|
"""Init options from Django settings"""
|
|
esp_name = self.esp_name
|
|
self.api_key = get_anymail_setting(
|
|
'api_key',
|
|
esp_name=esp_name,
|
|
kwargs=kwargs,
|
|
allow_bare=True,
|
|
)
|
|
api_url = get_anymail_setting(
|
|
'api_url',
|
|
esp_name=esp_name,
|
|
kwargs=kwargs,
|
|
default="https://api.sendinblue.com/v3/",
|
|
)
|
|
if not api_url.endswith("/"):
|
|
api_url += "/"
|
|
super(EmailBackend, self).__init__(api_url, **kwargs)
|
|
|
|
def build_message_payload(self, message, defaults):
|
|
return SendinBluePayload(message, defaults, self)
|
|
|
|
def raise_for_status(self, response, payload, message):
|
|
if response.status_code < 200 or response.status_code >= 300:
|
|
raise AnymailRequestsAPIError(
|
|
email_message=message,
|
|
payload=payload,
|
|
response=response,
|
|
backend=self,
|
|
)
|
|
|
|
def parse_recipient_status(self, response, payload, message):
|
|
# SendinBlue doesn't give any detail on a success
|
|
# https://developers.sendinblue.com/docs/responses
|
|
message_id = None
|
|
|
|
if response.content != b'':
|
|
parsed_response = self.deserialize_json_response(response, payload, message)
|
|
try:
|
|
message_id = parsed_response['messageId']
|
|
except (KeyError, TypeError):
|
|
raise AnymailRequestsAPIError("Invalid SendinBlue API response format",
|
|
email_message=message, payload=payload, response=response,
|
|
backend=self)
|
|
|
|
status = AnymailRecipientStatus(message_id=message_id, status="queued")
|
|
return {recipient.addr_spec: status for recipient in payload.all_recipients}
|
|
|
|
|
|
class SendinBluePayload(RequestsPayload):
|
|
|
|
def __init__(self, message, defaults, backend, *args, **kwargs):
|
|
self.all_recipients = [] # used for backend.parse_recipient_status
|
|
self.template_id = None
|
|
|
|
http_headers = kwargs.pop('headers', {})
|
|
http_headers['api-key'] = backend.api_key
|
|
http_headers['Content-Type'] = 'application/json'
|
|
|
|
super(SendinBluePayload, self).__init__(message, defaults, backend, headers=http_headers, *args, **kwargs)
|
|
|
|
def get_api_endpoint(self):
|
|
if self.template_id:
|
|
return "smtp/templates/%s/send" % self.template_id
|
|
else:
|
|
return "smtp/email"
|
|
|
|
def init_payload(self):
|
|
self.data = { # becomes json
|
|
'headers': CaseInsensitiveDict()
|
|
}
|
|
|
|
def serialize_data(self):
|
|
"""Performs any necessary serialization on self.data, and returns the result."""
|
|
|
|
if not self.data['headers']:
|
|
del self.data['headers'] # don't send empty headers
|
|
|
|
# SendinBlue use different argument's name if we use template functionality
|
|
if self.template_id:
|
|
data = self._transform_data_for_templated_email(self.data)
|
|
else:
|
|
data = self.data
|
|
|
|
return self.serialize_json(data)
|
|
|
|
def _transform_data_for_templated_email(self, data):
|
|
"""
|
|
Transform the default Payload's data (used for basic transactional email) to
|
|
the data used by SendinBlue in case of a templated transactional email.
|
|
:param data: The data we want to transform
|
|
:return: The transformed data
|
|
"""
|
|
if data.pop('subject', False):
|
|
self.unsupported_feature("overriding template subject")
|
|
if data.pop('sender', False):
|
|
self.unsupported_feature("overriding template from_email")
|
|
if data.pop('textContent', False) or data.pop('htmlContent', False):
|
|
self.unsupported_feature("overriding template body content")
|
|
|
|
transformation = {
|
|
'to': 'emailTo',
|
|
'cc': 'emailCc',
|
|
'bcc': 'emailBcc',
|
|
}
|
|
for key, new_key in transformation.items():
|
|
if key in data:
|
|
if any(email.get('name') for email in data[key]):
|
|
self.unsupported_feature("display names in %s when sending with a template" % key)
|
|
data[new_key] = [email['email'] for email in data[key]]
|
|
del data[key]
|
|
|
|
if 'replyTo' in data:
|
|
if data['replyTo'].get('name'):
|
|
self.unsupported_feature("display names in reply_to when sending with a template")
|
|
data['replyTo'] = data['replyTo']['email']
|
|
|
|
return data
|
|
|
|
#
|
|
# Payload construction
|
|
#
|
|
|
|
@staticmethod
|
|
def email_object(email):
|
|
"""Converts EmailAddress to SendinBlue API array"""
|
|
email_object = dict()
|
|
email_object['email'] = email.addr_spec
|
|
if email.display_name:
|
|
email_object['name'] = email.display_name
|
|
return email_object
|
|
|
|
def set_from_email(self, email):
|
|
self.data["sender"] = self.email_object(email)
|
|
|
|
def set_recipients(self, recipient_type, emails):
|
|
assert recipient_type in ["to", "cc", "bcc"]
|
|
if emails:
|
|
self.data[recipient_type] = [self.email_object(email) for email in emails]
|
|
self.all_recipients += emails # used for backend.parse_recipient_status
|
|
|
|
def set_subject(self, subject):
|
|
if subject != "": # see note in set_text_body about template rendering
|
|
self.data["subject"] = subject
|
|
|
|
def set_reply_to(self, emails):
|
|
# SendinBlue only supports a single address in the reply_to API param.
|
|
if len(emails) > 1:
|
|
self.unsupported_feature("multiple reply_to addresses")
|
|
if len(emails) > 0:
|
|
self.data['replyTo'] = self.email_object(emails[0])
|
|
|
|
def set_extra_headers(self, headers):
|
|
self.data['headers'].update(headers)
|
|
|
|
def set_tags(self, tags):
|
|
if len(tags) > 0:
|
|
self.data['headers']["X-Mailin-tag"] = tags[0]
|
|
if len(tags) > 1:
|
|
self.unsupported_feature('multiple tags (%r)' % tags)
|
|
|
|
def set_template_id(self, template_id):
|
|
self.template_id = template_id
|
|
|
|
def set_text_body(self, body):
|
|
if body:
|
|
self.data['textContent'] = body
|
|
|
|
def set_html_body(self, body):
|
|
if body:
|
|
if "htmlContent" in self.data:
|
|
self.unsupported_feature("multiple html parts")
|
|
|
|
self.data['htmlContent'] = body
|
|
|
|
def add_attachment(self, attachment):
|
|
"""Converts attachments to SendinBlue API {name, base64} array"""
|
|
att = {
|
|
'name': attachment.name or '',
|
|
'content': attachment.b64content,
|
|
}
|
|
|
|
if attachment.inline:
|
|
self.unsupported_feature("inline attachments")
|
|
|
|
self.data.setdefault("attachment", []).append(att)
|
|
|
|
def set_esp_extra(self, extra):
|
|
self.data.update(extra)
|
|
|
|
def set_merge_data(self, merge_data):
|
|
"""SendinBlue doesn't support special attributes for each recipient"""
|
|
self.unsupported_feature("merge_data")
|
|
|
|
def set_merge_global_data(self, merge_global_data):
|
|
self.data['attributes'] = merge_global_data
|
|
|
|
def set_metadata(self, metadata):
|
|
# SendinBlue expects a single string payload
|
|
self.data['headers']["X-Mailin-custom"] = self.serialize_json(metadata)
|