Skip to content

Latest commit

 

History

History
1778 lines (1252 loc) · 59.1 KB

CHANGELOG.rst

File metadata and controls

1778 lines (1252 loc) · 59.1 KB
Raw

Changelog

Anymail releases follow semantic versioning. Among other things, this means that minor updates (1.x to 1.y) should always be backwards-compatible, and breaking changes will always increment the major version number (1.x to 2.0).

Release history

v12.0

2024-09-09

Breaking changes

  • Require Django 4.0 or later and Python 3.8 or later.

Features

  • Resend: Add support for send_at.

Fixes

  • Unisender Go: Fix several problems in Anymail's Unisender Go status tracking webhook. Rework signature checking to fix false validation errors (particularly on "clicked" and "opened" events). Properly handle "use single event" webhook option. Correctly verify WEBHOOK_SECRET when set. Provide Unisender Go's delivery_status code and unsubscribe form comment in Anymail's event.description. Treat soft bounces as "deferred" rather than "bounced". (Thanks to @MikeVL for fixing the signature validation problem.)

Other

  • Mandrill (docs): Explain how cc and bcc handling depends on Mandrill's "preserve recipients" option. (Thanks to @dgilmanAIDENTIFIED for reporting the issue.)
  • Postal (docs): Update links to Postal's new documentation site. (Thanks to @jmduke.)

v11.1

2024-08-07

Features

  • Brevo: Support Brevo's new "Complaint," "Error" and "Loaded by proxy" tracking events. (Thanks to @originell for the update.)

Deprecations

  • This will be the last Anymail release to support Django 3.0, 3.1 and 3.2 (which reached end of extended support on 2021-04-06, 2021-12-07 and 2024-04-01, respectively).
  • This will be the last Anymail release to support Python 3.7 (which reached end-of-life on 2023-06-27, and is not supported by Django 4.0 or later).

v11.0.1

2024-07-11

(This release updates only documentation and package metadata; the code is identical to v11.0.)

Fixes

v11.0

2024-06-23

Breaking changes

  • Amazon SES: Drop support for the Amazon SES v1 API. If your EMAIL_BACKEND setting uses amazon_sesv1, or if you are upgrading from Anymail 9.x or earlier directly to 11.0 or later, see Migrating to the SES v2 API. (Anymail 10.0 switched to the SES v2 API by default. If your EMAIL_BACKEND setting has amazon_sesv2, change that to just amazon_ses.)
  • SparkPost: When sending with a template_id, Anymail now raises an error if the message uses features that SparkPost will silently ignore. See docs.

Features

  • Add new merge_headers option for per-recipient headers with batch sends. This can be helpful to send individual List-Unsubscribe headers (for example). Supported for all current ESPs except MailerSend, Mandrill and Postal. See docs. (Thanks to @carrerasrodrigo for the idea, and for the base and Amazon SES implementations.)
  • Amazon SES: Allow extra headers, metadata, merge_metadata, and tags when sending with a template_id. (Requires boto3 v1.34.98 or later.)
  • MailerSend: Allow all extra headers. (Note that MailerSend limits use of this feature to "Enterprise accounts only.")

Fixes

  • Amazon SES: Fix a bug that could result in sending a broken address header if it had a long display name containing both non-ASCII characters and commas. (Thanks to @andresmrm for isolating and reporting the issue.)
  • SendGrid: In the tracking webhook, correctly report "bounced address" (recipients dropped due to earlier bounces) as reject reason "bounced". (Thanks to @vitaliyf.)

v10.3

2024-03-12

Features

  • Brevo: Add support for batch sending (docs).
  • Resend: Add support for batch sending (docs).
  • Unisender Go: Newly supported ESP (docs). (Thanks to @Arondit for the implementation.)

Fixes

  • Mailgun: Avoid an error when Mailgun posts null delivery-status to the event tracking webhook. (Thanks to @izimobil for the fix.)

Deprecations

  • Brevo (SendinBlue): Rename "SendinBlue" to "Brevo" throughout Anymail's code, reflecting their rebranding. This affects the email backend path, settings names, and webhook URLs. The old names will continue to work for now, but are deprecated. See Updating code from SendinBlue to Brevo for details.

v10.2

2023-10-25

Features

  • Resend: Add support for this ESP (docs).

Fixes

  • Correctly merge global SEND_DEFAULTS with message esp_extra for ESP APIs that use a nested structure (including Mandrill and SparkPost). Clarify intent of global defaults merging code for other message properties. (Thanks to @mounirmesselmeni for reporting the issue.)

Other

  • Mailgun (docs): Clarify account-level "Mailgun API keys" vs. domain-level "sending API keys." (Thanks to @sdarwin for reporting the issue.)
  • Test against prerelease versions of Django 5.0 and Python 3.12.

v10.1

2023-07-31

