Skip to content

Commit 86cea41

Browse files
medmundsnessita
authored andcommitted
Refs #35514 -- Corrected email backends' outline levels in email docs.
Moved documentation section for each email backend to be a direct child of "Email backends" (rather than subsections of "Obtaining an instance of an email backend"). Added a section header for "Third-party backends" to surface it in the outline and separate it from "Dummy backend."
1 parent 8f36420 commit 86cea41

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

docs/topics/email.txt

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -719,7 +719,7 @@ can :ref:`write your own email backend <topic-custom-email-backend>`.
719719
.. _topic-email-smtp-backend:
720720

721721
SMTP backend
722-
~~~~~~~~~~~~
722+
------------
723723

724724
.. class:: backends.smtp.EmailBackend(host=None, port=None, username=None, password=None, use_tls=None, fail_silently=False, use_ssl=None, timeout=None, ssl_keyfile=None, ssl_certfile=None, **kwargs)
725725

@@ -749,7 +749,7 @@ SMTP backend
749749
.. _topic-email-console-backend:
750750

751751
Console backend
752-
~~~~~~~~~~~~~~~
752+
---------------
753753

754754
Instead of sending out real emails the console backend just writes the
755755
emails that would be sent to the standard output. By default, the console
@@ -766,7 +766,7 @@ convenience that can be used during development.
766766
.. _topic-email-file-backend:
767767

768768
File backend
769-
~~~~~~~~~~~~
769+
------------
770770

771771
The file backend writes emails to a file. A new file is created for each new
772772
session that is opened on this backend. The directory to which the files are
@@ -784,7 +784,7 @@ convenience that can be used during development.
784784
.. _topic-email-memory-backend:
785785

786786
In-memory backend
787-
~~~~~~~~~~~~~~~~~
787+
-----------------
788788

789789
The ``'locmem'`` backend stores messages in a special attribute of the
790790
``django.core.mail`` module. The ``outbox`` attribute is created when the first
@@ -804,7 +804,7 @@ Django's test runner :ref:`automatically uses this backend for testing
804804
.. _topic-email-dummy-backend:
805805

806806
Dummy backend
807-
~~~~~~~~~~~~~
807+
-------------
808808

809809
As the name suggests the dummy backend does nothing with your messages. To
810810
specify this backend, put the following in your settings::
@@ -814,6 +814,9 @@ specify this backend, put the following in your settings::
814814
This backend is not intended for use in production -- it is provided as a
815815
convenience that can be used during development.
816816

817+
Third-party backends
818+
--------------------
819+
817820
.. admonition:: There are community-maintained solutions too!
818821

819822
Django has a vibrant ecosystem. There are email backends

0 commit comments

Comments
 (0)