summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMariano Rezk <marian@streema.com>2014-04-16 15:03:25 -0400
committerBaptiste Mispelon <bmispelon@gmail.com>2014-04-16 17:35:17 -0400
commit7cd74fc96ee982acfed7a98e76d4623eabde146d (patch)
tree67dbc94ebcb92352434cdab20c448d0554679305 /docs
parent79f05616fbf48cf7c205ef17666af0c3d47b3c1e (diff)
Fixed #22455 -- Documented return values for send_mail and send_mass_mail
Diffstat (limited to 'docs')
-rw-r--r--docs/topics/email.txt5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/topics/email.txt b/docs/topics/email.txt
index becf652739..2bc2f69cd2 100644
--- a/docs/topics/email.txt
+++ b/docs/topics/email.txt
@@ -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()
--------------------------------