Version 0.46.0

v0.46.0

• [TeamMsgExtractor #95] Adjusted the overrideEncoding property of MSGFile to allow automatic encoding detection. Simply set the property to the string "chardet" and, assuming the chardet module is installed, it will analyze a number of the strings to try and form a consensus about the encoding. This will ignore the specified encoding only if if successfully detects. Otherwise it will log a warning and fall back to the default behavior.
• [TeamMsgExtractor #387] Changed extract_msg.utils.decodeRfc2047 to not throw decoding errors if the content given is not ASCII.
• [TeamMsgExtractor #387] Changed header parsing policy to email.policy.compat32 to prevent partial parsing of quoted header fields.
• [TeamMsgExtractor #388] Updated documentation of MSGFile.export to specify that updated fields on an MSGFile instance (and it's subclasses) will not be reflected in the result of the function. Many of the functions do use the newest version of a cached_property, but this is not one of them.
• Removed methods deprecated in v0.45.0.
• Changed the base class of EntryID from no base class to abc.ABC.
• Added position property to EntryID to tell how many bytes were used to create the EntryID.
• Added a number of properties to MSGFile from [MS-OXCMSG].
• Moved some properties down to MessageBase from it's subclasses.
• Added support for Journal objects.
• Changed internal code of PermanentEntryID to correctly parse the data. Previously the distinguished name did not actually end at the null character, instead ending at the end of the bytes provided. If there was trailing data, it would be captured inadvertently.
• Finished definition for StoreObjectEntryID.
• Added new keyword arguments for MSG files: dateFormat and datetimeFormat. These allow the user to easily override the strings being used for format dates and dates that include a time component, respectively.
  • In unifying all the formats into 2 options, you may notice that some will look a bit different starting from this version, as there was an unfortunately large amount of variation.
• Fixed code for MessageBase.parsedDate which could have incorrect values.
• Fixed issues with MessageBase.date and related things either being incorrectly documented or doing things that are not specified by the documentation. It was supposed to have been changed to use datetime objects, but it was still using strings.
• Removed unused function extract_msg.utils.isEmptyString.
• Removed unused function extract_msg.utils.properHex.
• Added a getStream helper function to CustomAttachmentHandler.
• Added a getStreamAs helper function to CustomAttachmentHandler.
• Added new custom attachment handler for journal-associated attachments.
• Changed EntryID.autoCreate to return None if given None or empty bytes.
• Changed EntryID.autoCreate to raise a FeatureNotImplemented exception if no valid entry ID class is found.
• Fix typing annotations for CustomAttachmentHandler.
• Removed unneeded imapclient dependency.
• Changed getJson to have values be null if they aren't found rather than an empty string.
• Implemented the getJson method correctly for a number of classes.
• Changed Task.percentComplete to always return a float.
• Changed the NotImplementedError for custom attachment handler not being found to FeatureNotImplemented. Additionally, changed the error message to specify the CLSID found on the attachment to better enable people to report issues.
• Changed code for Recipient and MessageBase that makes it rely on MessageBase.recipientTypeClass to determine the class to use for the recipientType property. Adjusted the typing of Recipient to have it reflect the type that will be used.
• Correctly changed the returned value for ResponseStatus.fromIter to actually return a List instead of a set.
• Filled out typing information for a significant portion of the module where variables or functions were missing it. This includes the entirety of the constants submodule.
• Corrected a number of minor issues.
• Extended values for DVAspect enum.
• Added new enums to go with parsing for OLEPresentationStream.
• Changed NNTPNewsgroupFolderEntryID.newsgroupName to bytes instead of string since it is ANSI.
• Fixed an issue that would cause headers to fail to parse properly if the header text starts with "Microsoft Mail Internet Headers Version 2.0" which is common on some MSG files. This is fixed by stripping that from the beginning before actually parsing the text. This is to circumvent CPython issue #85329, confirmed to still exist in at least some of the supported Python versions.
• Added listDir and slistDir as methods to AttachmentBase, Recipient, and Named. These always exclude the prefix, returning as if their directory is the root of the object. This allows the named to be directly used for accessing those files.
• Numerous spelling fixes in docstrings, comments, and exceptions.
• Reduced the amount of initialization performed by MessageBase. Much of this initialization was there from before a lot of stuff changed to cached_property and a number of internal variables were being used. Now all of the relevant variables will be initialized by the way they are accessed.
• Added new exception DependencyError.
• Changed the errors for missing optional dependencies from ImportError to DependencyError.
• Removed all instances of the rawData property in favor of the toBytes method. For now, many of these will simply return the raw data used, specifically those that are still unmodifiable. Any whose properties have the ability to be modified will have properly implemented versions. These classes also allow None to be passed as the value for their data, which will be the default if no arguments have been passed to the constructor. If no arguments or None is given as the data, it will create a new instance with default values. This is all in an effort to move towards the ability to create new MSG files and the MSGWriter class. All toBytes methods will either exclusively return bytes or will return None to specify that the structure isn't valid to convert to bytes. Structures that may be invalid will be annotated as Optional[bytes] for the return type.
  • Additionally, these objects will also support the __bytes__ method. If the object returned is not bytes, the method will throw a TypeError.
• Removed the individual PropBase flag properties and changed the main flags property to return an enum containing the flags.
• Changed various data structs to allow modification and creation of new instances for writing to an MSG file.
• Changed TZRule to use unsigned values where applicable.
• Changed TZRule to require the 14 null bytes (I commented it out completely on accident instead of swapping it to a plain read). It now logs a warning about the bytes not being null.
• Removed unneeded function windowsUnicode.
• Moved FixedLengthProperty.parseType to the private API. This was not intended for external use anyways, so leaving it as public API didn't make sense.
• Fixed check for type in ContactAddressEntryID being the wrong value.
• Modified inputToBytes to support objects with the __bytes__ method. If the method exists and works then it will be used as a last resort.
• Modified OleWriter to accept objects with a __bytes__ method for the data to use for an entry.
• Added __bytes__ method to MSGFile. This is equivalent to calling MSGFile.exportBytes.