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:
Anymail includes:
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.
Resources
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":
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.)
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 amazon_ses.EmailBackend, or... 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)
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.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4