Skip to content

Commit 9462d03

Browse files
committed
Docs: add ESP feature support matrix
[ci skip]
1 parent 34d6676 commit 9462d03

File tree

2 files changed

+46
-6
lines changed

2 files changed

+46
-6
lines changed

docs/esps/index.rst

Lines changed: 44 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
.. _supported-esps:
22

33
Supported ESPs
4-
--------------
4+
==============
55

6-
Anymail supports these ESPs. Click in for the specific
7-
settings required and notes about any quirks or limitations:
6+
Anymail currently supports these Email Service Providers.
7+
Click an ESP's name for specific Anymail settings required,
8+
and notes about any quirks or limitations:
89

910
.. these are listed in alphabetical order
1011
@@ -17,7 +18,44 @@ settings required and notes about any quirks or limitations:
1718
sendgrid
1819

1920

20-
Don't see your favorite ESP here? You can suggest that
21-
Anymail add it, or even :ref:`contribute <contributing>`
22-
your own implementation to Anymail.
21+
Anymail feature support
22+
-----------------------
2323

24+
The table below summarizes the Anymail features supported for each ESP.
25+
26+
.. currentmodule:: anymail.message
27+
28+
====================================== ====================== ======================= ======================= =======================
29+
Email Service Provider :ref:`mailgun-backend` :ref:`mandrill-backend` :ref:`postmark-backend` :ref:`sendgrid-backend`
30+
====================================== ====================== ======================= ======================= =======================
31+
.. rubric:: :ref:`Anymail send options <anymail-send-options>`
32+
----------------------------------------------------------------------------------------------------------------------------------------
33+
:attr:`~AnymailMessage.metadata` Yes Yes No Yes
34+
:attr:`~AnymailMessage.send_at` Yes Yes No Yes
35+
:attr:`~AnymailMessage.tags` Yes Yes Max 1 tag Yes
36+
:attr:`~AnymailMessage.track_clicks` Yes Yes No Yes
37+
:attr:`~AnymailMessage.track_opens` Yes Yes Yes Yes
38+
39+
.. rubric:: :ref:`Status <esp-send-status>` and tracking
40+
----------------------------------------------------------------------------------------------------------------------------------------
41+
:attr:`~AnymailMessage.anymail_status` Yes Yes Yes Yes
42+
====================================== ====================== ======================= ======================= =======================
43+
44+
45+
.. Status tracking webhooks (coming) (coming) (coming) (coming)
46+
.. .. rubric:: :ref:`inbound`
47+
.. ----------------------------------------------------------------------------------------------------------------------------------------
48+
.. Inbound webhooks (coming) (coming) (coming) (coming)
49+
50+
Trying to choose an ESP? Please **don't** start with this table. It's far more
51+
important to consider things like an ESP's deliverability stats, latency, uptime,
52+
and support for developers. The *number* of extra features an ESP offers is almost
53+
meaningless. (And even specific features don't matter if you don't plan to use them.)
54+
55+
56+
Other ESPs
57+
----------
58+
59+
Don't see your favorite ESP here? Anymail is designed to be extensible.
60+
You can suggest that Anymail add an ESP, or even contribute
61+
your own implementation to Anymail. See :ref:`contributing`.

docs/sending/anymail_additions.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ helpful if you are working with Python development tools that
2727
offer type checking or other static code analysis.
2828

2929

30+
.. _anymail-send-options:
31+
3032
ESP send options (AnymailMessage)
3133
---------------------------------
3234

0 commit comments

Comments
 (0)