Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ikvk committed Aug 12, 2021
1 parent eaf9931 commit 38a5aa1
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,12 +67,16 @@ BaseMailBox.fetch - first searches email nums by criteria in current folder, the
* *headers_only* = False, get only email headers (without text, html, attachments)
* *bulk* = False, False - fetch each message separately per N commands - low memory consumption, slow; True - fetch all messages per 1 command - high memory consumption, fast

BaseMailBox.uids - search mailbox for matching message uids in current folder

* *criteria* = 'ALL', message search criteria (see examples at ./doc/imap_search_criteria.txt)
* *charset* = 'US-ASCII', IANA charset, indicates charset of the strings that appear in the search criteria. See rfc2978
* *miss_no_uid* = True, add None values to result when uid item not matched to pattern

BaseMailBox.<action> - `copy, move, delete, flag, append <#actions-with-emails>`_

BaseMailBox.folder - `folder manager <#actions-with-folders>`_

BaseMailBox.uids - search mailbox for matching message uids in current folder

BaseMailBox.numbers - search mailbox for matching message numbers in current folder

BaseMailBox.box - imaplib.IMAP4/IMAP4_SSL client instance.
Expand Down

0 comments on commit 38a5aa1

Please sign in to comment.