Skip to content

Commit a868bf3

Browse files
committed
Docs: cover Postmark limitation on track_opens
Note that Postmark doesn't support `track_opens = False` when open tracking is enabled at the server level. (But does support the opposite usage.)
1 parent 2b146c1 commit a868bf3

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

CHANGELOG.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,10 @@ Fixes
4949
Other
5050
~~~~~
5151

52+
* **Postmark:** Document limitation on `track_opens` overriding Postmark's
53+
server-level setting. (See
54+
`docs <https://anymail.readthedocs.io/en/latest/esps/postmark/#limitations-and-quirks>`__.)
55+
5256
* In Anymail's test EmailBackend, add `is_batch_send` boolean to `anymail_test_params`
5357
to help tests check whether a sent message would fall under Anymail's batch-send logic.
5458

docs/esps/postmark.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,28 @@ see :ref:`unsupported-features`.
116116
.. _several link-tracking options:
117117
https://postmarkapp.com/developer/user-guide/tracking-links#enabling-link-tracking
118118

119+
**Open-tracking**
120+
To control :attr:`~anymail.message.AnymailMessage.track_opens` on individual messages,
121+
you must *disable* Postmark's server-level default and then set ``track_opens = True``
122+
on all messages that should have open tracking. (A message-level ``track_opens = False``
123+
`cannot override open tracking`_ if enabled in Postmark's server defaults.)
124+
125+
If most of your messages should be sent with open tracking, you can use Anymail's
126+
:ref:`global send defaults <send-defaults>` (rather than Postmark's server-level setting):
127+
128+
.. code-block:: python
129+
130+
# settings.py
131+
ANYMAIL = {
132+
# ...
133+
"SEND_DEFAULTS": { "track_opens": True },
134+
}
135+
136+
Individual messages *can* then use ``track_opens = False`` to override Anymail's default.
137+
138+
.. _cannot override open tracking:
139+
https://postmarkapp.com/developer/user-guide/tracking-opens/tracking-opens-per-email
140+
119141
**No envelope sender overrides**
120142
Postmark does not support overriding :attr:`~anymail.message.AnymailMessage.envelope_sender`
121143
on individual messages. (You can configure custom return paths for each sending domain in

0 commit comments

Comments
 (0)