diff options
| author | Mariano Rezk <marian@streema.com> | 2014-04-16 15:03:25 -0400 |
|---|---|---|
| committer | Baptiste Mispelon <bmispelon@gmail.com> | 2014-04-16 17:38:22 -0400 |
| commit | 841e21a85c17c87f8b7b41b5cbb5eae15888f9b7 (patch) | |
| tree | 120b261282a88ae9713f74f8c3a02b972b8f9000 | |
| parent | 71c8ae543ffec847ec275859bc406202f5029604 (diff) | |
[1.7.x] Fixed #22455 -- Documented return values for send_mail and send_mass_mail
Backport of 7cd74fc96ee982acfed7a98e76d4623eabde146d from master.
| -rw-r--r-- | docs/topics/email.txt | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/topics/email.txt b/docs/topics/email.txt index 84c108876d..c719873bc9 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() -------------------------------- |