Skip to content

Commit

Permalink
Release 8.1
Browse files Browse the repository at this point in the history
  • Loading branch information
medmunds committed Oct 9, 2020
1 parent b9fdd3a commit a7ea862
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,18 @@ Release history
^^^^^^^^^^^^^^^
.. This extra heading level keeps the ToC from becoming unmanageably long
vNext
-----
v8.1
----

*Unreleased changes*
*2020-10-09*

Features
~~~~~~~~

* **SparkPost:** Add option for event tracking webhooks to map SparkPost's "Initial Open"
event to Anymail's normalized "opened" type. (By default, only SparkPost's "Open" is
reported as Anymail "opened", and "Initial Open" maps to "unknown" to avoid duplicates.
See `docs <https://anymail.readthedocs.io/en/latest/esps/sparkpost/#sparkpost-webhooks>`__.
See `docs <https://anymail.readthedocs.io/en/stable/esps/sparkpost/#sparkpost-webhooks>`__.
Thanks to `@slinkymanbyday`_.)

* **SparkPost:** In event tracking webhooks, map AMP open and click events to the
Expand Down
2 changes: 1 addition & 1 deletion anymail/_version.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
VERSION = (8, 0)
VERSION = (8, 1)
__version__ = '.'.join([str(x) for x in VERSION]) # major.minor.patch or major.minor.devN
__minor_version__ = '.'.join([str(x) for x in VERSION[:2]]) # Sphinx's X.Y "version"
6 changes: 3 additions & 3 deletions docs/esps/sparkpost.rst
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ You must specify the full, versioned API endpoint as shown above (not just the b

.. rubric:: SPARKPOST_TRACK_INITIAL_OPEN_AS_OPENED

.. versionadded:: vNext
.. versionadded:: 8.1

Boolean, default ``False``. When using Anymail's tracking webhooks, whether to report
SparkPost's "Initial Open" event as an Anymail normalized "opened" event.
Expand Down Expand Up @@ -296,14 +296,14 @@ By default, Anymail reports SparkPost's "Open"---but *not* its "Initial Open"---
as Anymail's normalized "opened" :attr:`~anymail.signals.AnymailTrackingEvent.event_type`.
This avoids duplicate "opened" events when both SparkPost types are enabled.

.. versionadded:: vNext
.. versionadded:: 8.1

To receive SparkPost "Initial Open" events as Anymail's "opened", set
:setting:`"SPARKPOST_TRACK_INITIAL_OPEN_AS_OPENED": True <ANYMAIL_SPARKPOST_TRACK_INITIAL_OPEN_AS_OPENED>`
in your ANYMAIL settings dict. You will probably want to disable SparkPost "Open"
events when using this setting.

.. versionchanged:: vNext
.. versionchanged:: 8.1

SparkPost's "AMP Click" and "AMP Open" are reported as Anymail's "clicked" and
"opened" events. If you enable the SPARKPOST_TRACK_INITIAL_OPEN_AS_OPENED setting,
Expand Down

0 comments on commit a7ea862

Please sign in to comment.