mirror of
https://github.com/pacnpal/django-anymail.git
synced 2025-12-20 03:41:05 -05:00
75730e8219
* message.template_id to use ESP stored templates * message.merge_data and merge_global_data to supply per-recipient/global merge variables (with or without an ESP stored template) * When using per-recipient merge_data, tell ESP to use batch send: individual message per "to" address. (Mailgun does this automatically; SendGrid requires using a different "to" field; Mandrill requires `preserve_recipients=False`; Postmark doesn't support *this type* of batch sending with merge data.) * Allow message.from_email=None (must be set after init) and message.subject=None to suppress those fields in API calls (for ESPs that allow "From" and "Subject" in their template definitions). Mailgun: * Emulate merge_global_data by copying to recipient-variables for each recipient. SendGrid: * Add delimiters to merge field names via esp_extra['merge_field_format'] or ANYMAIL_SENDGRID_MERGE_FIELD_FORMAT setting. Mandrill: * Remove Djrill versions of these features; update migration notes. Closes #5.
74 lines
3.1 KiB
ReStructuredText
74 lines
3.1 KiB
ReStructuredText
.. _supported-esps:
|
|
|
|
Supported ESPs
|
|
==============
|
|
|
|
Anymail currently supports these Email Service Providers.
|
|
Click an ESP's name for specific Anymail settings required,
|
|
and notes about any quirks or limitations:
|
|
|
|
.. these are listed in alphabetical order
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
mailgun
|
|
mandrill
|
|
postmark
|
|
sendgrid
|
|
|
|
|
|
Anymail feature support
|
|
-----------------------
|
|
|
|
The table below summarizes the Anymail features supported for each ESP.
|
|
|
|
.. currentmodule:: anymail.message
|
|
|
|
============================================ ========== ========== ========== ==========
|
|
Email Service Provider |Mailgun| |Mandrill| |Postmark| |SendGrid|
|
|
============================================ ========== ========== ========== ==========
|
|
.. rubric:: :ref:`Anymail send options <anymail-send-options>`
|
|
--------------------------------------------------------------------------------------------
|
|
:attr:`~AnymailMessage.metadata` Yes Yes No Yes
|
|
:attr:`~AnymailMessage.send_at` Yes Yes No Yes
|
|
:attr:`~AnymailMessage.tags` Yes Yes Max 1 tag Yes
|
|
:attr:`~AnymailMessage.track_clicks` Yes Yes No Yes
|
|
:attr:`~AnymailMessage.track_opens` Yes Yes Yes Yes
|
|
|
|
.. rubric:: :ref:`templates-and-merge`
|
|
--------------------------------------------------------------------------------------------
|
|
:attr:`~AnymailMessage.template_id` No Yes Yes Yes
|
|
:attr:`~AnymailMessage.merge_data` Yes Yes No Yes
|
|
:attr:`~AnymailMessage.merge_global_data` (emulated) Yes Yes Yes
|
|
|
|
.. rubric:: :ref:`Status <esp-send-status>` and :ref:`event tracking <event-tracking>`
|
|
--------------------------------------------------------------------------------------------
|
|
:attr:`~AnymailMessage.anymail_status` Yes Yes Yes Yes
|
|
|AnymailTrackingEvent| from webhooks Yes Yes Yes Yes
|
|
============================================ ========== ========== ========== ==========
|
|
|
|
|
|
.. .. rubric:: :ref:`inbound`
|
|
.. -------------------------------------------------------------------------------------------
|
|
.. Inbound webhooks (coming)...
|
|
|
|
Trying to choose an ESP? Please **don't** start with this table. It's far more
|
|
important to consider things like an ESP's deliverability stats, latency, uptime,
|
|
and support for developers. The *number* of extra features an ESP offers is almost
|
|
meaningless. (And even specific features don't matter if you don't plan to use them.)
|
|
|
|
.. |Mailgun| replace:: :ref:`mailgun-backend`
|
|
.. |Mandrill| replace:: :ref:`mandrill-backend`
|
|
.. |Postmark| replace:: :ref:`postmark-backend`
|
|
.. |SendGrid| replace:: :ref:`sendgrid-backend`
|
|
.. |AnymailTrackingEvent| replace:: :class:`~anymail.signals.AnymailTrackingEvent`
|
|
|
|
|
|
Other ESPs
|
|
----------
|
|
|
|
Don't see your favorite ESP here? Anymail is designed to be extensible.
|
|
You can suggest that Anymail add an ESP, or even contribute
|
|
your own implementation to Anymail. See :ref:`contributing`.
|