Metadata-Version: 2.4 Name: django-anymail Version: 13.0 Summary: Django email backends and webhooks for Amazon SES, Brevo, MailerSend, Mailgun, Mailjet, Mandrill, Postal, Postmark, Resend, SendGrid, SparkPost and Unisender Go (EmailBackend, transactional email tracking and inbound email signals) Project-URL: Homepage, https://github.com/anymail/django-anymail Project-URL: Documentation, https://anymail.dev/en/stable/ Project-URL: Source, https://github.com/anymail/django-anymail Project-URL: Changelog, https://anymail.dev/en/stable/changelog/ Project-URL: Tracker, https://github.com/anymail/django-anymail/issues Author: Anymail Contributors Author-email: Mike Edmunds License: BSD 3-Clause License Copyright (c) 2016-2024, Anymail Contributors Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. License-File: LICENSE Keywords: AWS SES,ActiveCampaign,Amazon SES,Bird,Brevo,Django,ESP,EmailBackend,MailChimp,MailerSend,Mailgun,Mailjet,Mandrill,Postal,Postmark,Resend,SendGrid,SendinBlue,Simple Email Service,Sinch,SparkPost,Twilio,Unisender Go,email,email backend,email service provider,email tracking,inbound email,transactional mail,webhook Classifier: Development Status :: 5 - Production/Stable Classifier: Environment :: Web Environment Classifier: Framework :: Django Classifier: Framework :: Django :: 4.0 Classifier: Framework :: Django :: 4.1 Classifier: Framework :: Django :: 4.2 Classifier: Framework :: Django :: 5.0 Classifier: Framework :: Django :: 5.1 Classifier: Framework :: Django :: 5.2 Classifier: Intended Audience :: Developers Classifier: License :: OSI Approved :: BSD License Classifier: Programming Language :: Python Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.8 Classifier: Programming Language :: Python :: 3.9 Classifier: Programming Language :: Python :: 3.10 Classifier: Programming Language :: Python :: 3.11 Classifier: Programming Language :: Python :: 3.12 Classifier: Programming Language :: Python :: 3.13 Classifier: Programming Language :: Python :: Implementation :: CPython Classifier: Programming Language :: Python :: Implementation :: PyPy Classifier: Topic :: Communications :: Email Classifier: Topic :: Software Development :: Libraries :: Python Modules Requires-Python: >=3.8 Requires-Dist: django>=4.0 Requires-Dist: requests>=2.4.3 Requires-Dist: urllib3>=1.25.0 Provides-Extra: amazon-ses Requires-Dist: boto3>=1.10.17; extra == 'amazon-ses' Provides-Extra: brevo Provides-Extra: mailersend Provides-Extra: mailgun Provides-Extra: mailjet Provides-Extra: mandrill Provides-Extra: postal Requires-Dist: cryptography; (python_version >= '3.9') and extra == 'postal' Provides-Extra: postmark Provides-Extra: resend Requires-Dist: svix; extra == 'resend' Provides-Extra: sendgrid Provides-Extra: sendinblue Provides-Extra: sparkpost Provides-Extra: unisender-go Description-Content-Type: text/x-rst Anymail: Django email integration for transactional ESPs ======================================================== .. 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 pyproject.toml readme; see also hatch_build.py which edits in the release version number) 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 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) * **Mandrill** (MailChimp transactional email) * **Postal** (self-hosted ESP) * **Postmark** (ActiveCampaign transactional email) * **Resend** * **SendGrid** (Twilio transactional email) * **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 * 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. .. END shared-intro .. image:: https://github.com/anymail/django-anymail/workflows/test/badge.svg?tag=v13.0 :target: https://github.com/anymail/django-anymail/actions?query=workflow:test+branch:v13.0 :alt: test status in GitHub Actions .. image:: https://github.com/anymail/django-anymail/workflows/integration-test/badge.svg?tag=v13.0 :target: https://github.com/anymail/django-anymail/actions?query=workflow:integration-test+branch:v13.0 :alt: integration test status in GitHub Actions .. image:: https://readthedocs.org/projects/anymail/badge/?version=v13.0 :target: https://anymail.dev/en/v13.0/ :alt: documentation build status on ReadTheDocs **Resources** * Full documentation: https://anymail.dev/en/v13.0/ * Help and troubleshooting: https://anymail.dev/en/v13.0/help/ * Package on PyPI: https://pypi.org/project/django-anymail/ * Project on Github: https://github.com/anymail/django-anymail * Changelog: https://anymail.dev/en/v13.0/changelog/ Anymail 1-2-3 ------------- .. _quickstart: .. This quickstart section is also included in docs/quickstart.rst Here's how to send a message. 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: .. 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.) 2. Edit your project's ``settings.py``: .. code-block:: python INSTALLED_APPS = [ # ... "anymail", # ... ] ANYMAIL = { # (exact settings here depend on your ESP...) "MAILGUN_API_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 SERVER_EMAIL = "your-server@example.com" # ditto (default from-email for Django errors) 3. 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 ", ["to@example.com"]) 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: https://example.com/activate", from_email="Example ", to=["New User ", "account.manager@example.com"], reply_to=["Helpdesk "]) # Include an inline image in the html: logo_cid = attach_inline_image_file(msg, "/path/to/logo.jpg") html = """Logo

Please activate your account

""".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() .. END quickstart See the `full documentation `_ for more features and options, including receiving messages and tracking sent message status.