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

Clean up mandrill_reponse docs

Browse Source 
Document mandrill_response as an attribute
(not just a generic topic).
This commit is contained in:
medmunds
2015-12-02 16:18:57 -08:00
parent 9971c1780f
commit d82d425aa8
1 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/usage/sending_mail.rst
View File

@@ -300,13 +300,15 @@ see :class:`DjrillMandrillFeatureTests` in :file:`tests/test_mandrill_send.py` f
.. _mandrill-response: .. _mandrill-response:
Mandrill Response Response from Mandrill
----------------- ----------------------
A ``mandrill_response`` property is added to each :class:`~django.core.mail.EmailMessage` that you .. attribute:: mandrill_response
send. This allows you to retrieve message ids, initial status information and more.
For an EmailMessage that is successfully sent to one or more email addresses, ``mandrill_response`` will Djrill adds a :attr:`!mandrill_response` attribute to each :class:`~django.core.mail.EmailMessage`
as it sends it. This allows you to retrieve message ids, initial status information and more.
For an EmailMessage that is successfully sent to one or more email addresses, :attr:`!mandrill_response` will
be set to a ``list`` of ``dict``, where each entry has info for one email address. See the Mandrill docs for the be set to a ``list`` of ``dict``, where each entry has info for one email address. See the Mandrill docs for the
`messages/send API <https://mandrillapp.com/api/docs/messages.html#method=send>`_ for full details. `messages/send API <https://mandrillapp.com/api/docs/messages.html#method=send>`_ for full details.
@@ -328,7 +330,7 @@ For this example, msg.mandrill_response might look like this::
} }
] ]
If an error is returned by Mandrill while sending the message then ``mandrill_response`` will be set to None. If an error is returned by Mandrill while sending the message then :attr:`!mandrill_response` will be set to None.
.. versionadded:: 0.8 .. versionadded:: 0.8
mandrill_response available for sent messages mandrill_response available for sent messages
@@ -354,7 +356,7 @@ Exceptions
If *all* recipients (to, cc, bcc) of a message are invalid or rejected by Mandrill If *all* recipients (to, cc, bcc) of a message are invalid or rejected by Mandrill
(e.g., because they are your Mandrill blacklist), the send call will raise a (e.g., because they are your Mandrill blacklist), the send call will raise a
:exc:`~!djrill.MandrillRecipientsRefused` exception. :exc:`~!djrill.MandrillRecipientsRefused` exception.
You can examine the message's :ref:`mandrill_response property <mandrill-response>` You can examine the message's :attr:`mandrill_response` attribute
to determine the cause of the error. to determine the cause of the error.
If a single message is sent to multiple recipients, and *any* recipient is valid If a single message is sent to multiple recipients, and *any* recipient is valid