django-anymail 0.1.dev2

Multi-ESP transactional email for Django

EARLY DEVELOPMENT

This project is undergoing rapid development to get to a 1.0 release. You should expect frequent, possibly-breaking changes until 1.0 alpha.

Anymail integrates several transactional email service providers (ESPs) into Django, using a consistent API that makes it (relatively) easy to switch between ESPs.

It currently supports Mailgun and Mandrill. Postmark and SendGrid are coming soon.

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, using code that’s portable between ESPs

• Optional support for ESP delivery status notification via webhooks and Django signals

• Optional support for inbound email

Anymail is released under the BSD license. It is tested against Django 1.8–1.9 (including Python 3 and PyPy). Anymail uses semantic versioning.

Resources

• Full documentation: https://anymail.readthedocs.org/en/latest/

• Package on PyPI: https://pypi.python.org/pypi/django-anymail

• Project on Github: https://github.com/anymail/django-anymail

Anymail 1-2-3

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

1. Install Anymail from PyPI, including the ESP(s) you want to use:

   $ pip install django-anymail[mailgun]  # or [postmark,sendgrid] or ...

2. Edit your project’s settings.py:

   INSTALLED_APPS = (
       ...
       "anymail"
   )
   
   ANYMAIL = {
       "MAILGUN_API_KEY": "<your Mailgun key>",
   }
   EMAIL_BACKEND = "anymail.backends.mailgun.MailgunBackend"  # or sendgrid.SendGridBackend, or...
   DEFAULT_FROM_EMAIL = "[e-mail]"  # 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 <[e-mail]>", ["[e-mail]"])

   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 <[e-mail]>",
       to=["New User <[e-mail]>", "[e-mail]"],
       reply_to=["Helpdesk <[e-mail]>"])
   
   # 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.