summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMike Edmunds <medmunds@gmail.com>2026-04-07 15:11:17 -0700
committernessita <124304+nessita@users.noreply.github.com>2026-04-16 15:39:03 -0300
commit5a0c099140c60dbc1bafb454e148e6ac75417db8 (patch)
tree2ec1c70cf4a823ca7a364d0a7347033397193c7c /docs
parent8bb01b1b11ee771dedf30c6ff9452a1699810016 (diff)
Refs #35514 -- Added "Configuring email" section to email docs.
Diffstat (limited to 'docs')
-rw-r--r--docs/topics/email.txt27
1 files changed, 26 insertions, 1 deletions
diff --git a/docs/topics/email.txt b/docs/topics/email.txt
index 0af0bf073d..9294033ec8 100644
--- a/docs/topics/email.txt
+++ b/docs/topics/email.txt
@@ -60,13 +60,38 @@ specific template and custom headers, you can use the following approach::
msg.attach_alternative(html_content, "text/html")
msg.send()
-Mail is sent using the SMTP host and port specified in the
+.. _topic-email-configuration:
+
+Configuring email
+=================
+
+By default, Django tries to send email by connecting to an `SMTP`_ server
+running on localhost, with no authentication. If that doesn't match your
+production environment, trying to send email will raise an error like
+``connection refused`` or ``authentication failed``, or cause a connection
+timeout. You will need to adjust Django's email settings to reflect your
+environment.
+
+Django abstracts the email sending process into an :ref:`email backend
+<topic-email-backends>` class. The :setting:`EMAIL_BACKEND` setting controls
+which backend Django uses.
+
+The default email backend is Django's :ref:`topic-email-smtp-backend`, which
+connects to an SMTP server using the host and port specified in the
:setting:`EMAIL_HOST` and :setting:`EMAIL_PORT` settings. The
:setting:`EMAIL_HOST_USER` and :setting:`EMAIL_HOST_PASSWORD` settings, if
set, are used to authenticate to the SMTP server, and the
:setting:`EMAIL_USE_TLS` and :setting:`EMAIL_USE_SSL` settings control whether
a secure connection is used.
+SMTP is supported by nearly all email service providers (ESPs) and many hosting
+environments. But there are other options: many commercial ESPs offer HTTP APIs
+with additional sending features, and during development or testing you might
+not want to send email at all. :ref:`topic-email-backends` lists several
+possibilities.
+
+.. _SMTP: https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol
+
.. _topic-email-sending:
Sending messages