diff options
| author | Tim Graham <timograham@gmail.com> | 2015-04-20 15:46:31 -0400 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2015-04-20 15:47:07 -0400 |
| commit | 43f800a978deba4bc8d13e7f11e0afdc126cec25 (patch) | |
| tree | 957e4eead8b094deae2e265d32308d1877362426 | |
| parent | beb957041cd8c4d4badda58df1ed4d9729d9672c (diff) | |
[1.8.x] Fixed #24659 -- Clarified docs of smtp.EmailBackend parameters.
Backport of ffe83d16bd0abfa58e4448cf9d48b52cc43544e9 from master
| -rw-r--r-- | docs/topics/email.txt | 19 |
1 files changed, 13 insertions, 6 deletions
diff --git a/docs/topics/email.txt b/docs/topics/email.txt index aabe66085e..1b7059ccea 100644 --- a/docs/topics/email.txt +++ b/docs/topics/email.txt @@ -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]) 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:: |