Skip to main content

Anymail lets you send and receive email in Django using your choice of transactional email service providers (ESPs). It extends the standard django.core.mail with many common ESP-added features, providing a consistent API that avoids locking your code to one specific ESP (and making it easier to change ESPs later if needed).

Anymail currently supports these ESPs:

  • Amazon SES

  • Brevo (formerly SendinBlue)

  • MailerSend

  • Mailgun (Sinch transactional email)

  • Mailjet (Sinch transactional email)

  • Mailtrap

  • Mandrill (MailChimp transactional email)

  • Postal (self-hosted ESP)

  • Postmark (ActiveCampaign transactional email)

  • Resend

  • Scaleway TEM

  • SendGrid (Twilio transactional email; no longer tested)

  • SparkPost (Bird transactional email)

  • Unisender Go

Anymail includes:

  • Integration of each ESP’s sending APIs into Django’s built-in email package, including support for HTML, attachments, extra headers, and other standard email features

  • Extensions to expose common ESP-added functionality, like tags, metadata, and tracking, with code that’s portable between ESPs

  • Simplified inline images for HTML email

  • Full support for Unicode characters everywhere they’re allowed in email (with workarounds where possible for ESPs that don’t quite get it right)

  • Normalized sent-message status and tracking notification, by connecting your ESP’s webhooks to Django signals

  • “Batch transactional” sends using your ESP’s merge and template features

  • Inbound message support, to receive email through your ESP’s webhooks, with simplified, portable access to attachments and other inbound content

Anymail maintains compatibility with all Django versions that are in mainstream or extended support, plus (usually) a few older Django versions, and is extensively tested on all Python versions supported by Django. (Even-older Django versions may still be covered by an Anymail extended support release; consult the changelog for details.)

Anymail releases follow semantic versioning. The package is released under the BSD license.

test status in GitHub Actions integration test status in GitHub Actions documentation build status on ReadTheDocs

Resources

Anymail 1-2-3

Here’s how to send a message. This example uses Mailgun, but you can substitute Amazon SES or Mailjet or Postmark or SparkPost or any other supported ESP where you see “mailgun”:

  1. Install Anymail from PyPI:

    $ pip install "django-anymail[mailgun]"

    (The [mailgun] part installs any additional packages needed for that ESP. Mailgun doesn’t have any, but some other ESPs do.)

  2. Edit your project’s settings.py. In Django 6.1 or later:

    INSTALLED_APPS = [
        # ...
        "anymail",
        # ...
    ]
    
    MAILERS = {
        "default": {
            # Change "mailgun" to "amazon_ses" or "mailtrap" or another ESP
            "BACKEND": "anymail.backends.mailgun.EmailBackend",
            "OPTIONS": {
                # The exact options here depend on your ESP...
                "api_key": "<your Mailgun key>",
                "sender_domain": "mg.example.com",  # your Mailgun domain, if needed
            },
        },
    }
    DEFAULT_FROM_EMAIL = "you@example.com"  # if you don't already have this in settings
    SERVER_EMAIL = "your-server@example.com"  # ditto (default from-email for Django errors)

    In Django 6.0 or earlier, replace MAILERS with EMAIL_BACKEND and ANYMAIL:

    # Instead of MAILERS:
    EMAIL_BACKEND = "anymail.backends.mailgun.EmailBackend"
    ANYMAIL = {
        "MAILGUN_API_KEY": "<your Mailgun key>",
        "MAILGUN_SENDER_DOMAIN": 'mg.example.com',
    }
  3. Now the regular Django email functions will send through your chosen ESP:

    from django.core.mail import send_mail
    
    send_mail("It works!", "This will get sent through Mailgun",
              "Anymail Sender <from@example.com>", ["to@example.com"])

    You could send an HTML message, complete with an inline image, custom tags and metadata:

    from django.core.mail import EmailMultiAlternatives
    from anymail.message import attach_inline_image_file
    
    msg = EmailMultiAlternatives(
        subject="Please activate your account",
        body="Click to activate your account: https://example.com/activate",
        from_email="Example <admin@example.com>",
        to=["New User <user1@example.com>", "account.manager@example.com"],
        reply_to=["Helpdesk <support@example.com>"])
    
    # Include an inline image in the html:
    logo_cid = attach_inline_image_file(msg, "/path/to/logo.jpg")
    html = """<img alt="Logo" src="cid:{logo_cid}">
              <p>Please <a href="https://example.com/activate">activate</a>
              your account</p>""".format(logo_cid=logo_cid)
    msg.attach_alternative(html, "text/html")
    
    # Optional Anymail extensions:
    msg.metadata = {"user_id": "8675309", "experiment_variation": 1}
    msg.tags = ["activation", "onboarding"]
    msg.track_clicks = True
    
    # Send it:
    msg.send()