Features

  • Inbound: Improve AnymailInboundMessage's handling of inline content:

    • Rename inline_attachments to content_id_map, more accurately reflecting its function.
    • Add new inlines property that provides a complete list of inline content, whether or not it includes a Content-ID. This is helpful for accessing inline images that appear directly in a multipart/mixed body, such as those created by the Apple Mail app.
    • Rename is_inline_attachment() to just is_inline().

    The renamed items are still available, but deprecated, under their old names. See docs. (Thanks to @martinezleoml.)

  • Inbound: AnymailInboundMessage now derives from Python's email.message.EmailMessage, which provides improved compatibility with email standards. (Thanks to @martinezleoml.)

  • Brevo (Sendinblue): Sendinblue has rebranded to "Brevo." Change default API endpoint to api.brevo.com, and update docs to reflect new name. Anymail still uses sendinblue in the backend name, for settings, etc., so there should be no impact on your code. (Thanks to @sblondon.)

  • Brevo (Sendinblue): Add support for inbound email. (See docs.)

  • SendGrid: Support multiple reply_to addresses. (Thanks to @gdvalderrama for pointing out the new API.)

Deprecations

  • Inbound: AnymailInboundMessage.inline_attachments and .is_inline_attachment() have been renamed---see above.

v10.0

2023-05-07

Breaking changes

  • Amazon SES: The Amazon SES backend now sends using the SES v2 API. Most projects should not require code changes, but you may need to update your IAM permissions. See Migrating to the SES v2 API.

    If you were using SES v2 under Anymail 9.1 or 9.2, change your EMAIL_BACKEND setting from amazon_sesv2 to just amazon_ses.

    (If you are not ready to migrate to SES v2, an amazon_sesv1 EmailBackend is available. But Anymail will drop support for that later this year. See Using SES v1 (deprecated).)

  • Amazon SES: The "extra name" for installation must now be spelled with a hyphen rather than an underscore: django-anymail[amazon-ses]. Be sure to update any dependencies specification (pip install, requirements.txt, etc.) that had been using [amazon_ses]. (This change is due to package name normalization rules enforced by modern Python packaging tools.)

  • Mandrill: Remove support for Mandrill-specific message attributes left over from Djrill. These attributes have raised DeprecationWarnings since Anymail 0.3 (in 2016), but are now silently ignored. See Migrating from Djrill.

  • Require Python 3.7 or later.

  • Require urllib3 1.25 or later. (Drop a workaround for older urllib3 releases. urllib3 is a requests dependency; version 1.25 was released 2019-04-29. Unless you are pinning an earlier urllib3, this change should have no impact.)

Features

  • Postmark inbound:
    • Handle Postmark's "Include raw email content in JSON payload" inbound option. We recommend enabling this in Postmark's dashboard to get the most accurate representation of received email.
    • Obtain envelope_sender from Return-Path Postmark now provides. (Replaces potentially faulty Received-SPF header parsing.)
    • Add Bcc header to inbound message if provided. Postmark adds bcc when the delivered-to address does not appear in the To header.

Other

  • Modernize packaging. (Change from setup.py and setuptools to pyproject.toml and hatchling.) Other than the amazon-ses naming normalization noted above, the new packaging should have no impact. If you have trouble installing django-anymail v10 where v9 worked, please report an issue including the exact install command and pip version you are using.

v9.2

2023-05-02

Fixes

  • Fix misleading error messages when sending with fail_silently=True and session creation fails (e.g., with Amazon SES backend and missing credentials). (Thanks to @technolingo.)
  • Postmark inbound: Fix spurious AnymailInvalidAddress in message.cc when inbound message has no Cc recipients. (Thanks to @Ecno92.)
  • Postmark inbound: Add workaround for malformed test data sent by Postmark's inbound webhook "Check" button. (See #304. Thanks to @Ecno92.)

Deprecations

  • This will be the last Anymail release to support Python 3.6 (which reached end-of-life on 2021-12-23).

Other

  • Test against Django 4.2 release.

v9.1

2023-03-11

Features

  • Amazon SES: Add support for sending through the Amazon SES v2 API (not yet enabled by default; see Deprecations below; docs).
  • MailerSend: Add support for this ESP (docs).

Deprecations

  • Amazon SES: Anymail will be switching to the Amazon SES v2 API. Support for the original SES v1 API is now deprecated, and will be dropped in a future Anymail release (likely in late 2023). Many projects will not require code changes, but you may need to update your IAM permissions. See Migrating to the SES v2 API.

Other

  • Test against Django 4.2 prerelease, Python 3.11 (with Django 4.2), and PyPy 3.9.
  • Use black, isort and doc8 to format code, enforced via pre-commit. (Thanks to @tim-schilling.)

v9.0

2022-12-18

Breaking changes

  • Require Django 3.0 or later and Python 3.6 or later. (For compatibility with Django 2.x or Python 3.5, stay on the Anymail v8.6 LTS extended support branch by setting your requirements to django-anymail~=8.6.)

Features

  • Sendinblue: Support delayed sending using Anymail's send_at option. (Thanks to @dimitrisor for noting Sendinblue's public beta release of this capability.)
  • Support customizing the requests.Session for requests-based backends, and document how this can be used to mount an adapter that simplifies automatic retry logic. (Thanks to @dgilmanAIDENTIFIED.)
  • Confirm support for Django 4.1 and resolve deprecation warning regarding django.utils.timezone.utc. (Thanks to @tim-schilling.)

Fixes

  • Postmark: Handle Postmark's SubscriptionChange events as Anymail unsubscribe, subscribe, or bounce tracking events, rather than "unknown". (Thanks to @puru02 for the fix.)
  • Sendinblue: Work around recent (unannounced) Sendinblue API change that caused "Invalid headers" API error with non-string custom header values. Anymail now converts int and float header values to strings.

Other

  • Test on Python 3.11 with Django development (Django 4.2) branch.

