Environment Variables

The library automatically detects the following environment variables (or Django settings). Copy example.env to .env to get started:

MAIL_AWS_REGION_NAME=eu-west-1
MAIL_AWS_ACCESS_KEY_ID=ABC123
MAIL_AWS_SECRET_ACCESS_KEY=S3cr3t

MAIL_AWS_SNS_TOPIC_ARN=arn:aws:sns:eu-west-1:123:abc
MAIL_AWS_SNS_VERIFY_NOTIFICATION=true
MAIL_AWS_SNS_VERIFY_CERTIFICATE=true

If you wish to have Boto3 search for credentials (as explained in Boto3’s Credentials documentation <https://docs.aws.amazon.com/boto3/latest/guide/credentials.html#configuring-credentials>), you can omit MAIL_AWS_ACCESS_KEY_ID and MAIL_AWS_SECRET_ACCESS_KEY:

MAIL_AWS_REGION_NAME=eu-west-1

MAIL_AWS_SNS_TOPIC_ARN=arn:aws:sns:eu-west-1:123:abc
MAIL_AWS_SNS_VERIFY_NOTIFICATION=true
MAIL_AWS_SNS_VERIFY_CERTIFICATE=true

Create your AWS ACCESS KEYS by logging in to the AWS Console. Then click your account name at the top right corner and select “Security credentials”. Then, in the left sidebar menu, below “Access Management”, select “Users” and click the button “Create user”. Afterwards, chose to create an access key.

Backend Signals

These fire during the .send() process within your application:

• mail_pre_send: Fired before the message is sent to AWS.

• mail_post_send: Fired after a successful API response from AWS.

SNS Webhook Signals

These are triggered by AWS SNS notifications via the provided webhook views. For more information on the contents of these notifications, see the AWS SES documentation.

• mail_send: The email was successfully sent by SES.

• mail_delivery: The email was successfully delivered to the recipient.

• mail_bounce: The email bounced (Hard or Soft).

• mail_complaint: The recipient marked the email as spam.

• mail_reject: SES rejected the email (e.g., due to virus or blacklisting).

• mail_delivery_delay: There is a delay in delivering the email.

• mail_open: The recipient opened the email (requires SES tracking).

• mail_click: The recipient clicked a link (requires SES tracking).

Signal Example:

from django.dispatch import receiver
from django_aws_mail.signals import mail_bounce

@receiver(mail_bounce)
def handle_bounce(sender, mail, event, message, **kwargs):
    # Retrieve info from the event dictionary
    bounce_type = event.get('bounceType')
    message_id = mail.get('messageId')

    print(f"Email {message_id} bounced. Type: {bounce_type}")