]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-124864: Extends smtplib documentation on ESMTP options format (#132547)
authorPatrick R <codeZeilen@users.noreply.github.com>
Tue, 16 Dec 2025 11:21:38 +0000 (12:21 +0100)
committerGitHub <noreply@github.com>
Tue, 16 Dec 2025 11:21:38 +0000 (13:21 +0200)
Doc/library/smtplib.rst

index 3ee8b82a1880f38937e29f1c1877a1de9789c5c8..3bf5ec6099facb6131cd52df158af5f9d16c4549 100644 (file)
@@ -458,9 +458,11 @@ An :class:`SMTP` instance has the following methods:
    Send mail.  The required arguments are an :rfc:`822` from-address string, a list
    of :rfc:`822` to-address strings (a bare string will be treated as a list with 1
    address), and a message string.  The caller may pass a list of ESMTP options
-   (such as ``8bitmime``) to be used in ``MAIL FROM`` commands as *mail_options*.
+   (such as ``"8bitmime"``) to be used in ``MAIL FROM`` commands as *mail_options*.
    ESMTP options (such as ``DSN`` commands) that should be used with all ``RCPT``
-   commands can be passed as *rcpt_options*.  (If you need to use different ESMTP
+   commands can be passed as *rcpt_options*. Each option should be passed as a string
+   containing the full text of the option, including any potential key
+   (for instance, ``"NOTIFY=SUCCESS,FAILURE"``). (If you need to use different ESMTP
    options to different recipients you have to use the low-level methods such as
    :meth:`!mail`, :meth:`!rcpt` and :meth:`!data` to send the message.)