Skip to content

Commit 15f2bdd

Browse files
Rajendra1308hugovk
andauthored
Apply suggestions from code review
Co-authored-by: Hugo van Kemenade <[email protected]>
1 parent a2ab3bd commit 15f2bdd

File tree

1 file changed

+18
-7
lines changed

1 file changed

+18
-7
lines changed

Doc/library/imaplib.rst

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

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

207-
Append *message* to a specified mailbox.
207+
Append *message* to a named *mailbox*.
208208

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.
209+
*flags* is a space-separated string containing IMAP flags tokens.
210+
Must start with ``\``.
212211

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.
212+
System flags defined in :rfc:`3501` are:
213+
214+
* ``\Seen`` - Message has been read.
215+
* ``\Answered`` - Message has been answered.
216+
* ``\Flagged`` - Message is "flagged" for urgent/special attention.
217+
* ``\Deleted`` - Message is "deleted" for removal by later ``EXPUNGE``.
218+
* ``\Draft`` - Message has not completed composition (marked as a draft).
219+
* ``\Recent`` - Message is "recently" arrived in this mailbox.
220+
221+
222+
*date_time* is the date and time associated with the message.
223+
Often of the format *"DD-Mon-YYYY HH:MM:SS" (e.g., "01-Jan-2023 12:00:00")*.
224+
225+
*message* is a string representing the entire email message, including
226+
headers and body.
216227

217228

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

0 commit comments

Comments
 (0)