extract-msg 0.48.0__tar.gz → 0.48.2__tar.gz

{extract_msg-0.48.0 → extract_msg-0.48.2}/CHANGELOG.md

@@ -1,3 +1,13 @@
+**v0.48.2**
+* Fixed bugs with `MessageBase.asEmailMessage()`. Numerous improvements to how it handles the data.
+
+**v0.48.1**
+* Added an option (`-s`, `--stdin`) to the command line to take an MSG file from stdin. This allows the user to pipe the MSG data from another program directly instead of having to write a middleman that uses the `extract-msg` library directly or having to write the file to the disk first.
+* Changed main function to allow for manual argument list to be passed to it.
+* Added attributes to `AttachmentBase` for creation and modification time. These can be accessed through `createdAt` or `creationTime` and `lastModificationTime` or `modifiedAt`.
+* Changed `OleWriter` tests to output the name of the test file being done if an error occurs.
+* Added tests for some command line stuff.
+
 **v0.48.0**
 * Adjusted error handling for named properties to handle critical streams being missing and to allow suppression of those errors.
 * Adjusted error handling for named properties to allow silencing of errors caused by invalid references to the name stream. If `ErrorBehavior.NAMED_NAME_STREAM` is provided to the `MSGFile` instance, a warning will be logged and that entry will simply be dropped.

