pacnpal/django-anymail
1
0
Fork 0
mirror of https://github.com/pacnpal/django-anymail.git synced 2025-12-20 03:41:05 -05:00
Code Issues Packages Projects Releases Wiki Activity

Clean up and document Anymail's test EmailBackend

Browse Source 
* Change Anymail's test EmailBackend to collect sent messages in
  django.core.mail.outbox, same as Django's own locmem EmailBackend.
  (So Django's test runner will automatically clear accumulated mail
  between test cases.)

* Rename EmailMessage `test_response` attr to `anymail_test_response`
  to avoid conflicts, and record merged ESP send params in
  new `anymail_send_params` attr.

* Add docs

Closes #36.
This commit is contained in:
medmunds
2017-09-01 13:13:25 -07:00
parent a9c663f36a
commit 2faa5f96cb
6 changed files with 106 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/sending/anymail_additions.rst
View File

@@ -218,11 +218,13 @@ ESP send status
if you try to access it.
This might cause problems in your test cases, because Django
`substitutes its own locmem email backend`_ during testing (so anymail_status
won't be set even after sending). Your code should either guard against
a missing anymail_status attribute, or use :class:`AnymailMessage`
(or the :class:`AnymailMessageMixin`) which initializes its anymail_status
attribute to a default AnymailStatus object.
:ref:`substitutes its own locmem EmailBackend <django:topics-testing-email>`
during testing (so anymail_status never gets attached to the EmailMessage).
If you run into this, you can: change your code to guard against
a missing anymail_status attribute; switch from using EmailMessage to
:class:`AnymailMessage` (or the :class:`AnymailMessageMixin`) to ensure the
anymail_status attribute is always there; or substitute
:ref:`Anymail's test backend <test-backend>` in any affected test cases.
After sending through an Anymail backend,
:attr:`~AnymailMessage.anymail_status` will be an object with these attributes:
@@ -321,10 +323,6 @@ ESP send status
message.anymail_status.esp_response.json()
.. _substitutes its own locmem email backend:
https://docs.djangoproject.com/en/stable/topics/testing/tools/#email-services
.. _inline-images:
Inline images