def send_email( # pylint: disable=too-many-arguments
self,
mail_from: str,
to: Union[str, Iterable[str]],
subject: str,
html_content: str,
files: Optional[List[str]] = None,
cc: Optional[Union[str, Iterable[str]]] = None,
bcc: Optional[Union[str, Iterable[str]]] = None,
mime_subtype: str = 'mixed',
mime_charset: str = 'utf-8',
reply_to: Optional[str] = None,
return_path: Optional[str] = None,
custom_headers: Optional[Dict[str, Any]] = None,
) -> dict:
"""
Send email using Amazon Simple Email Service
:param mail_from: Email address to set as email's from
:param to: List of email addresses to set as email's to
:param subject: Email's subject
:param html_content: Content of email in HTML format
:param files: List of paths of files to be attached
:param cc: List of email addresses to set as email's CC
:param bcc: List of email addresses to set as email's BCC
:param mime_subtype: Can be used to specify the sub-type of the message. Default = mixed
:param mime_charset: Email's charset. Default = UTF-8.
:param return_path: The email address to which replies will be sent. By default, replies
are sent to the original sender's email address.
:param reply_to: The email address to which message bounces and complaints should be sent.
"Return-Path" is sometimes called "envelope from," "envelope sender," or "MAIL FROM."
:param custom_headers: Additional headers to add to the MIME message.
No validations are run on these values and they should be able to be encoded.
:return: Response from Amazon SES service with unique message identifier.
"""
ses_client = self.get_conn()
custom_headers = custom_headers or {}
if reply_to:
custom_headers['Reply-To'] = reply_to
if return_path:
custom_headers['Return-Path'] = return_path
message, recipients = build_mime_message(
mail_from=mail_from,
to=to,
subject=subject,
html_content=html_content,
files=files,
cc=cc,
bcc=bcc,
mime_subtype=mime_subtype,
mime_charset=mime_charset,
custom_headers=custom_headers,
)
return ses_client.send_raw_email(
Source=mail_from,
Destinations=recipients,
RawMessage={'Data': message.as_string()})
def test_build_mime_message(self):
mail_from = '*****@*****.**'
mail_to = '*****@*****.**'
subject = 'test subject'
html_content = '<html>Test</html>'
custom_headers = {'Reply-To': '*****@*****.**'}
msg, recipients = build_mime_message(
mail_from=mail_from,
to=mail_to,
subject=subject,
html_content=html_content,
custom_headers=custom_headers,
)
assert 'From' in msg
assert 'To' in msg
assert 'Subject' in msg
assert 'Reply-To' in msg
assert [mail_to] == recipients
assert msg['To'] == ','.join(recipients)
def test_build_mime_message(self):
mail_from = '*****@*****.**'
mail_to = '*****@*****.**'
subject = 'test subject'
html_content = '<html>Test</html>'
custom_headers = {'Reply-To': '*****@*****.**'}
msg, recipients = build_mime_message(
mail_from=mail_from,
to=mail_to,
subject=subject,
html_content=html_content,
custom_headers=custom_headers,
)
self.assertIn('From', msg)
self.assertIn('To', msg)
self.assertIn('Subject', msg)
self.assertIn('Reply-To', msg)
self.assertListEqual([mail_to], recipients)
self.assertEqual(msg['To'], ','.join(recipients))