BaseMailBox.fetch headers_only arg fixed

README.rst

@@ -45,10 +45,12 @@ Basic
     subjects = [msg.subject for msg in mailbox.fetch(AND(all=True))]
     mailbox.logout()
 
-MailBox/MailBoxUnencrypted - for create mailbox instance.
+MailBox, MailBoxUnencrypted - for create mailbox instance.
 
 MailBox.box - imaplib.IMAP4/IMAP4_SSL client instance.
 
+MailBox.login - authentication function
+
 MailBox.fetch - email message generator, first searches email ids by criteria, then fetch and yields emails by one:
 
 * *criteria* = 'ALL', message search criteria, `docs <#search-criteria>`_
@@ -58,7 +60,7 @@ MailBox.fetch - email message generator, first searches email ids by criteria, t
 * *miss_no_uid* = True, miss emails without uid
 * *mark_seen* = True, mark emails as seen on fetch
 * *reverse* = False, in order from the larger date to the smaller
-* *headers_only* = False, get only email headers (without text, html, attachments) !disabled until fix bug
+* *headers_only* = False, get only email headers (without text, html, attachments)
 
 Email attributes
 ^^^^^^^^^^^^^^^^
@@ -137,7 +139,7 @@ Header  H      for search by headers                      name: str, value: str
     # complex
     A(OR(from_='[email protected]', text='"the text"'), NOT(OR(A(answered=False), A(new=True))), to='[email protected]')
     # encoding
-    mailbox.fetch(A(subject='привет'), charset='utf8')  # 'привет' will be encoded by MailBox._criteria_encoder
+    mailbox.fetch(A(subject='привет'), charset='utf8')
     # python note: you can't do: A(text='two', NOT(subject='one'))
     A(NOT(subject='one'), text='two')  # use kwargs after logic classes (args)
 
@@ -248,7 +250,7 @@ Custom lib exceptions here: `errors.py <https://github.com/ikvk/imap_tools/blob/
 Release notes
 -------------
 
-History of important changes: `release_notes.rst <https://github.com/ikvk/imap_tools/blob/master/release_notes.rst>`_
+History of important changes: `release_notes.rst <https://github.com/ikvk/imap_tools/blob/master/docs/release_notes.rst>`_
 
 Contribute
 ----------

release_notes.rst → docs/release_notes.rst

@@ -1,3 +1,7 @@
+0.20.0
+======
+* BaseMailBox.fetch headers_only arg fixed
+
 0.19.1
 ======
 * Importing all from utils module removed from the default package imports

docs/todo.txt

@@ -1,5 +1,3 @@
 check https://docs.python.org/release/3.8.1/library/email.utils.html
 
-fix BaseMailBox.fetch headers_only
-
-__getitem__ -> https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.get_all
+__getitem__ -> https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.get_all ?

imap_tools/mailbox.py

@@ -1,4 +1,5 @@
 import imaplib
+from email.errors import StartBoundaryNotFoundDefect, MultipartInvariantViolationDefect
 
 from .message import MailMessage, MailMessageFlags
 from .folder import MailBoxFolderManager
@@ -15,6 +16,7 @@ class BaseMailBox:
 
     email_message_class = MailMessage
     folder_manager_class = MailBoxFolderManager
+    with_headers_only_allowed_errors = (StartBoundaryNotFoundDefect, MultipartInvariantViolationDefect)
 
     def __init__(self):
         self.folder = None  # folder manager
@@ -56,8 +58,6 @@ def fetch(self, criteria: str or bytes = 'ALL', charset: str = 'US-ASCII', limit
         :param headers_only: get only email headers (without text, html, attachments)
         :return generator: MailMessage
         """
-        if headers_only:
-            raise NotImplementedError('headers_only does not work correctly and is disabled until fix, *you may help')
         search_result = self.box.search(charset, self._criteria_encoder(criteria, charset))
         check_command_status(search_result, MailboxSearchError)
         # first element is string with email numbers through the gap
@@ -71,7 +71,11 @@ def fetch(self, criteria: str or bytes = 'ALL', charset: str = 'US-ASCII', limit
             check_command_status(fetch_result, MailboxFetchError)
             mail_message = self.email_message_class(fetch_result[1])
             if miss_defect and mail_message.obj.defects:
-                continue
+                if headers_only:
+                    if not all(d.__class__ in self.with_headers_only_allowed_errors for d in mail_message.obj.defects):
+                        continue
+                else:
+                    continue
             if miss_no_uid and not mail_message.uid:
                 continue
             yield mail_message

tests/test_message.py

@@ -13,16 +13,17 @@ def test_live(self):
         none_type = type(None)
         for mailbox in self.mailbox_set.values():
             mailbox.folder.set(mailbox.folder_test_base)
+
             # headers_only
-            # cnt_fetch_head = 0
-            # cnt_fetch_head_answered_and_flagged = 0
-            # for message in mailbox.fetch(headers_only=True):
-            #     if {MailMessageFlags.ANSWERED, MailMessageFlags.FLAGGED}.issubset(message.flags):
-            #         cnt_fetch_head_answered_and_flagged += 1
-            #     cnt_fetch_head += 1
-            #     self.assertEqual(message.text, '')
-            #     self.assertEqual(message.html, '')
-            #     self.assertEqual(len(message.attachments), 0)
+            cnt_fetch_head = 0
+            cnt_fetch_head_answered_and_flagged = 0
+            for message in mailbox.fetch(headers_only=True):
+                if {MailMessageFlags.ANSWERED, MailMessageFlags.FLAGGED}.issubset(message.flags):
+                    cnt_fetch_head_answered_and_flagged += 1
+                cnt_fetch_head += 1
+                self.assertEqual(message.text, '')
+                self.assertEqual(message.html, '')
+                self.assertEqual(len(message.attachments), 0)
 
             # types
             cnt_fetch_all = 0
@@ -57,12 +58,16 @@ def test_live(self):
                     self.assertIs(type(att.filename), str)
                     self.assertIs(type(att.content_type), str)
                     self.assertIs(type(att.payload), bytes)
+
             # counts
             self.assertTrue(cnt_fetch_all_answered_and_flagged >= 1)
             self.assertEqual(cnt_fetch_all, 6)
-            # self.assertEqual(cnt_fetch_head, cnt_fetch_all)
-            # self.assertTrue(cnt_fetch_head_answered_and_flagged >= 1)
-            # self.assertEqual(cnt_fetch_head_answered_and_flagged, cnt_fetch_all_answered_and_flagged)
+
+            self.assertTrue(cnt_fetch_head_answered_and_flagged >= 1)
+            self.assertEqual(cnt_fetch_head, 6)
+
+            self.assertEqual(cnt_fetch_head, cnt_fetch_all)
+            self.assertEqual(cnt_fetch_head_answered_and_flagged, cnt_fetch_all_answered_and_flagged)
 
     def test_attributes(self):
         msg_attr_set = {'subject', 'from_', 'to', 'cc', 'bcc', 'reply_to', 'date', 'date_str', 'text', 'html',