Opened 5 years ago
Last modified 5 years ago
#32471 closed Cleanup/optimization
Document the return value of EmailMessage.send() — at Initial Version
| Reported by: | Baptiste Mispelon | Owned by: | nobody |
|---|---|---|---|
| Component: | Documentation | Version: | dev |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Accepted | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | yes | UI/UX: | no |
Description
The documentation for EmailMessage.send() [1] currently reads:
send(fail_silently=False) sends the message. If a connection was specified when the email was constructed, that connection will be used. Otherwise, an instance of the default backend will be instantiated and used. If the keyword argument fail_silently is True, exceptions raised while sending the message will be quashed. An empty list of recipients will not raise an exception.
As a reference doc, it would be more useful if it also mentioned the return value of that method.
There are two documented hints as to what the return value might be:
- The documentation for
send_mail()[2]:The return value will be the number of successfully delivered messages (which can be 0 or 1 since it can only send one message).
- The documentation for writing custom backends [3]:
A custom email backend must implement the send_messages(email_messages) method [which] returns the number of successfully delivered messages.
[1] https://docs.djangoproject.com/en/dev/topics/email/#emailmessage-objects
[2] https://docs.djangoproject.com/en/dev/topics/email/#send-mail
[3] https://docs.djangoproject.com/en/dev/topics/email/#defining-a-custom-email-backend