mirror of
https://github.com/pacnpal/django-anymail.git
synced 2025-12-20 11:51:05 -05:00
75d7671056
Support merge_metadata in Mailgun, Mailjet, Mandrill, Postmark, SparkPost, and Test backends. (SendGrid covered in earlier PR.) Also: * Add `merge_metadata` to AnymailMessage, AnymailMessageMixin * Add `is_batch()` logic to BasePayload, for consistent handling * Docs Note: Mailjet implementation switches *all* batch sending from their "Recipients" field to to the "Messages" array bulk sending option. This allows an independent payload for each batch recipient. In addition to supporting merge_metadata, this also removes the prior limitation on mixing Cc/Bcc with merge_data. Closes #141.
87 lines
4.8 KiB
ReStructuredText
87 lines
4.8 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
|
|
|
|
amazon_ses
|
|
mailgun
|
|
mailjet
|
|
mandrill
|
|
postmark
|
|
sendgrid
|
|
sendinblue
|
|
sparkpost
|
|
|
|
|
|
Anymail feature support
|
|
-----------------------
|
|
|
|
The table below summarizes the Anymail features supported for each ESP.
|
|
|
|
.. currentmodule:: anymail.message
|
|
|
|
.. rst-class:: sticky-left
|
|
|
|
============================================ ============ =========== ========== =========== ========== ========== ============ ===========
|
|
Email Service Provider |Amazon SES| |Mailgun| |Mailjet| |Mandrill| |Postmark| |SendGrid| |SendinBlue| |SparkPost|
|
|
============================================ ============ =========== ========== =========== ========== ========== ============ ===========
|
|
.. rubric:: :ref:`Anymail send options <anymail-send-options>`
|
|
---------------------------------------------------------------------------------------------------------------------------------------------------
|
|
:attr:`~AnymailMessage.envelope_sender` Yes Domain only Yes Domain only No No No Yes
|
|
:attr:`~AnymailMessage.metadata` Yes Yes Yes Yes Yes Yes Yes Yes
|
|
:attr:`~AnymailMessage.merge_metadata` No Yes Yes Yes Yes Yes No Yes
|
|
:attr:`~AnymailMessage.send_at` No Yes No Yes No Yes No Yes
|
|
:attr:`~AnymailMessage.tags` Yes Yes Max 1 tag Yes Max 1 tag Yes Max 1 tag Max 1 tag
|
|
:attr:`~AnymailMessage.track_clicks` No Yes Yes Yes Yes Yes No Yes
|
|
:attr:`~AnymailMessage.track_opens` No Yes Yes Yes Yes Yes No Yes
|
|
|
|
.. rubric:: :ref:`templates-and-merge`
|
|
---------------------------------------------------------------------------------------------------------------------------------------------------
|
|
:attr:`~AnymailMessage.template_id` Yes No Yes Yes Yes Yes Yes Yes
|
|
:attr:`~AnymailMessage.merge_data` Yes Yes Yes Yes No Yes No Yes
|
|
:attr:`~AnymailMessage.merge_global_data` Yes (emulated) Yes Yes Yes Yes Yes Yes
|
|
|
|
.. rubric:: :ref:`Status <esp-send-status>` and :ref:`event tracking <event-tracking>`
|
|
---------------------------------------------------------------------------------------------------------------------------------------------------
|
|
:attr:`~AnymailMessage.anymail_status` Yes Yes Yes Yes Yes Yes Yes Yes
|
|
|AnymailTrackingEvent| from webhooks Yes Yes Yes Yes Yes Yes Yes Yes
|
|
|
|
.. rubric:: :ref:`Inbound handling <inbound>`
|
|
---------------------------------------------------------------------------------------------------------------------------------------------------
|
|
|AnymailInboundEvent| from webhooks Yes Yes Yes Yes Yes Yes No Yes
|
|
============================================ ============ =========== ========== =========== ========== ========== ============ ===========
|
|
|
|
|
|
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.)
|
|
|
|
.. |Amazon SES| replace:: :ref:`amazon-ses-backend`
|
|
.. |Mailgun| replace:: :ref:`mailgun-backend`
|
|
.. |Mailjet| replace:: :ref:`mailjet-backend`
|
|
.. |Mandrill| replace:: :ref:`mandrill-backend`
|
|
.. |Postmark| replace:: :ref:`postmark-backend`
|
|
.. |SendGrid| replace:: :ref:`sendgrid-backend`
|
|
.. |SendinBlue| replace:: :ref:`sendinblue-backend`
|
|
.. |SparkPost| replace:: :ref:`sparkpost-backend`
|
|
.. |AnymailTrackingEvent| replace:: :class:`~anymail.signals.AnymailTrackingEvent`
|
|
.. |AnymailInboundEvent| replace:: :class:`~anymail.signals.AnymailInboundEvent`
|
|
|
|
|
|
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`.
|