Skip to content

gh-149962: Clarify IMAP4.append() argument handling #149964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
savagemechanic wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −2
Open

gh-149962: Clarify IMAP4.append() argument handling #149964

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions Doc/library/imaplib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,13 +197,18 @@ An :class:`IMAP4` instance has the following methods:

.. method:: IMAP4.append(mailbox, flags, date_time, message)

Append *message* to named mailbox.
Append *message* to named mailbox. *message* must be a
:term:`bytes-like object` and is passed as an IMAP4 literal. If *mailbox*
is ``None`` or empty, ``'INBOX'`` is used.

*flags* may be ``None`` or a string of IMAP flag tokens. Multiple
flags are separated by spaces, for example ``r'\Seen \Answered'``.
If *flags* is not already enclosed in parentheses, parentheses are
added automatically.

*date_time* may be ``None`` to omit the ``INTERNALDATE`` argument.
Otherwise, *date_time* is converted with :func:`Time2Internaldate`.


.. method:: IMAP4.authenticate(mechanism, authobject)

Expand Down Expand Up @@ -729,4 +734,3 @@ retrieves and prints all messages::
print('Message %s\n%s\n' % (num, data[0][1]))
M.close()
M.logout()

Loading