See the full documentation for more features and options, including receiving messages and tracking sent message status.

Thanks

Anymail wouldn’t exist without the work of many code contributors and countless others who have taken time to track down bugs, report issues and participate in discussions. Thank you!

Special thanks to Anymail’s sponsors for their financial support.

Anymail is an independent project not affiliated with any email service provider. Sponsorship is not meant to imply endorsement.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_anymail-15.1.tar.gz (107.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_anymail-15.1-py3-none-any.whl (147.4 kB view details)

Uploaded Python 3

File details

Details for the file django_anymail-15.1.tar.gz.

File metadata

  • Download URL: django_anymail-15.1.tar.gz
  • Upload date:
  • Size: 107.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for django_anymail-15.1.tar.gz
Algorithm Hash digest
SHA256 299fb12a21ac4101e9706c2ade461d18deacbb6bc3750cfa6ca08aeea1fc9442
MD5 694e7f6ea64c0f4cb37321b61e83b9af
BLAKE2b-256 f969c4e075a39e69efc928ad63e2cad9b720c6414d9faf9b90d2342207a8feb8

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_anymail-15.1.tar.gz:

Publisher: release.yml on anymail/django-anymail

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file django_anymail-15.1-py3-none-any.whl.

File metadata

  • Download URL: django_anymail-15.1-py3-none-any.whl
  • Upload date:
  • Size: 147.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for django_anymail-15.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cb482b0e2b0aea665c83d49e3f13bb0673210aa0de285b1748a3b5e6277fc826
MD5 da049d9cce4bdebbfd033a5418e0fa97
BLAKE2b-256 a2bb3fbac63312c87620986ac00c7b27d11ef1a7c07ffb5718ca5bd5c60e2f5f

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_anymail-15.1-py3-none-any.whl:

Publisher: release.yml on anymail/django-anymail

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

15.2

2 files

This release

15.1 This release

2 files

15.0

2 files

14.0

2 files

13.1

2 files

13.0.1

2 files

13.0

2 files

12.0

2 files

11.1

2 files

11.0.1

2 files

11.0

2 files

10.3

2 files

10.2

2 files

10.1

2 files

10.0

2 files

9.2

2 files

9.1

2 files

9.0

2 files

8.6

2 files

8.5

2 files

8.4

2 files

8.3

2 files

8.2

2 files

8.1

2 files

8.0

2 files

7.2.1

2 files

7.2

2 files

7.1.0

2 files

7.0.0

2 files

6.1.0

2 files

6.0.1

2 files

6.0

2 files

5.0

2 files

4.3

2 files

4.2

2 files

4.1

2 files

4.0

2 files

3.0

2 files

2.2

2 files

2.1

2 files

2.0

2 files

1.4

1 file

1.3

1 file

1.2.1

1 file

1.2

1 file

1.1

1 file

1.0

1 file

0.11.1

1 file

0.11

1 file

0.10

1 file

0.9

1 file

0.8

1 file

0.7

1 file

0.6.1

1 file

0.6

1 file

0.5

1 file

0.4.2

1 file

0.4.1

1 file

0.3.1

1 file

0.3

1 file

0.2

1 file

0.1

1 file

0.1.dev0

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page