Skip to content

Commit a2ab3bd

Browse files
committed
imaplib-append method documented
1 parent af2b8f6 commit a2ab3bd

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

Doc/library/imaplib.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,15 @@ An :class:`IMAP4` instance has the following methods:
204204

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

207-
Append *message* to named mailbox.
207+
Append *message* to a specified mailbox.
208+
209+
*mailbox* ( ``string``): name of the mailbox where the message should be appended
210+
211+
*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.
212+
213+
*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")*
214+
215+
*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.
208216

209217

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

0 commit comments

Comments
 (0)