v8.6 LTS

2022-05-15

This is an extended support release. Anymail v8.6 will receive security updates and fixes for any breaking ESP API changes through at least May, 2023.

Fixes

  • Mailgun and SendGrid inbound: Work around a Django limitation that drops attachments with certain filenames. The missing attachments are now simply omitted from the resulting inbound message. (In earlier releases, they would cause a MultiValueDictKeyError in Anymail's inbound webhook.)

    Anymail documentation now recommends using Mailgun's and SendGrid's "raw MIME" inbound options, which avoid the problem and preserve all attachments.

    See Mailgun inbound and SendGrid inbound for details. (Thanks to @erikdrums for reporting and helping investigate the problem.)

Other

  • Mailgun: Document Mailgun's incorrect handling of display names containing both non-ASCII characters and punctuation. (Thanks to @Flexonze for spotting and reporting the issue, and to Mailgun's @b0d0nne11 for investigating.)
  • Mandrill: Document Mandrill's incorrect handling of non-ASCII attachment filenames. (Thanks to @Thorbenl for reporting the issue and following up with MailChimp.)
  • Documentation (for all releases) is now hosted at anymail.dev (moved from anymail.info).

Deprecations

  • This will be the last Anymail release to support Django 2.0--2.2 and Python 3.5.

If these deprecations affect you and you cannot upgrade, set your requirements to django-anymail~=8.6 (a "compatible release" specifier, equivalent to >=8.6,==8.*).

v8.5

2022-01-19

Fixes

  • Allow attach_alternative("content", "text/plain") in place of setting an EmailMessage's body, and generally improve alternative part handling for consistency with Django's SMTP EmailBackend. (Thanks to @cjsoftuk for reporting the issue.)
  • Remove "sending a message from sender to recipient" from AnymailError text, as this can unintentionally leak personal information into logs. [Note that AnymailError does still include any error description from your ESP, and this often contains email addresses and other content from the sent message. If this is a concern, you can adjust Django's logging config to limit collection from Anymail or implement custom PII filtering.] (Thanks to @coupa-anya for reporting the issue.)

Other

  • Postmark: Document limitation on track_opens overriding Postmark's server-level setting. (See docs.)
  • Expand testing documentation to cover tracking events and inbound handling, and to clarify test EmailBackend behavior.
  • In Anymail's test EmailBackend, add is_batch_send boolean to anymail_test_params to help tests check whether a sent message would fall under Anymail's batch-send logic.

v8.4

2021-06-15

Features

  • Postal: Add support for this self-hosted ESP (docs). Thanks to @tiltec for researching, implementing, testing and documenting Postal support.

v8.3

2021-05-19

Fixes

  • Amazon SES: Support receiving and tracking mail in non-default (or multiple) AWS regions. Anymail now always confirms an SNS subscription in the region where the SNS topic exists, which may be different from the boto3 default. (Thanks to @mark-mishyn for reporting this.)
  • Postmark: Fix two different errors when sending with a template but no merge data. (Thanks to @kareemcoding and @Tobeyforce for reporting them.)
  • Postmark: Fix silent failure when sending with long metadata keys and some other errors Postmark detects at send time. Report invalid 'cc' and 'bcc' addresses detected at send time the same as 'to' recipients. (Thanks to @chrisgrande for reporting the problem.)

v8.2

2021-01-27

Features

  • Mailgun: Add support for AMP for Email (via message.attach_alternative(..., "text/x-amp-html")).

Fixes

  • SparkPost: Drop support for multiple from_email addresses. SparkPost has started issuing a cryptic "No sending domain specified" error for this case; with this fix, Anymail will now treat it as an unsupported feature.

Other

  • Mailgun: Improve error messages for some common configuration issues.
  • Test against Django 3.2 prerelease (including support for Python 3.9)
  • Document how to send AMP for Email with Django, and note which ESPs support it. (See docs.)
  • Move CI testing to GitHub Actions (and stop using Travis-CI).
  • Internal: catch invalid recipient status earlier in ESP response parsing

v8.1

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. Thanks to @slinkymanbyday.)
  • SparkPost: In event tracking webhooks, map AMP open and click events to the corresponding Anymail normalized event types. (Previously these were treated as as "unknown" events.)

v8.0

2020-09-11

Breaking changes

  • Require Django 2.0 or later and Python 3. (For compatibility with Django 1.11 and Python 2.7, stay on the Anymail v7.2 LTS extended support branch by setting your requirements to django-anymail~=7.2.)

  • Mailjet: Upgrade to Mailjet's newer v3.1 send API. Most Mailjet users will not be affected by this change, with two exceptions: (1) Mailjet's v3.1 API does not allow multiple reply-to addresses, and (2) if you are using Anymail's esp_extra, you will need to update it for compatibility with the new API. (See docs.)

  • SparkPost: Call the SparkPost API directly, without using the (now unmaintained) Python SparkPost client library. The "sparkpost" package is no longer necessary and can be removed from your project requirements. Most SparkPost users will not be affected by this change, with two exceptions: (1) You must provide a SPARKPOST_API_KEY in your Anymail settings (Anymail does not check environment variables); and (2) if you use Anymail's esp_extra you will need to update it with SparkPost Transmissions API parameters.

    As part of this change esp_extra now allows use of several SparkPost features, such as A/B testing, that were unavailable through the Python SparkPost library. (See docs.)

  • Remove Anymail internal code related to supporting Python 2 and older Django versions. This does not change the documented API, but may affect you if your code borrowed from Anymail's undocumented internals. (You should be able to switch to the Python standard library equivalents, as Anymail has done.)

  • AnymailMessageMixin now correctly subclasses Django's EmailMessage. If you use it as part of your own custom EmailMessage-derived class, and you start getting errors about "consistent method resolution order," you probably need to change your class's inheritance. (For some helpful background, see this comment about mixin superclass ordering.)

Features

  • SparkPost: Add support for subaccounts (new "SPARKPOST_SUBACCOUNT" Anymail setting), AMP for Email (via message.attach_alternative(..., "text/x-amp-html")), and A/B testing and other SparkPost sending features (via esp_extra). (See docs.)

v7.2.1

2020-08-05

Fixes

  • Inbound: Fix a Python 2.7-only UnicodeEncodeError when attachments have non-ASCII filenames. (Thanks to @kika115 for reporting it.)

v7.2 LTS

2020-07-25

This is an extended support release. Anymail v7.2 will receive security updates and fixes for any breaking ESP API changes through at least July, 2021.

Fixes

  • Amazon SES: Fix bcc, which wasn't working at all on non-template sends. (Thanks to @mwheels for reporting the issue.)
  • Mailjet: Fix TypeError when sending to or from addresses with display names containing commas (introduced in Django 2.2.15, 3.0.9, and 3.1).
  • SendGrid: Fix UnicodeError in inbound webhook, when receiving message using charsets other than utf-8, and not using SendGrid's "post raw" inbound parse option. Also update docs to recommend "post raw" with SendGrid inbound. (Thanks to @tcourtqtm for reporting the issue.)

Features

  • Test against Django 3.1 release candidates

Deprecations

  • This will be the last Anymail release to support Django 1.11 and Python 2.7.

If these deprecations affect you and you cannot upgrade, set your requirements to django-anymail~=7.2 (a "compatible release" specifier, equivalent to >=7.2,==7.*).

v7.1

2020-04-13

Fixes

  • Postmark: Fix API error when sending with template to single recipient. (Thanks to @jc-ee for finding and fixing the issue.)
  • SendGrid: Allow non-batch template send to multiple recipients when merge_global_data is set without merge_data. (Broken in v6.0. Thanks to @vgrebenschikov for the bug report.)

Features

  • Add DEBUG_API_REQUESTS setting to dump raw ESP API requests, which can assist in debugging or reporting problems to ESPs. (See docs. This setting has was quietly added in Anymail v4.3, and is now officially documented.)
  • Sendinblue: Now supports file attachments on template sends, when using their new template language. (Sendinblue removed this API limitation on 2020-02-18; the change works with Anymail v7.0 and later. Thanks to @sebashwa for noting the API change and updating Anymail's docs.)

Other

  • Test against released Django 3.0.
  • SendGrid: Document unpredictable behavior in the SendGrid API that can cause text attachments to be sent with the wrong character set. (See docs under "Wrong character set on text attachments." Thanks to @nuschk and @swrobel for helping track down the issue and reporting it to SendGrid.)
  • Docs: Fix a number of typos and some outdated information. (Thanks @alee and @Honza-m.)

v7.0

2019-09-07

Breaking changes

  • Sendinblue templates: Support Sendinblue's new (ESP stored) Django templates and new API for template sending. This removes most of the odd limitations in the older (now-deprecated) SendinBlue template send API, but involves two breaking changes:

    • You must convert each old Sendinblue template to the new language as you upgrade to Anymail v7.0, or certain features may be silently ignored on template sends (notably reply_to and recipient display names).
    • Sendinblue's API no longer supports sending attachments when using templates. [Note: Sendinblue removed this API limitation on 2020-02-18.]

    Ordinary, non-template sending is not affected by these changes. See docs for more info and alternatives. (Thanks @Thorbenl.)

Features

  • Mailgun: Support Mailgun's new (ESP stored) handlebars templates via template_id. See docs. (Thanks @anstosa.)
  • Sendinblue: Support multiple tags. (Thanks @Thorbenl.)

Other

  • Mailgun: Disable Anymail's workaround for a Requests/urllib3 issue with non-ASCII attachment filenames when a newer version of urllib3--which fixes the problem--is installed. (Workaround was added in Anymail v4.3; fix appears in urllib3 v1.25.)

v6.1

2019-07-07

Features

  • Mailgun: Add new MAILGUN_WEBHOOK_SIGNING_KEY setting for verifying tracking and inbound webhook calls. Mailgun's webhook signing key can become different from your MAILGUN_API_KEY if you have ever rotated either key. See docs. (More in #153. Thanks to @dominik-lekse for reporting the problem and Mailgun's @mbk-ok for identifying the cause.)

v6.0.1

2019-05-19

Fixes

  • Support using AnymailMessage with django-mailer and similar packages that pickle messages. (See #147. Thanks to @ewingrj for identifying the problem.)
  • Fix UnicodeEncodeError error while reporting invalid email address on Python 2.7. (See #148. Thanks to @fdemmer for reporting the problem.)

v6.0

2019-02-23

Breaking changes

  • Postmark: Anymail's message.anymail_status.recipients[email] no longer lowercases the recipient's email address. For consistency with other ESPs, it now uses the recipient email with whatever case was used in the sent message. If your code is doing something like message.anymail_status.recipients[email.lower()], you should remove the .lower()

  • SendGrid: In batch sends, Anymail's SendGrid backend now assigns a separate message_id for each "to" recipient, rather than sharing a single id for all recipients. This improves accuracy of tracking and statistics (and matches the behavior of many other ESPs).

    If your code uses batch sending (merge_data with multiple to-addresses) and checks message.anymail_status.message_id after sending, that value will now be a set of ids. You can obtain each recipient's individual message_id with message.anymail_status.recipients[to_email].message_id. See docs.

Features

  • Add new merge_metadata option for providing per-recipient metadata in batch sends. Available for all supported ESPs except Amazon SES and SendinBlue. See docs. (Thanks @janneThoft for the idea and SendGrid implementation.)
  • Mailjet: Remove limitation on using cc or bcc together with merge_data.

Fixes

  • Mailgun: Better error message for invalid sender domains (that caused a cryptic "Mailgun API response 200: OK Mailgun Magnificent API" error in earlier releases).
  • Postmark: Don't error if a message is sent with only Cc and/or Bcc recipients (but no To addresses). Also, message.anymail_status.recipients[email] now includes send status for Cc and Bcc recipients. (Thanks to @ailionx for reporting the error.)
  • SendGrid: With legacy templates, stop (ab)using "sections" for merge_global_data. This avoids potential conflicts with a template's own use of SendGrid section tags.

v5.0

2018-11-07

Breaking changes

  • Mailgun: Anymail's status tracking webhooks now report Mailgun "temporary failure" events as Anymail's normalized "deferred" event_type. (Previously they were reported as "bounced", lumping them in with permanent failures.) The new behavior is consistent with how Anymail handles other ESP's tracking notifications. In the unlikely case your code depended on "temporary failure" showing up as "bounced" you will need to update it. (Thanks @costela.)

Features

  • Postmark: Allow either template alias (string) or numeric template id for Anymail's template_id when sending with Postmark templates.

Fixes

  • Mailgun: Improve error reporting when an inbound route is accidentally pointed at Anymail's tracking webhook url or vice versa.

v4.3

2018-10-11

Features

  • Treat MIME attachments that have a Content-ID but no explicit Content-Disposition header as inline, matching the behavior of many email clients. For maximum compatibility, you should always set both (or use Anymail's inline helper functions). (Thanks @costela.)

Fixes

  • Mailgun: Raise AnymailUnsupportedFeature error when attempting to send an attachment without a filename (or inline attachment without a Content-ID), because Mailgun silently drops these attachments from the sent message. (See docs. Thanks @costela for identifying this undocumented Mailgun API limitation.)
  • Mailgun: Fix problem where attachments with non-ASCII filenames would be lost. (Works around Requests/urllib3 issue encoding multipart/form-data filenames in a way that isn't RFC 7578 compliant. Thanks to @decibyte for catching the problem.)

Other

  • Add (undocumented) DEBUG_API_REQUESTS Anymail setting. When enabled, prints raw API request and response during send. Currently implemented only for Requests-based backends (all but Amazon SES and SparkPost). Because this can expose API keys and other sensitive info in log files, it should not be used in production.

v4.2

2018-09-07

Features

  • Postmark: Support per-recipient template merge_data and batch sending. (Batch sending can be used with or without a template. See docs.)

Fixes

  • Postmark: When using template_id, ignore empty subject and body. (Postmark issues an error if Django's default empty strings are used with template sends.)

v4.1

2018-08-27

Features

  • SendGrid: Support both new "dynamic" and original "legacy" transactional templates. (See docs.)
  • SendGrid: Allow merging esp_extra["personalizations"] dict into other message-derived personalizations. (See docs.)

v4.0

2018-08-19

Breaking changes

  • Drop support for Django versions older than Django 1.11. (For compatibility back to Django 1.8, stay on the Anymail v3.0 extended support branch.)
  • SendGrid: Remove the legacy SendGrid v2 EmailBackend. (Anymail's default since v0.8 has been SendGrid's newer v3 API.) If your settings.py EMAIL_BACKEND still references "sendgrid_v2," you must upgrade to v3.

Features

  • Mailgun: Add support for new Mailgun webhooks. (Mailgun's original "legacy webhook" format is also still supported. See docs.)
  • Mailgun: Document how to use new European region. (This works in earlier Anymail versions, too.)
  • Postmark: Add support for Anymail's normalized metadata in sending and webhooks.

Fixes

  • Avoid problems with Gmail blocking messages that have inline attachments, when sent from a machine whose local hostname ends in .com. Change Anymail's attach_inline_image() default Content-ID domain to the literal text "inline" (rather than Python's default of the local hostname), to work around a limitation of some ESP APIs that don't permit distinct content ID and attachment filenames (Mailgun, Mailjet, Mandrill and SparkPost). See #112 for more details.
  • Amazon SES: Work around an Amazon SES bug that can corrupt non-ASCII message bodies if you are using SES's open or click tracking. (See #115 for more details. Thanks to @varche1 for isolating the specific conditions that trigger the bug.)

Other

  • Maintain changelog in the repository itself (rather than in GitHub release notes).
  • Test against released versions of Python 3.7 and Django 2.1.

v3.0

2018-05-30

This is an extended support release. Anymail v3.x will receive security updates and fixes for any breaking ESP API changes through at least April, 2019.

Breaking changes

  • Drop support for Python 3.3 (see #99).
  • SendGrid: Fix a problem where Anymail's status tracking webhooks didn't always receive the same event.message_id as the sent message.anymail_status.message_id, due to unpredictable behavior by SendGrid's API. Anymail now generates a UUID for each sent message and attaches it as a SendGrid custom arg named anymail_id. For most users, this change should be transparent. But it could be a breaking change if you are relying on a specific message_id format, or relying on message_id matching the Message-ID mail header or SendGrid's "smtp-id" event field. (More details in the docs; also see #108.) Thanks to @joshkersey for the report and the fix.

Features

  • Support Django 2.1 prerelease.

Fixes

  • Mailjet: Fix tracking webhooks to work correctly when Mailjet "group events" option is disabled (see #106).

Deprecations

  • This will be the last Anymail release to support Django 1.8, 1.9, and 1.10 (see #110).
  • This will be the last Anymail release to support the legacy SendGrid v2 EmailBackend (see #111). (SendGrid's newer v3 API has been the default since Anymail v0.8.)

If these deprecations affect you and you cannot upgrade, set your requirements to django-anymail~=3.0 (a "compatible release" specifier, equivalent to >=3.0,==3.*).

v2.2

2018-04-16

Fixes

  • Fix a breaking change accidentally introduced in v2.1: The boto3 package is no longer required if you aren't using Amazon SES.

v2.1

2018-04-11

NOTE: v2.1 accidentally introduced a breaking change: enabling Anymail webhooks with include('anymail.urls') causes an error if boto3 is not installed, even if you aren't using Amazon SES. This is fixed in v2.2.

Features

  • Amazon SES: Add support for this ESP (docs).
  • SparkPost: Add SPARKPOST_API_URL setting to support SparkPost EU and SparkPost Enterprise (docs).
  • Postmark: Update for Postmark "modular webhooks." This should not impact client code. (Also, older versions of Anymail will still work correctly with Postmark's webhook changes.)

Fixes

  • Inbound: Fix several issues with inbound messages, particularly around non-ASCII headers and body content. Add workarounds for some limitations in older Python email packages.

Other

  • Use tox to manage Anymail test environments (see contributor docs).

Deprecations

  • This will be the last Anymail release to support Python 3.3. See #99 for more information.

v2.0

2018-03-08

Breaking changes

  • Drop support for deprecated WEBHOOK_AUTHORIZATION setting. If you are using webhooks and still have this Anymail setting, you must rename it to WEBHOOK_SECRET. See the v1.4 release notes.
  • Handle Reply-To, From, and To in EmailMessage extra_headers the same as Django's SMTP EmailBackend if supported by your ESP, otherwise raise an unsupported feature error. Fixes the SparkPost backend to be consistent with other backends if both headers["Reply-To"] and reply_to are set on the same message. If you are setting a message's headers["From"] or headers["To"] (neither is common), the new behavior is likely a breaking change. See docs and #91.
  • Treat EmailMessage extra_headers keys as case-insensitive in all backends, for consistency with each other (and email specs). If you are specifying duplicate headers whose names differ only in case, this may be a breaking change. See docs.

Features

  • SendinBlue: Add support for this ESP (docs). Thanks to @RignonNoel for the implementation.
  • Add EmailMessage envelope_sender attribute, which can adjust the message's Return-Path if supported by your ESP (docs).
  • Add universal wheel to PyPI releases for faster installation.

Other

  • Update setup.py metadata, clean up implementation. (Hadn't really been touched since original Djrill version.)
  • Prep for Python 3.7.

v1.4

2018-02-08

Security

  • Fix a low severity security issue affecting Anymail v0.2–v1.3: rename setting WEBHOOK_AUTHORIZATION to WEBHOOK_SECRET to prevent inclusion in Django error reporting. (CVE-2018-1000089)

More information

Django error reporting includes the value of your Anymail WEBHOOK_AUTHORIZATION setting. In a properly-configured deployment, this should not be cause for concern. But if you have somehow exposed your Django error reports (e.g., by mis-deploying with DEBUG=True or by sending error reports through insecure channels), anyone who gains access to those reports could discover your webhook shared secret. An attacker could use this to post fabricated or malicious Anymail tracking/inbound events to your app, if you are using those Anymail features.

The fix renames Anymail's webhook shared secret setting so that Django's error reporting mechanism will sanitize it.

If you are using Anymail's event tracking and/or inbound webhooks, you should upgrade to this release and change "WEBHOOK_AUTHORIZATION" to "WEBHOOK_SECRET" in the ANYMAIL section of your settings.py. You may also want to rotate the shared secret value, particularly if you have ever exposed your Django error reports to untrusted individuals.

If you are only using Anymail's EmailBackends for sending email and have not set up Anymail's webhooks, this issue does not affect you.

The old WEBHOOK_AUTHORIZATION setting is still allowed in this release, but will issue a system-check warning when running most Django management commands. It will be removed completely in a near-future release, as a breaking change.

Thanks to Charlie DeTar (@yourcelf) for responsibly reporting this security issue through private channels.

v1.3

2018-02-02

Security

  • v1.3 includes the v1.2.1 security fix released at the same time. Please review the v1.2.1 release notes, below, if you are using Anymail's tracking webhooks.

Features

  • Inbound handling: Add normalized inbound message event, signal, and webhooks for all supported ESPs. (See new Receiving mail docs.) This hasn't been through much real-world testing yet; bug reports and feedback are very welcome.
  • API network timeouts: For Requests-based backends (all but SparkPost), use a default timeout of 30 seconds for all ESP API calls, to avoid stalling forever on a bad connection. Add a REQUESTS_TIMEOUT Anymail setting to override. (See #80.)
  • Test backend improvements: Generate unique tracking message_id when using the test backend; add console backend for use in development. (See #85.)

v1.2.1

2018-02-02

Security

  • Fix a moderate severity security issue affecting Anymail v0.2–v1.2: prevent timing attack on WEBHOOK_AUTHORIZATION secret. (CVE-2018-6596)

More information

If you are using Anymail's tracking webhooks, you should upgrade to this release, and you may want to rotate to a new WEBHOOK_AUTHORIZATION shared secret (see docs). You should definitely change your webhook auth if your logs indicate attempted exploit.

(If you are only sending email using an Anymail EmailBackend, and have not set up Anymail's event tracking webhooks, this issue does not affect you.)

Anymail's webhook validation was vulnerable to a timing attack. A remote attacker could use this to obtain your WEBHOOK_AUTHORIZATION shared secret, potentially allowing them to post fabricated or malicious email tracking events to your app.

There have not been any reports of attempted exploit. (The vulnerability was discovered through code review.) Attempts would be visible in HTTP logs as a very large number of 400 responses on Anymail's webhook urls (by default "/anymail/esp_name/tracking/"), and in Python error monitoring as a very large number of AnymailWebhookValidationFailure exceptions.

v1.2

2017-11-02

Features

  • Postmark: Support new click webhook in normalized tracking events

v1.1

2017-10-28

Fixes

  • Mailgun: Support metadata in opened/clicked/unsubscribed tracking webhooks, and fix potential problems if metadata keys collided with Mailgun event parameter names. (See #76, #77)

Other

  • Rework Anymail's ParsedEmail class and rename to EmailAddress to align it with similar functionality in the Python 3.6 email package, in preparation for future inbound support. ParsedEmail was not documented for use outside Anymail's internals (so this change does not bump the semver major version), but if you were using it in an undocumented way you will need to update your code.

v1.0

2017-09-18

It's official: Anymail is no longer "pre-1.0." The API has been stable for many months, and there's no reason not to use Anymail in production.

Breaking changes

  • There are no new breaking changes in the 1.0 release, but a breaking change introduced several months ago in v0.8 is now strictly enforced. If you still have an EMAIL_BACKEND setting that looks like "anymail.backends.*espname*.EspNameBackend", you'll need to change it to just "anymail.backends.*espname*.EmailBackend". (Earlier versions had issued a DeprecationWarning. See the v0.8 release notes.)

Features

v1.0.rc0

2017-09-09

Breaking changes

  • All backends: The old EspNameBackend names that were deprecated in v0.8 have been removed. Attempting to use the old names will now fail, rather than issue a DeprecationWarning. See the v0.8 release notes.

Features

  • Anymail's Test EmailBackend is now documented (and cleaned up)

v0.11.1

2017-07-24

Fixes

  • Mailjet: Correct settings docs.

v0.11

2017-07-13

Features

  • Mailjet: Add support for this ESP. Thanks to @Lekensteyn and @calvin. (Docs)
  • In webhook handlers, AnymailTrackingEvent.metadata now defaults to {}, and .tags defaults to [], if the ESP does not supply these fields with the event. (See #67.)

v0.10

2017-05-22

Features

  • Mailgun, SparkPost: Support multiple from addresses, as a comma-separated from_email string. (Not a list of strings, like the recipient fields.) RFC-5322 allows multiple from email addresses, and these two ESPs support it. Though as a practical matter, multiple from emails are either ignored or treated as a spam signal by receiving mail handlers. (See #60.)

Fixes

  • Fix crash sending forwarded email messages as attachments. (See #59.)
  • Mailgun: Fix webhook crash on bounces from some receiving mail handlers. (See #62.)
  • Improve recipient-parsing error messages and consistency with Django's SMTP backend. In particular, Django (and now Anymail) allows multiple, comma-separated email addresses in a single recipient string.

v0.9

2017-04-04

Breaking changes

  • Mandrill, Postmark: Normalize soft-bounce webhook events to event_type 'bounced' (rather than 'deferred').

Features

  • Officially support released Django 1.11, including under Python 3.6.

v0.8

2017-02-02

Breaking changes

  • All backends: Rename all Anymail backends to just EmailBackend, matching Django's naming convention. E.g., you should update: EMAIL_BACKEND = "anymail.backends.mailgun.MailgunBackend" # old to: EMAIL_BACKEND = "anymail.backends.mailgun.EmailBackend" # new

    The old names still work, but will issue a DeprecationWarning and will be removed in some future release (Apologies for this change; the old naming was a holdover from Djrill, and I wanted to establish consistency with other Django EmailBackends before Anymail 1.0. See #49.)

  • SendGrid: Update SendGrid backend to their newer Web API v3. This should be a transparent change for most projects. Exceptions: if you use SendGrid username/password auth, Anymail's esp_extra with "x-smtpapi", or multiple Reply-To addresses, please review the porting notes.

    The SendGrid v2 EmailBackend remains available if you prefer it, but is no longer the default.

Features

  • Test on Django 1.11 prerelease, including under Python 3.6.

Fixes

  • Mandrill: Fix bug in webhook signature validation when using basic auth via the WEBHOOK_AUTHORIZATION setting. (If you were using the MANDRILL_WEBHOOK_URL setting to work around this problem, you should be able to remove it. See #48.)

v0.7

2016-12-30

Breaking changes

  • Fix a long-standing bug validating email addresses. If an address has a display name containing a comma or parentheses, RFC-5322 requires double-quotes around the display name ('"Widgets, Inc." <[email protected]>'). Anymail now raises a new AnymailInvalidAddress error for misquoted display names and other malformed addresses. (Previously, it silently truncated the address, leading to obscure exceptions or unexpected behavior. If you were unintentionally relying on that buggy behavior, this may be a breaking change. See #44.) In general, it's safest to always use double-quotes around all display names.

Features

  • Postmark: Support Postmark's new message delivery event in Anymail normalized tracking webhook. (Update your Postmark config to enable the new event. See docs.)
  • Handle virtually all uses of Django lazy translation strings as EmailMessage properties. (In earlier releases, these could sometimes lead to obscure exceptions or unexpected behavior with some ESPs. See #34.)
  • Mandrill: Simplify and document two-phase process for setting up Mandrill webhooks (docs).

v0.6.1

2016-11-01

Fixes

  • Mailgun, Mandrill: Support older Python 2.7.x versions in webhook validation (#39; thanks @sebbacon).
  • Postmark: Handle older-style 'Reply-To' in EmailMessage headers (#41).

v0.6

2016-10-25

Breaking changes

  • SendGrid: Fix missing html or text template body when using template_id with an empty Django EmailMessage body. In the (extremely-unlikely) case you were relying on the earlier quirky behavior to not send your saved html or text template, you may want to verify that your SendGrid templates have matching html and text. (docs -- also see #32.)

Features

  • Postmark: Add support for track_clicks (docs)
  • Initialize AnymailMessage.anymail_status to empty status, rather than None; clarify docs around anymail_status availability (docs)

v0.5

2016-08-22

Features

  • Mailgun: Add MAILGUN_SENDER_DOMAIN setting. (docs)

v0.4.2

2016-06-24

Fixes

  • SparkPost: Fix API error "Both content object and template_id are specified" when using template_id (#24).

v0.4.1

2016-06-23

Features

  • SparkPost: Add support for this ESP. (docs)
  • Test with Django 1.10 beta
  • Requests-based backends (all but SparkPost) now raise AnymailRequestsAPIError for any requests.RequestException, for consistency and proper fail_silently behavior. (The exception will also be a subclass of the original RequestException, so no changes are required to existing code looking for specific requests failures.)

v0.4

(not released)

v0.3.1

2016-05-18

Fixes

  • SendGrid: Fix API error that to is required when using merge_data (see #14; thanks @lewistaylor).

v0.3

2016-05-13

Features

  • Add support for ESP stored templates and batch sending/merge. Exact capabilities vary widely by ESP -- be sure to read the notes for your ESP. (docs)
  • Add pre_send and post_send signals. docs
  • Mandrill: add support for esp_extra; deprecate Mandrill-specific message attributes left over from Djrill. See migrating from Djrill.

v0.2

2016-04-30

Breaking changes

  • Mailgun: eliminate automatic JSON encoding of complex metadata values like lists and dicts. (Was based on misreading of Mailgun docs; behavior now matches metadata handling for all other ESPs.)
  • Mandrill: remove obsolete wehook views and signal inherited from Djrill. See Djrill migration notes if you were relying on that code.

Features

  • Add support for ESP event-tracking webhooks, including normalized AnymailTrackingEvent. (docs)
  • Allow get_connection kwargs overrides of most settings for individual backend instances. Can be useful for, e.g., working with multiple SendGrid subusers. (docs)
  • SendGrid: Add SENDGRID_GENERATE_MESSAGE_ID setting to control workarounds for ensuring unique tracking ID on SendGrid messages/events (default enabled). docs
  • SendGrid: improve handling of 'filters' in esp_extra, making it easier to mix custom SendGrid app filter settings with Anymail normalized message options.

Other

  • Drop pre-Django 1.8 test code. (Wasn't being used, as Anymail requires Django 1.8+.)
  • Mandrill: note limited support in docs (because integration tests no longer available).

v0.1

2016-03-14

Although this is an early release, it provides functional Django EmailBackends and passes integration tests with all supported ESPs (Mailgun, Mandrill, Postmark, SendGrid).

It has (obviously) not yet undergone extensive real-world testing, and you are encouraged to monitor it carefully if you choose to use it in production. Please report bugs and problems here in GitHub.

Features

  • Postmark: Add support for this ESP.
  • SendGrid: Add support for username/password auth.
  • Simplified install: no need to name the ESP (pip install django-anymail -- not ... django-anymail[mailgun])

0.1.dev2

2016-03-12

Features

  • SendGrid: Add support for this ESP.
  • Add attach_inline_image_file helper

Fixes

  • Change inline-attachment handling to look for Content-Disposition: inline, and to preserve filenames where supported by the ESP.

0.1.dev1

2016-03-10

Features

  • Mailgun, Mandrill: initial supported ESPs.
  • Initial docs