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:46:31 -0400 |
| commit | ffe83d16bd0abfa58e4448cf9d48b52cc43544e9 (patch) | |
| tree | d402f10b29fb38da81b4683c829380ce3fd3f23c /docs | |
| parent | 37e23c606031d5b34197e196fb6e6fed0137bb37 (diff) | |
Fixed #24659 -- Clarified docs of smtp.EmailBackend parameters.
Diffstat (limited to 'docs')
| -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 841b08607b..2b92e0b9fa 100644 --- a/docs/topics/email.txt +++ b/docs/topics/email.txt @@ -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:: |
