[1.7.x] Fixed #22455 -- Documented return values for send_mail and send_mass_mail

Backport of 7cd74fc96e from master.
This commit is contained in:
Mariano Rezk 2014-04-16 15:03:25 -04:00 committed by Baptiste Mispelon
parent 71c8ae543f
commit 841e21a85c
1 changed files with 5 additions and 0 deletions

View File

@ -71,6 +71,9 @@ are required.
:mimetype:`text/plain` content type and ``html_message`` as the :mimetype:`text/plain` content type and ``html_message`` as the
:mimetype:`text/html` content type. :mimetype:`text/html` content type.
The return value will be the number of successfully delivered messages (which
can be ``0`` or ``1`` since it can only send one message).
.. versionadded:: 1.7 .. versionadded:: 1.7
The ``html_message`` parameter was added. The ``html_message`` parameter was added.
@ -102,6 +105,8 @@ mail server would be opened::
message2 = ('Another Subject', 'Here is another message', 'from@example.com', ['second@test.com']) message2 = ('Another Subject', 'Here is another message', 'from@example.com', ['second@test.com'])
send_mass_mail((message1, message2), fail_silently=False) send_mass_mail((message1, message2), fail_silently=False)
The return value will be the number of successfully delivered messages.
send_mass_mail() vs. send_mail() send_mass_mail() vs. send_mail()
-------------------------------- --------------------------------