diff options
| author | Malcolm Tredinnick <malcolm.tredinnick@gmail.com> | 2007-04-27 14:25:05 +0000 |
|---|---|---|
| committer | Malcolm Tredinnick <malcolm.tredinnick@gmail.com> | 2007-04-27 14:25:05 +0000 |
| commit | 1c2fdf1ebda1c216fb97337eac48e98ca022be06 (patch) | |
| tree | 11dc77e3a0e0a72ab5b7093094d42d7cc36848e8 | |
| parent | 33ce76978639b6d279c11a1b5e27af6114fc5935 (diff) | |
Fixed #4163 -- Added some "quick notes" documentation about the configuration
variables required to send email. Thanks, Karen Tracey.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@5111 bcc190cf-cafb-0310-a4f2-bffc1f526a37
| -rw-r--r-- | docs/email.txt | 14 | ||||
| -rw-r--r-- | docs/settings.txt | 5 |
2 files changed, 15 insertions, 4 deletions
diff --git a/docs/email.txt b/docs/email.txt index 1f4ce4ef42..cbe909c03c 100644 --- a/docs/email.txt +++ b/docs/email.txt @@ -19,13 +19,23 @@ In two lines:: send_mail('Subject here', 'Here is the message.', 'from@example.com', ['to@example.com'], fail_silently=False) - + +Mail will be sent using the SMTP host and port specified in the `EMAIL_HOST`_ +and `EMAIL_PORT`_ settings. The `EMAIL_HOST_USER`_ and `EMAIL_HOST_PASSWORD`_ +settings, if set, will be used to authenticate to the +SMTP server. + .. note:: The character set of email sent with ``django.core.mail`` will be set to the value of your `DEFAULT_CHARSET setting`_. - + .. _DEFAULT_CHARSET setting: ../settings/#DEFAULT_CHARSET +.. _EMAIL_HOST: ../settings/#EMAIL_HOST +.. _EMAIL_PORT: ../settings/#EMAIL_PORT +.. _EMAIL_HOST_USER: ../settings/#EMAIL_HOST_USER +.. _EMAIL_HOST_PASSWORD: ../settings/#EMAIL_HOST_PASSWORD + send_mail() =========== diff --git a/docs/settings.txt b/docs/settings.txt index 64968efdf4..3b285ac46f 100644 --- a/docs/settings.txt +++ b/docs/settings.txt @@ -395,8 +395,9 @@ EMAIL_HOST_PASSWORD Default: ``''`` (Empty string) -Username to use for the SMTP server defined in ``EMAIL_HOST``. If empty, -Django won't attempt authentication. +Password to use for the SMTP server defined in ``EMAIL_HOST``. This setting is +used in conjunction with EMAIL_HOST_USER when authenticating to the SMTP server. +If either of these settings is empty, Django won't attempt authenticaion. See also ``EMAIL_HOST_USER``. |