diff --git a/README.rst b/README.rst index fabb8c0..15fec84 100644 --- a/README.rst +++ b/README.rst @@ -109,6 +109,16 @@ Actions with folders: for status_key, status_val in mailbox.folder.status('some_folder').items(): print(status_key, status_val) +Fetch params +^^^^^^^^^^^^ + +MailBox.fetch - Mail message generator + +* *search_criteria*: message search criteria (see examples at ./doc/imap_search_criteria.txt) +* *limit*: limit on the number of read emails, useful for actions with a large number of messages, like "move" +* *miss_defect*: miss emails with defects +* *miss_no_uid*: miss emails without uid +* *mark_seen*: mark emails as seen on fetch Reasons ------- @@ -119,6 +129,9 @@ However, these libraries contain various shortcomings, such as: - returned results are not ready to work with them - no convenient tools for working with: directories, letters in directories +Release notes +------------- + `release_notes.rst `_ Thanks to --------- diff --git a/imap_tools/mailbox.py b/imap_tools/mailbox.py index cefc87d..8042893 100644 --- a/imap_tools/mailbox.py +++ b/imap_tools/mailbox.py @@ -97,10 +97,10 @@ def fetch(self, search_criteria: str = 'ALL', limit: int = None, miss_defect=True, miss_no_uid=True, mark_seen=True) -> iter: """ Mail message generator in current folder by search criteria - :param search_criteria: Message search criteria (see examples at ./doc/imap_search_criteria.txt) - :param limit: limit on the number of read emails - :param miss_defect: miss defect emails - :param miss_no_uid: miss emails witout uid + :param search_criteria: message search criteria (see examples at ./doc/imap_search_criteria.txt) + :param limit: limit number of read emails, useful for actions with a large number of messages, like "move" + :param miss_defect: miss emails with defects + :param miss_no_uid: miss emails without uid :param mark_seen: mark emails as seen on fetch :return generator: MailMessage """ diff --git a/release_notes.rst b/release_notes.rst index 879b755..3ad3ea6 100644 --- a/release_notes.rst +++ b/release_notes.rst @@ -15,4 +15,20 @@ * new MailMessage.uid parse logic * functools.lru_cache for MailMessage properties * MailMessage.get_attachments() -> MailMessage.attachments -* fix setuptools \ No newline at end of file +* fix setuptools + +0.4.0 +===== +* fix _decode_value for unknown encoding +* fix _parse_email_address + +0.3.0 +===== +* install_requires +* fix manifest +* add typing lib +* _uid_str works with generator + +0.1.1 +===== +* first version: May 31, 2017