Skip to content

Commit 5a79a09

Browse files
medmundsnessita
authored andcommitted
Refs #35514 -- Moved get_connection() after backends in email docs.
Moved "Obtaining an instance of an email backend" after documentation for individual backends (matching similar approach in Tasks docs).
1 parent 4593ae9 commit 5a79a09

1 file changed

Lines changed: 23 additions & 23 deletions

File tree

docs/topics/email.txt

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -688,34 +688,11 @@ It can also be used as a context manager, which will automatically call
688688
connection=connection,
689689
).send()
690690

691-
Obtaining an instance of an email backend
692-
-----------------------------------------
693-
694-
The :func:`get_connection` function in ``django.core.mail`` returns an
695-
instance of the email backend that you can use.
696-
697-
.. function:: get_connection(backend=None, *, fail_silently=False, **kwargs)
698-
699-
By default, a call to ``get_connection()`` will return an instance of the
700-
email backend specified in :setting:`EMAIL_BACKEND`. If you specify the
701-
``backend`` argument, an instance of that backend will be instantiated.
702-
703-
The keyword-only ``fail_silently`` argument controls how the backend should
704-
handle errors. If ``fail_silently`` is True, exceptions during the email
705-
sending process will be silently ignored.
706-
707-
All other keyword arguments are passed directly to the constructor of the
708-
email backend.
709-
710691
Django ships with several email sending backends. With the exception of the
711692
SMTP backend (which is the default), these backends are only useful during
712693
testing and development. If you have special email sending requirements, you
713694
can :ref:`write your own email backend <topic-custom-email-backend>`.
714695

715-
.. deprecated:: 6.0
716-
717-
Passing ``fail_silently`` as positional argument is deprecated.
718-
719696
.. _topic-email-smtp-backend:
720697

721698
SMTP backend
@@ -844,6 +821,29 @@ delivered messages. If your backend has any concept of a persistent session or
844821
connection, you should also implement the ``open()`` and ``close()`` methods.
845822
Refer to ``smtp.EmailBackend`` for a reference implementation.
846823

824+
Obtaining an instance of an email backend
825+
-----------------------------------------
826+
827+
The :func:`get_connection` function in ``django.core.mail`` returns an
828+
instance of the email backend that you can use.
829+
830+
.. function:: get_connection(backend=None, *, fail_silently=False, **kwargs)
831+
832+
By default, a call to ``get_connection()`` will return an instance of the
833+
email backend specified in :setting:`EMAIL_BACKEND`. If you specify the
834+
``backend`` argument, an instance of that backend will be instantiated.
835+
836+
The keyword-only ``fail_silently`` argument controls how the backend should
837+
handle errors. If ``fail_silently`` is True, exceptions during the email
838+
sending process will be silently ignored.
839+
840+
All other keyword arguments are passed directly to the constructor of the
841+
email backend.
842+
843+
.. deprecated:: 6.0
844+
845+
Passing ``fail_silently`` as positional argument is deprecated.
846+
847847
.. _topics-sending-multiple-emails:
848848

849849
Sending multiple emails

0 commit comments

Comments
 (0)