Doc'd send_email() behavior when from_email is None.

This commit is contained in:
Adrian D'Alessandro 2020-04-28 11:43:47 +01:00 committed by Mariusz Felisiak
parent c226c6cb32
commit 235b681351
2 changed files with 3 additions and 1 deletions

View File

@ -42,6 +42,7 @@ def send_mail(subject, message, from_email, recipient_list,
Easy wrapper for sending a single message to a recipient list. All members
of the recipient list will see the other recipients in the 'To' field.
If from_email is None, use the DEFAULT_FROM_EMAIL setting.
If auth_user is None, use the EMAIL_HOST_USER setting.
If auth_password is None, use the EMAIL_HOST_PASSWORD setting.

View File

@ -51,7 +51,8 @@ are required.
* ``subject``: A string.
* ``message``: A string.
* ``from_email``: A string.
* ``from_email``: A string. If ``None``, Django will use the value of the
:setting:`DEFAULT_FROM_EMAIL` setting.
* ``recipient_list``: A list of strings, each an email address. Each
member of ``recipient_list`` will see the other recipients in the "To:"
field of the email message.