Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Fixed #4163 -- Added some "quick notes" documentation about the confi…

…guration

variables required to send email. Thanks, Karen Tracey.


git-svn-id: http://code.djangoproject.com/svn/django/trunk@5111 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit 1c2fdf1ebda1c216fb97337eac48e98ca022be06 1 parent 33ce769
@malcolmt malcolmt authored
Showing with 15 additions and 4 deletions.
  1. +12 −2 docs/email.txt
  2. +3 −2 docs/settings.txt
View
14 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()
===========
View
5 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``.
Please sign in to comment.
Something went wrong with that request. Please try again.