Skip to content

Commit 8150abb

Browse files
[3.14] gh-124864: Extends smtplib documentation on ESMTP options format (GH-132547) (#142796)
Co-authored-by: Patrick R <[email protected]>
1 parent c31ea74 commit 8150abb

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
@@ -440,9 +440,11 @@ An :class:`SMTP` instance has the following methods:
440440
Send mail. The required arguments are an :rfc:`822` from-address string, a list
441441
of :rfc:`822` to-address strings (a bare string will be treated as a list with 1
442442
address), and a message string. The caller may pass a list of ESMTP options
443-
(such as ``8bitmime``) to be used in ``MAIL FROM`` commands as *mail_options*.
443+
(such as ``"8bitmime"``) to be used in ``MAIL FROM`` commands as *mail_options*.
444444
ESMTP options (such as ``DSN`` commands) that should be used with all ``RCPT``
445-
commands can be passed as *rcpt_options*. (If you need to use different ESMTP
445+
commands can be passed as *rcpt_options*. Each option should be passed as a string
446+
containing the full text of the option, including any potential key
447+
(for instance, ``"NOTIFY=SUCCESS,FAILURE"``). (If you need to use different ESMTP
446448
options to different recipients you have to use the low-level methods such as
447449
:meth:`!mail`, :meth:`!rcpt` and :meth:`!data` to send the message.)
448450

0 commit comments

Comments
 (0)