innov
/
django1
1
0
Fork 0
Code Issues Pull Requests 1 Projects Releases Wiki Activity

[1.8.x] Fixed #24659 -- Clarified docs of smtp.EmailBackend parameters. 

Backport of ffe83d16bd from master
This commit is contained in:
Tim Graham 2015-04-20 15:46:31 -04:00
parent beb957041c
commit 43f800a978
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

@ -456,12 +456,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]) .. 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. 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`, The value for each argument is retrieved from the matching setting if the
:setting:`EMAIL_HOST_PASSWORD`, :setting:`EMAIL_USE_TLS`, argument is ``None``:
:setting:`EMAIL_USE_SSL`, :setting:`EMAIL_TIMEOUT`,
:setting:`EMAIL_SSL_CERTFILE` and :setting:`EMAIL_SSL_KEYFILE` settings * ``host``: :setting:`EMAIL_HOST`
in your settings file. * ``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 The SMTP backend is the default configuration inherited by Django. If you
want to specify it explicitly, put the following in your settings:: want to specify it explicitly, put the following in your settings::