Skip to content

Commit 5802799

Browse files
authored
gh-124864: Extends smtplib documentation on ESMTP options format (#132547)
1 parent a44509e commit 5802799

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

Doc/library/smtplib.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -458,9 +458,11 @@ An :class:`SMTP` instance has the following methods:
458458
Send mail. The required arguments are an :rfc:`822` from-address string, a list
459459
of :rfc:`822` to-address strings (a bare string will be treated as a list with 1
460460
address), and a message string. The caller may pass a list of ESMTP options
461-
(such as ``8bitmime``) to be used in ``MAIL FROM`` commands as *mail_options*.
461+
(such as ``"8bitmime"``) to be used in ``MAIL FROM`` commands as *mail_options*.
462462
ESMTP options (such as ``DSN`` commands) that should be used with all ``RCPT``
463-
commands can be passed as *rcpt_options*. (If you need to use different ESMTP
463+
commands can be passed as *rcpt_options*. Each option should be passed as a string
464+
containing the full text of the option, including any potential key
465+
(for instance, ``"NOTIFY=SUCCESS,FAILURE"``). (If you need to use different ESMTP
464466
options to different recipients you have to use the low-level methods such as
465467
:meth:`!mail`, :meth:`!rcpt` and :meth:`!data` to send the message.)
466468

0 commit comments

Comments
 (0)