summaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authorNatalia <124304+nessita@users.noreply.github.com>2026-05-28 13:50:28 -0300
committernessita <124304+nessita@users.noreply.github.com>2026-05-29 12:44:59 -0300
commit7711cceea646340e07fcee4cef8245f201b98211 (patch)
treec718b4a4194f402aee870e508a10a6034bc0f89f /docs/ref
parentc0b12e190beacc9b458f40abec7a3f8963ade9fc (diff)
Refs #35514 -- Improved docs for MAILERS setting and mailers migration guide.
Thanks Mike Edmunds for flagging these issues and for the review.
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/settings.txt20
1 files changed, 13 insertions, 7 deletions
diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt
index 38e27d2dc1..4cd1fa7368 100644
--- a/docs/ref/settings.txt
+++ b/docs/ref/settings.txt
@@ -2158,11 +2158,14 @@ configuration process will be skipped.
.. versionadded:: 6.1
-Default: no default until the deprecation ends, then ``{}``.
+.. RemovedInDjango70Warning: Update the default value to be ``{}``.
+
+Default: Not defined
A dictionary containing the settings for all email backends to be used with
Django. It is a nested dictionary that maps backend aliases to dictionaries
containing each mailer's backend import path and configuration options.
+
Example::
MAILERS = {
@@ -2187,16 +2190,19 @@ If you plan to send email through Django, configuring at least a ``"default"``
mailer is recommended. Any number of additional mailers may also be specified.
Depending on which backend is used, other options may be required.
+Setting ``MAILERS`` to an empty dictionary (``{}``) disables email sending and
+any attempt to send mail will raise ``MailerDoesNotExist``.
+
See :ref:`topic-email-configuration` for more information.
.. deprecated:: 6.1
- In Django 7.0, the default value will change to ``{}`` (no defined email
- mailers). Until then, if ``MAILERS`` is not defined in the
- settings, Django will create a ``"default"`` mailer from the
- deprecated :setting:`EMAIL_BACKEND` setting. Projects can opt into the
- Django 7.0 behavior early by adding ``MAILERS`` and removing
- ``EMAIL_BACKEND`` from their settings.
+ In Django 7.0, the default value will change from "Not defined" to ``{}``.
+ Until then, if ``MAILERS`` is not defined in the project's settings, Django
+ will create a ``"default"`` mailer using the :setting:`EMAIL_BACKEND`
+ setting. Projects can opt into the Django 7.0 behavior at any time by
+ adding ``MAILERS`` and removing ``EMAIL_BACKEND`` from their settings. See
+ :ref:`migrating-to-mailers-settings`.
.. setting:: MAILERS-BACKEND