Permalink
Browse files

Fixed #22455 -- Documented return values for send_mail and send_mass_…

…mail
  • Loading branch information...
mrezk authored and bmispelon committed Apr 16, 2014
1 parent 79f0561 commit 7cd74fc96ee982acfed7a98e76d4623eabde146d
Showing with 5 additions and 0 deletions.
  1. +5 −0 docs/topics/email.txt
View
@@ -71,6 +71,9 @@ are required.
:mimetype:`text/plain` content type and ``html_message`` as the
: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
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'])
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()
--------------------------------

0 comments on commit 7cd74fc

Please sign in to comment.