This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Django email backends for Mailgun, Mailjet, Postmark, SendGrid, SparkPost and other transactional ESPs

Project Description

PRE-1.0

Although several projects are using this package in production, the API and feature set are still evolving, and the package has not yet reached 1.0 status. Before 1.0, minor version bumps might include breaking changes (following semantic versioning rules). Please check the release notes

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, Mailjet, 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

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

Resources

Anymail 1-2-3

This example uses Mailgun, but you can substitute Mailjet or Postmark or SendGrid 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:

    INSTALLED_APPS = [
        # ...
        "anymail",
        # ...
    ]
    
    ANYMAIL = {
        # (exact settings here depend on your ESP...)
        "MAILGUN_API_KEY": "<your Mailgun key>",
        "MAILGUN_SENDER_DOMAIN": 'mg.example.com',  # your Mailgun domain, if needed
    }
    EMAIL_BACKEND = "anymail.backends.mailgun.EmailBackend"  # or sendgrid.EmailBackend, or...
    DEFAULT_FROM_EMAIL = "you@example.com"  # if you don't already have this in settings
    
  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: http://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="http://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.

Release History

Release History

This version
History Node

0.11.1

History Node

0.11

History Node

0.10

History Node

0.9

History Node

0.8

History Node

0.7

History Node

0.6.1

History Node

0.6

History Node

0.5

History Node

0.4.2

History Node

0.4.1

History Node

0.3.1

History Node

0.3

History Node

0.2

History Node

0.1

History Node

0.1.dev2

History Node

0.1.dev1

History Node

0.1.dev0

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
django-anymail-0.11.1.tar.gz (46.5 kB) Copy SHA256 Checksum SHA256 Source Jul 24, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting