Releases: anymail/django-anymail
v1.0
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.)
New features and other changes
- Clean up and document Anymail's Test EmailBackend
- Add notes on handling transient ESP errors and improving batch send performance
- SendGrid: handle Python 2
long
integers in metadata and extra headers
v1.0.rc0
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.
New features
- Anymail's Test EmailBackend is now documented (and cleaned up)
v0.11.1
v0.11
v0.10
New 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.)
Other changes
- 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
v0.8
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.
Other changes
- 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.)
- Test on Django 1.11 prerelease, including under Python 3.6.
v0.7
New 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.)
Other changes
- [possibly-breaking] 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." <widgets@example.com>'
). Anymail now raises a newAnymailInvalidAddress
error for misquoted display names and other malformed addresses. (Previously, it silently truncated the address, leading to obscure exceptions or unexpected behavior. See #44.) In general, it's safest to always use double-quotes around all display names. - Mandrill: Simplify and document two-phase process for setting up Mandrill webhooks. (docs)
v0.6.1
v0.6
New features
- Postmark: Add support for
track_clicks
(docs)
Other changes
- Initialize AnymailMessage.anymail_status to empty status, rather than None; clarify docs around
anymail_status
availability (docs) - [possibly-breaking] 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.)