Skip to content

gh-67512: Document parameters of imaplib's append #113506

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
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

gh-67512: Document parameters of imaplib's append #113506

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a2ab3bd
imaplib-append method documented
Rajendra1308 Dec 27, 2023
15f2bdd
Apply suggestions from code review
Rajendra1308 Dec 27, 2023
64a0fc9
formatted-changes
Rajendra1308 Dec 27, 2023
c3b76a3
white-spaces-removed
Rajendra1308 Dec 27, 2023
3359ffd
Apply suggestions from code review
Rajendra1308 Dec 28, 2023
c31d47d
Merge branch 'main' into imaplib-append
hugovk Apr 18, 2025
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
10 changes: 9 additions & 1 deletion Doc/library/imaplib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,15 @@ An :class:`IMAP4` instance has the following methods:

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

Append *message* to named mailbox.
Append *message* to a specified mailbox.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you click "Details" next to the failed lint check, you'll see a "trim trailing whitespace" check failed:

image

So let's delete these bits of trailing whitespace.

*mailbox* ( ``string``): name of the mailbox where the message should be appended

*flags* (list of ``string`` ): The flags parameter is a sequence of flags associated with the message. Flags are used to mark messages with certain attributes or states. Common flags include ``\\Seen`` (marks the message as read), ``\\FlagName`` (custom flags), as (``flags = ["\\Seen", "\\FlagName]``) etc.

*date_time* (``string``): date and time associated with the message. Often of the format *"DD-Mon-YYYY HH:MM:SS" (e.g., "01-Jan-2023 12:00:00")*

*message* (``string``): This parameter is the actual message that you want to append to the specified mailbox. This should be a string representing the entire email message, including headers and body.


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