Merge pull request #390 from TeamMsgExtractor/next-release

Version 0.46.0

Author: TheElementalOfDestruction

.gitignore

@@ -1,10 +1,13 @@
 # Mac
 .DS_Store
 
-# PyCharm crud
+# PyCharm stuff
 /extract_msg/.idea
 
-# build files and folders
+# VS Code stuff.
+/.vscode/
+
+# Build files and folders
 /build/
 *.egg-info/
 /dist/

CHANGELOG.md

@@ -259,8 +259,8 @@ your access to the newest major version of extract-msg.
 .. |License: GPL v3| image:: https://img.shields.io/badge/License-GPLv3-blue.svg
    :target: LICENSE.txt
 
-.. |PyPI3| image:: https://img.shields.io/badge/pypi-0.45.0-blue.svg
-   :target: https://pypi.org/project/extract-msg/0.45.0/
+.. |PyPI3| image:: https://img.shields.io/badge/pypi-0.46.0-blue.svg
+   :target: https://pypi.org/project/extract-msg/0.46.0/
 
 .. |PyPI2| image:: https://img.shields.io/badge/python-3.8+-brightgreen.svg
    :target: https://www.python.org/downloads/release/python-3816/

README.rst

@@ -12,7 +12,7 @@
 sys.path.insert(0, os.path.abspath('..'))
 
 __author__ = 'Destiny Peterson & Matthew Walker'
-__version__ = '0.45.0'
+__version__ = '0.46.0'
 __year__ = '2023'
 
 

docs/conf.py

@@ -12,6 +12,14 @@ extract\_msg.attachments.custom\_att\_handler.custom\_handler.py module
    :undoc-members:
    :show-inheritance:
 
+extract\_msg.attachments.custom\_att\_handler.lnk\_obj\_att.py module
+---------------------------------------------------------------------
+
+.. automodule:: extract_msg.attachments.custom_att_handler.lnk_obj_att.py
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 extract\_msg.attachments.custom\_att\_handler.outlook\_image\_dib.py module
 ---------------------------------------------------------------------------
 

docs/extract_msg.attachments.custom_att_handler.rst

@@ -36,6 +36,14 @@ extract\_msg.msg\_classes.contact.py module
    :undoc-members:
    :show-inheritance:
 
+extract\_msg.msg\_classes.journal.py module
+-------------------------------------------
+
+.. automodule:: extract_msg.msg_classes.journal.py
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 extract\_msg.msg\_classes.meeting\_cancellation.py module
 ---------------------------------------------------------
 

docs/extract_msg.msg_classes.rst

@@ -12,6 +12,38 @@ extract\_msg.structures.business\_card.py module
    :undoc-members:
    :show-inheritance:
 
+extract\_msg.structures.cfoas.py module
+---------------------------------------
+
+.. automodule:: extract_msg.structures.cfoas.py
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+extract\_msg.structures.contact\_link\_entry.py module
+------------------------------------------------------
+
+.. automodule:: extract_msg.structures.contact_link_entry.py
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+extract\_msg.structures.dev\_mode\_a.py module
+----------------------------------------------
+
+.. automodule:: extract_msg.structures.dev_mode_a.py
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+extract\_msg.structures.dv\_target\_device.py module
+----------------------------------------------------
+
+.. automodule:: extract_msg.structures.dv_target_device.py
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 extract\_msg.structures.entry\_id.py module
 -------------------------------------------
 
@@ -28,6 +60,38 @@ extract\_msg.structures.misc\_id.py module
    :undoc-members:
    :show-inheritance:
 
+extract\_msg.structures.mon\_stream.py module
+---------------------------------------------
+
+.. automodule:: extract_msg.structures.mon_stream.py
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+extract\_msg.structures.odt.py module
+-------------------------------------
+
+.. automodule:: extract_msg.structures.odt.py
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+extract\_msg.structures.ole\_pres.py module
+-------------------------------------------
+
+.. automodule:: extract_msg.structures.ole_pres.py
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+extract\_msg.structures.ole\_stream\_struct.py module
+-----------------------------------------------------
+
+.. automodule:: extract_msg.structures.ole_stream_struct.py
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 extract\_msg.structures.recurrence\_pattern.py module
 -----------------------------------------------------
 
