Docs: note Mailgun broken display name encoding

Document that Mailgun's API can mis-encode
display names containing both punctuation and
non-ASCII characters.

Closes #270
This commit is contained in:
medmunds
2022-05-03 15:27:05 -07:00
parent 33af7c387d
commit 6a2e30ba8f
2 changed files with 17 additions and 1 deletions

View File

@@ -33,6 +33,10 @@ vNext
Other 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. * **Mandrill:** Document Mandrill's incorrect handling of non-ASCII attachment filenames.
(Thanks to `@Thorbenl`_ for reporting the issue and following up with MailChimp.) (Thanks to `@Thorbenl`_ for reporting the issue and following up with MailChimp.)
@@ -1287,6 +1291,7 @@ Features
.. _@ailionx: https://github.com/ailionx .. _@ailionx: https://github.com/ailionx
.. _@alee: https://github.com/alee .. _@alee: https://github.com/alee
.. _@anstosa: https://github.com/anstosa .. _@anstosa: https://github.com/anstosa
.. _@b0d0nne11: https://github.com/b0d0nne11
.. _@calvin: https://github.com/calvin .. _@calvin: https://github.com/calvin
.. _@chrisgrande: https://github.com/chrisgrande .. _@chrisgrande: https://github.com/chrisgrande
.. _@cjsoftuk: https://github.com/cjsoftuk .. _@cjsoftuk: https://github.com/cjsoftuk
@@ -1296,6 +1301,7 @@ Features
.. _@dominik-lekse: https://github.com/dominik-lekse .. _@dominik-lekse: https://github.com/dominik-lekse
.. _@ewingrj: https://github.com/ewingrj .. _@ewingrj: https://github.com/ewingrj
.. _@fdemmer: https://github.com/fdemmer .. _@fdemmer: https://github.com/fdemmer
.. _@Flexonze: https://github.com/Flexonze
.. _@Honza-m: https://github.com/Honza-m .. _@Honza-m: https://github.com/Honza-m
.. _@janneThoft: https://github.com/janneThoft .. _@janneThoft: https://github.com/janneThoft
.. _@jc-ee: https://github.com/jc-ee .. _@jc-ee: https://github.com/jc-ee

View File

@@ -202,6 +202,15 @@ Limitations and quirks
Earlier Anymail releases did not check for these cases, and attachments Earlier Anymail releases did not check for these cases, and attachments
without filenames/Content-IDs would be ignored by Mailgun without notice. without filenames/Content-IDs would be ignored by Mailgun without notice.
**Display name problems with punctuation and non-ASCII characters**
Mailgun does not correctly handle certain display names in :mailheader:`From`,
:mailheader:`To`, and other email headers. If a display name includes *both* non-ASCII characters
and certain punctuation (such as parentheses), the resulting email will
use a non-standard encoding that causes some email clients to display
additional `"` or `\\"` characters wrapping the display name. (Verified
and reported to Mailgun engineering 3/2022. See `Anymail issue #270`_
for examples and specific details.)
**Envelope sender uses only domain** **Envelope sender uses only domain**
Anymail's :attr:`~anymail.message.AnymailMessage.envelope_sender` is used to Anymail's :attr:`~anymail.message.AnymailMessage.envelope_sender` is used to
select your Mailgun :ref:`sender domain <mailgun-sender-domain>`. For select your Mailgun :ref:`sender domain <mailgun-sender-domain>`. For
@@ -244,7 +253,8 @@ Limitations and quirks
.. versionadded:: 8.2 .. versionadded:: 8.2
.. _Anymail issue #270:
https://github.com/anymail/django-anymail/issues/270
.. _undocumented API requirement: .. _undocumented API requirement:
https://mailgun.uservoice.com/forums/156243-feature-requests/suggestions/35668606 https://mailgun.uservoice.com/forums/156243-feature-requests/suggestions/35668606