Skip to content

Commit 0293f9a

Browse files
committed
Extends smtplib documentation to explicitly state how ESMTP options are to be passed
1 parent e10fe81 commit 0293f9a

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

0 commit comments

Comments
 (0)