{extract_msg-0.48.0 → extract_msg-0.48.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: extract_msg
-Version: 0.48.0
+Version: 0.48.2
 Summary: Extracts emails and attachments saved in Microsoft Outlook's .msg files
 Home-page: https://github.com/TeamMsgExtractor/msg-extractor
 Download-URL: https://github.com/TeamMsgExtractor/msg-extractor/archives/master
@@ -79,7 +79,7 @@ refer to the usage information provided from the program's help dialog:
 
      usage: extract_msg [-h] [--use-content-id] [--json] [--file-logging] [-v] [--log LOG] [--config CONFIGPATH] [--out OUTPATH] [--use-filename] [--dump-stdout] [--html] [--pdf] [--wk-path WKPATH] [--wk-options [WKOPTIONS ...]]
                         [--prepared-html] [--charset CHARSET] [--raw] [--rtf] [--allow-fallback] [--skip-body-not-found] [--zip ZIP] [--save-header] [--attachments-only] [--skip-hidden] [--no-folders] [--skip-embedded] [--extract-embedded]
-                        [--overwrite-existing] [--skip-not-implemented] [--out-name OUTNAME | --glob] [--ignore-rtfde] [--progress]
+                        [--overwrite-existing] [--skip-not-implemented] [--out-name OUTNAME | --glob] [--ignore-rtfde] [--progress] [-s]
                         msg [msg ...]
 
      extract_msg: Extracts emails and attachments saved in Microsoft Outlook's .msg files. https://github.com/TeamMsgExtractor/msg-extractor
@@ -125,6 +125,7 @@ refer to the usage information provided from the program's help dialog:
        --glob, --wildcard    Interpret all paths as having wildcards. Incompatible with --out-name.
        --ignore-rtfde        Ignores all errors thrown from RTFDE when trying to save. Useful for allowing fallback to continue when an exception happens.
        --progress            Shows what file the program is currently working on during it's progress.
+       -s, --stdin           Read file from stdin (only works with one file at a time).
 
 **To use this in your own script**, start by using:
 
@@ -277,8 +278,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.48.0-blue.svg
-   :target: https://pypi.org/project/extract-msg/0.48.0/
+.. |PyPI3| image:: https://img.shields.io/badge/pypi-0.48.2-blue.svg
+   :target: https://pypi.org/project/extract-msg/0.48.2/
 
 .. |PyPI2| image:: https://img.shields.io/badge/python-3.8+-brightgreen.svg
    :target: https://www.python.org/downloads/release/python-3810/

{extract_msg-0.48.0 → extract_msg-0.48.2}/README.rst

@@ -61,7 +61,7 @@ refer to the usage information provided from the program's help dialog:
 
      usage: extract_msg [-h] [--use-content-id] [--json] [--file-logging] [-v] [--log LOG] [--config CONFIGPATH] [--out OUTPATH] [--use-filename] [--dump-stdout] [--html] [--pdf] [--wk-path WKPATH] [--wk-options [WKOPTIONS ...]]
                         [--prepared-html] [--charset CHARSET] [--raw] [--rtf] [--allow-fallback] [--skip-body-not-found] [--zip ZIP] [--save-header] [--attachments-only] [--skip-hidden] [--no-folders] [--skip-embedded] [--extract-embedded]
-                        [--overwrite-existing] [--skip-not-implemented] [--out-name OUTNAME | --glob] [--ignore-rtfde] [--progress]
+                        [--overwrite-existing] [--skip-not-implemented] [--out-name OUTNAME | --glob] [--ignore-rtfde] [--progress] [-s]
                         msg [msg ...]
 
      extract_msg: Extracts emails and attachments saved in Microsoft Outlook's .msg files. https://github.com/TeamMsgExtractor/msg-extractor
@@ -107,6 +107,7 @@ refer to the usage information provided from the program's help dialog:
        --glob, --wildcard    Interpret all paths as having wildcards. Incompatible with --out-name.
        --ignore-rtfde        Ignores all errors thrown from RTFDE when trying to save. Useful for allowing fallback to continue when an exception happens.
        --progress            Shows what file the program is currently working on during it's progress.
+       -s, --stdin           Read file from stdin (only works with one file at a time).
 
 **To use this in your own script**, start by using:
 
@@ -259,8 +260,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.48.0-blue.svg
-   :target: https://pypi.org/project/extract-msg/0.48.0/
+.. |PyPI3| image:: https://img.shields.io/badge/pypi-0.48.2-blue.svg
+   :target: https://pypi.org/project/extract-msg/0.48.2/
 
 .. |PyPI2| image:: https://img.shields.io/badge/python-3.8+-brightgreen.svg
    :target: https://www.python.org/downloads/release/python-3810/

{extract_msg-0.48.0 → extract_msg-0.48.2}/extract_msg/__init__.py

@@ -27,8 +27,8 @@ https://github.com/TeamMsgExtractor/msg-extractor
 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 __author__ = 'Destiny Peterson & Matthew Walker'
-__date__ = '2024-02-28'
-__version__ = '0.48.0'
+__date__ = '2024-03-09'
+__version__ = '0.48.2'
 
 __all__ = [
     # Modules:

{extract_msg-0.48.0 → extract_msg-0.48.2}/extract_msg/__main__.py

@@ -10,12 +10,13 @@ import zipfile
 
 from extract_msg import __doc__, openMsg, utils
 from extract_msg.enums import ErrorBehavior
+from typing import List
 
 
-def main() -> None:
+def main(argv : List[str]) -> None:
     # Setup logging to stdout, indicate running from cli
     CLI_LOGGING = 'extract_msg_cli'
-    args = utils.getCommandArgs(sys.argv[1:])
+    args = utils.getCommandArgs(argv[1:])
 
     # Determine where to save the files to.
     currentDir = os.getcwd() # Store this in case the path changes.
@@ -111,4 +112,4 @@ def main() -> None:
         _zip.close()
 
 if __name__ == '__main__':
-    main()
+    main(sys.argv)

{extract_msg-0.48.0 → extract_msg-0.48.2}/extract_msg/attachments/attachment_base.py

@@ -473,7 +473,7 @@ class AttachmentBase(abc.ABC):
             the first item specifies what the second value will be.
         """
 
-    @functools.cached_property
+    @cached_property
     def attachmentEncoding(self) -> Optional[bytes]:
         """
         The encoding information about the attachment object.
@@ -483,7 +483,7 @@ class AttachmentBase(abc.ABC):
         """
         return self.getStream('__substg1.0_37020102')
 
-    @functools.cached_property
+    @cached_property
     def additionalInformation(self) -> Optional[str]:
         """
         The additional information about the attachment.
@@ -495,7 +495,7 @@ class AttachmentBase(abc.ABC):
         """
         return self.getStringStream('__substg1.0_370F')
 
-    @functools.cached_property
+    @cached_property
     def cid(self) -> Optional[str]:
         """
         Returns the Content ID of the attachment, if it exists.
@@ -526,8 +526,25 @@ class AttachmentBase(abc.ABC):
 
     @property
     def contentId(self) -> Optional[str]:
+        """
+        Alias of :attr:`cid`.
+        """
         return self.cid
 
+    @property
+    def createdAt(self) -> Optional[datetime.datetime]:
+        """
+        Alias of :attr:`creationTime`.
+        """
+        return self.creationTime
+
+    @cached_property
+    def creationTime(self) -> Optional[datetime.datetime]:
+        """
+        The time the attachment was created.
+        """
+        return self.getPropertyVal('30070040')
+
     @property
     @abc.abstractmethod
     def data(self) -> Optional[object]:
@@ -537,7 +554,7 @@ class AttachmentBase(abc.ABC):
         Returns ``None`` if there is no data to save.
         """
 
-    @functools.cached_property
+    @cached_property
     def dataType(self) -> Optional[Type[object]]:
         """
         The class that the data type will use, if it can be retrieved.
@@ -560,14 +577,14 @@ class AttachmentBase(abc.ABC):
         """
         return self.__dir
 
-    @functools.cached_property
+    @cached_property
     def displayName(self) -> Optional[str]:
         """
         Returns the display name of the folder.
         """
         return self.getStringStream('__substg1.0_3001')
 
-    @functools.cached_property
+    @cached_property
     def exceptionReplaceTime(self) -> Optional[datetime.datetime]:
         """
         The original date and time at which the instance in the recurrence
@@ -577,48 +594,62 @@ class AttachmentBase(abc.ABC):
         """
         return self.getPropertyVal('7FF90040')
 
-    @functools.cached_property
+    @cached_property
     def extension(self) -> Optional[str]:
         """
         The reported extension for the file.
         """
         return self.getStringStream('__substg1.0_3703')
 
-    @functools.cached_property
+    @cached_property
     def hidden(self) -> bool:
         """
         Indicates whether an Attachment object is hidden from the end user.
         """
         return bool(self.getPropertyVal('7FFE000B'))
 
-    @functools.cached_property
+    @cached_property
     def isAttachmentContactPhoto(self) -> bool:
         """
         Whether the attachment is a contact photo for a Contact object.
         """
         return bool(self.getPropertyVal('7FFF000B'))
 
-    @functools.cached_property
+    @cached_property
+    def lastModificationTime(self) -> Optional[datetime.datetime]:
+        """
+        The last time the attachment was modified.
+        """
+        return self.getPropertyVal('30080040')
+
+    @cached_property
     def longFilename(self) -> Optional[str]:
         """
         Returns the long file name of the attachment, if it exists.
         """
         return self.getStringStream('__substg1.0_3707')
 
-    @functools.cached_property
+    @cached_property
     def longPathname(self) -> Optional[str]:
         """
         The fully qualified path and file name with extension.
         """
         return self.getStringStream('__substg1.0_370D')
 
-    @functools.cached_property
+    @cached_property
     def mimetype(self) -> Optional[str]:
         """
         The content-type mime header of the attachment, if specified.
         """
         return tryGetMimetype(self, self.getStringStream('__substg1.0_370E'))
 
+    @property
+    def modifiedAt(self) -> Optional[datetime.datetime]:
+        """
+        Alias of :attr:`lastModificationTime`.
+        """
+        return self.lastModificationTime
+
     @property
     def msg(self) -> MSGFile:
         """
@@ -631,7 +662,7 @@ class AttachmentBase(abc.ABC):
             raise ReferenceError('The MSGFile for this Attachment instance has been garbage collected.')
         return msg
 
-    @functools.cached_property
+    @cached_property
     def name(self) -> Optional[str]:
         """
         The best name available for the file.
@@ -650,7 +681,7 @@ class AttachmentBase(abc.ABC):
         """
         return self.__namedProperties
 
-    @functools.cached_property
+    @cached_property
     def payloadClass(self) -> Optional[str]:
         """
         The class name of an object that can display the contents of the
@@ -665,7 +696,7 @@ class AttachmentBase(abc.ABC):
         """
         return self.__props
 
-    @functools.cached_property
+    @cached_property
     def renderingPosition(self) -> Optional[int]:
         """
         The offset, in rendered characters, to use when rendering the attachment
@@ -676,7 +707,7 @@ class AttachmentBase(abc.ABC):
         """
         return self.getPropertyVal('370B0003')
 
-    @property
+    @cached_property
     def shortFilename(self) -> Optional[str]:
         """
         The short file name of the attachment, if it exists.

{extract_msg-0.48.0 → extract_msg-0.48.2}/extract_msg/msg_classes/message_base.py

@@ -24,7 +24,10 @@ import RTFDE
 import RTFDE.exceptions
 
 from email import policy
+from email.charset import Charset, QP
 from email.message import EmailMessage
+from email.mime.multipart import MIMEMultipart
+from email.mime.text import MIMEText
 from email.parser import HeaderParser
 from typing import Any, Callable, cast, Dict, List, Optional, Tuple, Type, Union
 
@@ -151,13 +154,24 @@ class MessageBase(MSGFile):
 
         # Copy the headers.
         for key, value in self.header.items():
-            ret[key] = value
+            if key.lower() != 'content-type':
+                ret[key] = value.replace('\r\n', '').replace('\n', '')
+
+        ret['Content-Type'] = 'multipart/mixed'
 
         # Attach the body to the EmailMessage instance.
+        msgMain = MIMEMultipart('related')
+        ret.attach(msgMain)
+        bodyParts = MIMEMultipart('alternative')
+        msgMain.attach(bodyParts)
+
+        c = Charset('utf-8')
+        c.body_encoding = QP
+
+        if self.body:
+            bodyParts.attach(MIMEText(self.body, 'plain', c))
         if self.htmlBody:
-            ret.set_content(self.body, subtype = 'html', cte = 'quoted-printable')
-        elif self.body:
-            ret.set_content(self.body, cte = 'quoted-printable')
+            bodyParts.attach(MIMEText(self.htmlBody.decode('utf-8'), 'html', c))
 
         # Process attachments.
         for att in self.attachments:
@@ -167,7 +181,7 @@ class MessageBase(MSGFile):
                     filename = att.getFilename()
                     if filename.lower().endswith('.msg'):
                         filename = filename[:-4] + '.eml'
-                    ret.add_attachment(
+                    msgMain.add_attachment(
                                         att.data.asEmailMessage(),
                                         filename = filename,
                                         cid = att.contentId)
@@ -183,11 +197,17 @@ class MessageBase(MSGFile):
                         raise ConversionError(f'Could not find a suitable method to attach attachment data type "{att.dataType}".')
                     mime = att.mimetype or 'application/octet-stream'
                     mainType, subType = mime.split('/')[0], mime.split('/')[-1]
-                    ret.add_attachment(data,
-                                       maintype = mainType,
-                                       subtype = subType,
-                                       filename = att.getFilename(),
-                                       cid = att.contentId)
+                    # Need to do this manually instead of using add_attachment.
+                    attachment = EmailMessage()
+                    attachment.set_content(data,
+                                           maintype = mainType,
+                                           subtype = subType,
+                                           cid = att.contentId)
+                    # This is just a very basic check.
+                    attachment['Content-Disposition'] = f'{"inline" if att.hidden else "attachment"}; filename="{att.getFilename()}"'
+
+                    # Add the attachment.
+                    msgMain.attach(attachment)
 
         return ret
 

{extract_msg-0.48.0 → extract_msg-0.48.2}/extract_msg/utils.py

@@ -63,6 +63,7 @@ import os
 import pathlib
 import shutil
 import struct
+import sys
 import weakref
 import zipfile
 
@@ -359,6 +360,7 @@ def getCommandArgs(args: Sequence[str]) -> argparse.Namespace:
     parser = argparse.ArgumentParser(description = constants.MAINDOC, prog = 'extract_msg')
     outFormat = parser.add_mutually_exclusive_group()
     inputFormat = parser.add_mutually_exclusive_group()
+    inputType = parser.add_mutually_exclusive_group(required = True)
     # --use-content-id, --cid
     parser.add_argument('--use-content-id', '--cid', dest='cid', action='store_true',
                         help='Save attachments by their Content ID, if they have one. Useful when working with the HTML body.')
@@ -368,7 +370,7 @@ def getCommandArgs(args: Sequence[str]) -> argparse.Namespace:
     # --file-logging
     parser.add_argument('--file-logging', dest='fileLogging', action='store_true',
                         help='Enables file logging. Implies --verbose level 1.')
-    # --verbose
+    # -v, --verbose
     parser.add_argument('-v', '--verbose', dest='verbose', action='count', default=0,
                         help='Turns on console logging. Specify more than once for higher verbosity.')
     # --log PATH
@@ -455,12 +457,19 @@ def getCommandArgs(args: Sequence[str]) -> argparse.Namespace:
     # --progress
     parser.add_argument('--progress', dest='progress', action='store_true',
                         help='Shows what file the program is currently working on during it\'s progress.')
+    # -s, --stdout
+    inputType.add_argument('-s', '--stdin', dest='stdin', action='store_true',
+                        help='Read file from stdin (only works with one file at a time).')
     # [MSG files]
-    parser.add_argument('msgs', metavar='msg', nargs='+',
+    inputType.add_argument('msgs', metavar='msg', nargs='*', default=[],
                         help='An MSG file to be parsed.')
 
     options = parser.parse_args(args)
 
+    if options.stdin:
+        # Read the MSG file from stdin and shove it into the msgs list.
+        options.msgs.append(sys.stdin.buffer.read())
+
     if options.outName and options.noFolders:
         raise IncompatibleOptionsError('--out-name is not compatible with --no-folders.')
 
@@ -502,6 +511,8 @@ def getCommandArgs(args: Sequence[str]) -> argparse.Namespace:
     if options.glob:
         if options.outName:
             raise IncompatibleOptionsError('--out-name is not supported when using wildcards.')
+        if options.stdin:
+            raise IncompatibleOptionsError('--stdin is not supported with using wildcards.')
         fileLists = []
         for path in options.msgs:
             fileLists += glob.glob(path)

{extract_msg-0.48.0 → extract_msg-0.48.2}/extract_msg.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: extract-msg
-Version: 0.48.0
+Version: 0.48.2
 Summary: Extracts emails and attachments saved in Microsoft Outlook's .msg files
 Home-page: https://github.com/TeamMsgExtractor/msg-extractor
 Download-URL: https://github.com/TeamMsgExtractor/msg-extractor/archives/master
@@ -79,7 +79,7 @@ refer to the usage information provided from the program's help dialog:
 
      usage: extract_msg [-h] [--use-content-id] [--json] [--file-logging] [-v] [--log LOG] [--config CONFIGPATH] [--out OUTPATH] [--use-filename] [--dump-stdout] [--html] [--pdf] [--wk-path WKPATH] [--wk-options [WKOPTIONS ...]]
                         [--prepared-html] [--charset CHARSET] [--raw] [--rtf] [--allow-fallback] [--skip-body-not-found] [--zip ZIP] [--save-header] [--attachments-only] [--skip-hidden] [--no-folders] [--skip-embedded] [--extract-embedded]
-                        [--overwrite-existing] [--skip-not-implemented] [--out-name OUTNAME | --glob] [--ignore-rtfde] [--progress]
+                        [--overwrite-existing] [--skip-not-implemented] [--out-name OUTNAME | --glob] [--ignore-rtfde] [--progress] [-s]
                         msg [msg ...]
 
      extract_msg: Extracts emails and attachments saved in Microsoft Outlook's .msg files. https://github.com/TeamMsgExtractor/msg-extractor
@@ -125,6 +125,7 @@ refer to the usage information provided from the program's help dialog:
        --glob, --wildcard    Interpret all paths as having wildcards. Incompatible with --out-name.
        --ignore-rtfde        Ignores all errors thrown from RTFDE when trying to save. Useful for allowing fallback to continue when an exception happens.
        --progress            Shows what file the program is currently working on during it's progress.
+       -s, --stdin           Read file from stdin (only works with one file at a time).
 
 **To use this in your own script**, start by using:
 
@@ -277,8 +278,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.48.0-blue.svg
-   :target: https://pypi.org/project/extract-msg/0.48.0/
+.. |PyPI3| image:: https://img.shields.io/badge/pypi-0.48.2-blue.svg
+   :target: https://pypi.org/project/extract-msg/0.48.2/
 
 .. |PyPI2| image:: https://img.shields.io/badge/python-3.8+-brightgreen.svg
    :target: https://www.python.org/downloads/release/python-3810/

{extract_msg-0.48.0 → extract_msg-0.48.2}/setup.cfg

@@ -1,5 +1,5 @@
 [bdist_wheel]
-universal = 1
+python-tag = py3
 
 [options.extras_require]
 all =