django-anymail 0 editorconfig travis-ci python

Django email backends and webhooks for Mailgun, Postmark, SendGrid, SparkPost and more

Anymail: Django email backends for Mailgun, Postmark, SendGrid, SparkPost and more


This project is undergoing rapid development to get to a 1.0 release. Before 1.0, minor version bumps might include breaking changes. Please check the release notes <>_

.. This README is reused in multiple places: * Github: project page, exactly as it appears here * Docs: shared-intro section gets included in docs/index.rst quickstart section gets included in docs/quickstart.rst * PyPI: project page (via long_description), with several edits to freeze it to the specific PyPI release (see long_description_from_readme in You can use docutils 1.0 markup, but not any Sphinx additions. GitHub rst supports code-block, but no other block directives.

.. default-role:: literal

.. _shared-intro:

.. This shared-intro section is also included in docs/index.rst

Anymail integrates several transactional email service providers (ESPs) into Django, with a consistent API that lets you use ESP-added features without locking your code to a particular ESP.

It currently fully supports Mailgun, Postmark, SendGrid, and SparkPost, and has limited support for Mandrill.

Anymail normalizes ESP functionality so it “just works” with Django’s built-in django.core.mail package. It includes:

  • Support for HTML, attachments, extra headers, and other features of Django's built-in email <>_
  • Extensions that make it easy to use extra ESP functionality, like tags, metadata, and tracking, with code that’s portable between ESPs
  • Simplified inline images for HTML email
  • 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

Support is also planned for:

  • Normalized inbound email processing through your ESP

Anymail is released under the BSD license. It is extensively tested against Django 1.8–1.10 (including Python 2.7, Python 3 and PyPy). Anymail releases follow semantic versioning <>_.

.. END shared-intro

.. image:: :target: :alt: build status on Travis-CI

.. image:: :target: :alt: documentation on ReadTheDocs


Anymail 1-2-3

.. _quickstart:

.. This quickstart section is also included in docs/quickstart.rst

This example uses Mailgun, but you can substitute Postmark or SendGrid or SparkPost or any other supported ESP where you see “mailgun”:

  1. Install Anymail from PyPI:

.. code-block:: console

    $ 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.)

  1. Edit your project’s

.. code-block:: python


    ANYMAIL = {
        # (exact settings here depend on your ESP...)
        "MAILGUN_API_KEY": "<your Mailgun key>",
        "MAILGUN_SENDER_DOMAIN": '',  # your Mailgun domain, if needed
    EMAIL_BACKEND = "anymail.backends.mailgun.MailgunBackend"  # or sendgrid.SendGridBackend, or...
    DEFAULT_FROM_EMAIL = "[email protected]"  # if you don't already have this in settings
  1. Now the regular Django email functions <>_ will send through your chosen ESP:

.. code-block:: python

    from django.core.mail import send_mail

    send_mail("It works!", "This will get sent through Mailgun",
              "Anymail Sender <[email protected]>", ["[email protected]"])

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

.. code-block:: python

    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:",
        from_email="Example <[email protected]>",
        to=["New User <[email protected]>", "[email protected]"],
        reply_to=["Helpdesk <[email protected]>"])

    # 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="">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:

.. END quickstart

See the full documentation <>_ for more features and options.

Related Repositories



Django email backends and webhooks for Mailgun, Postmark, SendGrid, SparkPost and more ...



This project is deprecated in favor of ...

Top Contributors

medmunds kennethlove chrisjones-brack3t jpadilla ArnaudF ulmus winhamwr omerzimp Wrhector nikolay-saskovets kylegibson jarcoal crccheck adamchainz freider erichennings luzfcb jayfk lewistaylor linuss michaelshobbs pkimber pdr rebelliard zsiciarz peillis


-   v0.5 zip tar
-   v0.4.2 zip tar
-   v0.4.1 zip tar
-   v0.4 zip tar
-   v0.3.1 zip tar
-   v0.3 zip tar
-   v0.2 zip tar
-   v0.1 zip tar
-   v0.1.dev2 zip tar
-   v0.1.dev1 zip tar