p31829507
/
django
mirror of https://github.com/django/django.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fixed #24659 -- Clarified docs of smtp.EmailBackend parameters.

This commit is contained in:
Tim Graham 2015-04-20 15:46:31 -04:00
parent 37e23c6060
commit ffe83d16bd
1 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/topics/email.txt
View File

@ -450,12 +450,19 @@ SMTP backend
.. class:: backends.smtp.EmailBackend([host=None, port=None, username=None, password=None, use_tls=None, fail_silently=False, use_ssl=None, timeout=None, ssl_keyfile=None, ssl_certfile=None, **kwargs])
This is the default backend. Email will be sent through a SMTP server.
The server address and authentication credentials are set in the
:setting:`EMAIL_HOST`, :setting:`EMAIL_PORT`, :setting:`EMAIL_HOST_USER`,
:setting:`EMAIL_HOST_PASSWORD`, :setting:`EMAIL_USE_TLS`,
:setting:`EMAIL_USE_SSL`, :setting:`EMAIL_TIMEOUT`,
:setting:`EMAIL_SSL_CERTFILE` and :setting:`EMAIL_SSL_KEYFILE` settings
in your settings file.
The value for each argument is retrieved from the matching setting if the
argument is ``None``:
* ``host``: :setting:`EMAIL_HOST`
* ``port``: :setting:`EMAIL_PORT`
* ``username``: :setting:`EMAIL_HOST_USER`
* ``password``: :setting:`EMAIL_HOST_PASSWORD`
* ``use_tls``: :setting:`EMAIL_USE_TLS`
* ``use_ssl``: :setting:`EMAIL_USE_SSL`
* ``timeout``: :setting:`EMAIL_TIMEOUT`
* ``ssl_keyfile``: :setting:`EMAIL_SSL_KEYFILE`
* ``ssl_certfile``: :setting:`EMAIL_SSL_CERTFILE`
The SMTP backend is the default configuration inherited by Django. If you
want to specify it explicitly, put the following in your settings::