@@ -68,6 +132,14 @@ extract\_msg.structures.time\_zone\_struct.py module
    :undoc-members:
    :show-inheritance:
 
+extract\_msg.structures.toc\_entry.py module
+--------------------------------------------
+
+.. automodule:: extract_msg.structures.toc_entry.py
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 extract\_msg.structures.tz\_rule.py module
 ------------------------------------------
 

docs/extract_msg.structures.rst

@@ -11,7 +11,7 @@
 
 # --- LICENSE.txt --------------------------------------------------------------
 #
-#    Copyright 2013-2022 Matthew Walker and Destiny Peterson
+#    Copyright 2013-2023 Matthew Walker and Destiny Peterson
 #
 #    This program is free software: you can redistribute it and/or modify
 #    it under the terms of the GNU General Public License as published by
@@ -27,16 +27,18 @@
 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 __author__ = 'Destiny Peterson & Matthew Walker'
-__date__ = '2023-08-12'
-__version__ = '0.45.0'
+__date__ = '2023-11-08'
+__version__ = '0.46.0'
 
 __all__ = [
     # Modules:
     'attachments',
+    'constants',
     'enums',
     'exceptions',
     'msg_classes',
     'properties',
+    'structures',
 
     # Classes:
     'Attachment',
@@ -59,7 +61,7 @@
 # Ensure these are imported before anything else.
 from . import constants, enums, exceptions
 
-from . import attachments, msg_classes, properties
+from . import attachments, msg_classes, properties, structures
 from .attachments import Attachment, AttachmentBase, SignedAttachment
 from .msg_classes import Message, MSGFile
 from .ole_writer import OleWriter

extract_msg/__init__.py

@@ -7,9 +7,11 @@
 from .token import Token, TokenType
 from .tokenize_rtf import tokenizeRTF
 
-from typing import List, Iterable, Union
+from typing import List, Iterable, TypeVar, Union
 
 
+_T = TypeVar('_T')
+
 # A tuple of destinations used in the header. All ignorable ones are skipped
 # anyways, so we don't need to list those here.
 _HEADER_DESTINATIONS = (
@@ -45,7 +47,7 @@
 )
 
 
-def _listInsertMult(dest : List, source : Iterable, index : int = -1):
+def _listInsertMult(dest : List[_T], source : Iterable[_T], index : int = -1):
     """
     Inserts into :param dest: all the items in :param source: at the index
     specified. :param dest: can be any mutable sequence with :method insert:,

extract_msg/_rtf/inject_rtf.py

@@ -5,7 +5,7 @@
 
 import io
 
-from typing import Optional, Tuple
+from typing import List, Optional, Tuple
 
 from .token import Token, TokenType
 
@@ -182,7 +182,7 @@ def _readText(startChar : bytes, reader : io.BytesIO) -> Tuple[Tuple[Token, ...]
     return tuple(Token(x, TokenType.TEXT) for x in chars), nextChar
 
 
-def tokenizeRTF(data : bytes, validateStart : bool = True) -> None:
+def tokenizeRTF(data : bytes, validateStart : bool = True) -> List[Token]:
     """
     Reads in the bytes and sets the tokens list to the contents after
     tokenizing. If tokenizing fails, the current tokens list will not be
@@ -215,7 +215,7 @@ def tokenizeRTF(data : bytes, validateStart : bool = True) -> None:
         nextChar = reader.read(1)
 
         # If the next character is a space, ignore it.
-        if nextChar == ' ':
+        if nextChar == b' ':
             nextChar = reader.read(1)
     else:
         tokens = []