Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions django/core/checks/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import django.core.checks.compatibility.django_4_0 # NOQA isort:skip
import django.core.checks.database # NOQA isort:skip
import django.core.checks.files # NOQA isort:skip
import django.core.checks.mail # NOQA isort:skip
import django.core.checks.model_checks # NOQA isort:skip
import django.core.checks.security.base # NOQA isort:skip
import django.core.checks.security.csrf # NOQA isort:skip
Expand Down
29 changes: 29 additions & 0 deletions django/core/checks/mail.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
from django.conf import settings
from django.core.checks import Tags, Warning, register
from django.core.mail import DEFAULT_MAILER_ALIAS


@register(Tags.mail)
def check_mailers_default_alias(app_configs, **kwargs):
if not settings.is_overridden("MAILERS"):
return []

if DEFAULT_MAILER_ALIAS in settings.MAILERS:
return []

if settings.MAILERS:
hint = (
f"Add a '{DEFAULT_MAILER_ALIAS}' entry to MAILERS, or pass 'using' when "
"sending email."
)
else:
hint = f"Add a '{DEFAULT_MAILER_ALIAS}' entry to MAILERS."

return [
Warning(
f"Your MAILERS setting has no '{DEFAULT_MAILER_ALIAS}' entry. Sending "
"email without a valid mailer will fail.",
hint=hint,
id="mail.W001",
)
]
1 change: 1 addition & 0 deletions django/core/checks/registry.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ class Tags:
compatibility = "compatibility"
database = "database"
files = "files"
mail = "mail"
models = "models"
security = "security"
signals = "signals"
Expand Down
10 changes: 10 additions & 0 deletions docs/ref/checks.txt
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ Django's system checks are organized using the following tags:
or if you specify configured database aliases using the ``--database`` option
when calling the :djadmin:`check` command.
* ``files``: Checks files related configuration.
* ``mail``: Checks email related configuration.
* ``models``: Checks of model, field, and manager definitions.
* ``security``: Checks security related configuration.
* ``signals``: Checks on signal declarations and handler registrations.
Expand Down Expand Up @@ -151,6 +152,15 @@ If you're using MySQL or MariaDB, the following checks will be performed:
* **mysql.W003**: MySQL/MariaDB may not allow unique ``CharField``\s to have a
``max_length`` > 255.

Mail
----

The following checks verify that your :setting:`MAILERS` setting is correctly
configured:

* **mail.W001**: Your :setting:`MAILERS` setting has no ``'default'`` entry.
Sending email without a valid mailer will fail.

Managing files
--------------

Expand Down
6 changes: 6 additions & 0 deletions docs/releases/6.1.txt
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,12 @@ CSP
:func:`~django.template.context_processors.csp` context processor is
configured. See :ref:`csp-nonce-config` for setup instructions.

Email
~~~~~

* A new ``mail.W001`` system check warns when :setting:`MAILERS` is defined but
does not include a ``'default'`` entry.

Forms
~~~~~

Expand Down
55 changes: 55 additions & 0 deletions tests/check_framework/test_mail.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
from django.core.checks import Warning
from django.core.checks.mail import check_mailers_default_alias
from django.test import SimpleTestCase, override_settings


class MailersDefaultAliasCheckTests(SimpleTestCase):
def test_mailers_not_defined(self):
self.assertEqual(check_mailers_default_alias(None), [])

@override_settings(
MAILERS={
"default": {
"BACKEND": "django.core.mail.backends.smtp.EmailBackend",
}
}
)
def test_mailers_default_alias_configured(self):
self.assertEqual(check_mailers_default_alias(None), [])

@override_settings(MAILERS={})
def test_mailers_empty(self):
self.assertEqual(
check_mailers_default_alias(None),
[
Warning(
"Your MAILERS setting has no 'default' entry. Sending email "
"without a valid mailer will fail.",
hint="Add a 'default' entry to MAILERS.",
id="mail.W001",
)
],
)

@override_settings(
MAILERS={
"secondary": {
"BACKEND": "django.core.mail.backends.smtp.EmailBackend",
}
}
)
def test_mailers_without_default_alias(self):
self.assertEqual(
check_mailers_default_alias(None),
[
Warning(
"Your MAILERS setting has no 'default' entry. Sending email "
"without a valid mailer will fail.",
hint=(
"Add a 'default' entry to MAILERS, or pass 'using' when "
"sending email."
),
id="mail.W001",
)
],
)
Loading