diff options
| author | Mike Edmunds <medmunds@gmail.com> | 2024-10-28 12:54:20 -0700 |
|---|---|---|
| committer | Sarah Boyce <42296566+sarahboyce@users.noreply.github.com> | 2024-10-30 11:20:52 +0100 |
| commit | 17c8ee7e3f7bf400128281b4fb283d7c209ca02b (patch) | |
| tree | 7342709cb6584332bc1309f57a81bd6dce732279 /docs | |
| parent | 8f3dee1dfdc4242348c6cd6ead1c359cda78c2b5 (diff) | |
Fixed #35864 -- Documented EmailMessage.connection is ignored when using send_messages().
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/topics/email.txt | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/docs/topics/email.txt b/docs/topics/email.txt index 150e25958e..74468063b8 100644 --- a/docs/topics/email.txt +++ b/docs/topics/email.txt @@ -311,9 +311,11 @@ All parameters are optional and can be set at any time prior to calling the * ``bcc``: A list or tuple of addresses used in the "Bcc" header when sending the email. -* ``connection``: An email backend instance. Use this parameter if - you want to use the same connection for multiple messages. If omitted, a - new connection is created when ``send()`` is called. +* ``connection``: An :ref:`email backend <topic-email-backends>` instance. Use + this parameter if you are sending the ``EmailMessage`` via ``send()`` and you + want to use the same connection for multiple messages. If omitted, a new + connection is created when ``send()`` is called. This parameter is ignored + when using :ref:`send_messages() <topics-sending-multiple-emails>`. * ``attachments``: A list of attachments to put on the message. These can be instances of :class:`~email.mime.base.MIMEBase` or @@ -728,9 +730,10 @@ destroying a connection every time you want to send an email. There are two ways you tell an email backend to reuse a connection. -Firstly, you can use the ``send_messages()`` method. ``send_messages()`` takes -a list of :class:`~django.core.mail.EmailMessage` instances (or subclasses), -and sends them all using a single connection. +Firstly, you can use the ``send_messages()`` method on a connection. This takes +a list of :class:`EmailMessage` (or subclass) instances, and sends them all +using that single connection. As a consequence, any :class:`connection +<EmailMessage>` set on an individual message is ignored. For example, if you have a function called ``get_notification_email()`` that returns a list of :class:`~django.core.mail.EmailMessage` objects representing |