extract-msg 0.48.2__py3-none-any.whl

extract_msg/exceptions.py

@@ -0,0 +1,170 @@
+# -*- coding: utf-8 -*-
+
+"""
+extract_msg.exceptions
+~~~~~~~~~~~~~~~~~~~~~~
+This module contains the set of extract_msg exceptions.
+"""
+
+__all__ = [
+    'ExMsgBaseException',
+
+    'ConversionError',
+    'DataNotFoundError',
+    'DeencapMalformedData',
+    'DeencapNotEncapsulated',
+    'ExecutableNotFound',
+    'IncompatibleOptionsError',
+    'InvalidFileFormatError',
+    'InvalidPropertyIdError',
+    'StandardViolationError',
+    'TZError',
+    'UnknownCodepageError',
+    'UnsupportedEncodingError',
+    'UnknownTypeError',
+    'UnsupportedMSGTypeError',
+    'UnrecognizedMSGTypeError',
+    'WKError',
+]
+
+# Base exception types.
+
+class ExMsgBaseException(Exception):
+    """
+    The base class for all custom exceptions the module uses.
+    """
+
+# I would want this to also be a subclass of NotImplementedError, but Python
+# docs say that CPython can make that a bit problematic due to things from the C
+# side of the code.
+class FeatureNotImplemented(ExMsgBaseException):
+    """
+    The base class for a feature not yet being implemented in the module.
+    """
+
+
+# More specific exceptions.
+
+
+class ConversionError(ExMsgBaseException):
+    """
+    An error occured during type conversion.
+    """
+
+class DataNotFoundError(ExMsgBaseException):
+    """
+    Requested stream type was unavailable.
+    """
+
+class DeencapMalformedData(ExMsgBaseException):
+    """
+    Data to deencapsulate was malformed in some way.
+    """
+
+class DeencapNotEncapsulated(ExMsgBaseException):
+    """
+    Data to deencapsulate did not contain any encapsulated data.
+    """
+
+class DependencyError(ExMsgBaseException):
+    """
+    An optional dependency could not be found or was unable to be used as
+    expected.
+    """
+
+class ExecutableNotFound(DependencyError):
+    """
+    Could not find the specified executable.
+    """
+
+class IncompatibleOptionsError(ExMsgBaseException):
+    """
+    Provided options are incompatible with each other.
+    """
+
+class InvalidFileFormatError(ExMsgBaseException):
+    """
+    An Invalid File Format Error occurred.
+    """
+
+class InvalidPropertyIdError(ExMsgBaseException):
+    """
+    The provided property ID was invalid.
+    """
+
+class NotWritableError(ExMsgBaseException):
+    """
+    Modification was attempted on an instance that is not writable.
+    """
+
+class PrefixError(ExMsgBaseException):
+    """
+    An issue was detected with the provided prefix.
+
+    This should never occur if you have no manually provided a prefix.
+    """
+
+class SecurityError(ExMsgBaseException):
+    """
+    A code path was triggered that would use an insecure feature, but that
+    insecure feature was not enabled.
+    """
+
+class StandardViolationError(InvalidFileFormatError):
+    """
+    A critical violation of the MSG standards was detected and could not be
+    recovered from.
+
+    Recoverable violations will result in log messages instead.
+
+    Any that could reasonably be skipped, although are likely to still cause
+    errors down the line, can be suppressed.
+    """
+
+class TooManySectorsError(ExMsgBaseException):
+    """
+    Ole writer has too much data to write to the file.
+    """
+
+class TZError(ExMsgBaseException):
+    """
+    Specifically not an OSError to avoid being caught by parts of the module.
+
+    This error represents a fatal error in the datetime parsing as it usually
+    means your installation of tzlocal or tzdata are broken. If you have
+    received this error after using PyInstaller, you must include the resource
+    files for tzdata for it to work properly. See TeamMsgExtractor#272 and
+    TeamMsgExtractor#169 for information on why you are getting this error.
+    """
+
+class UnknownCodepageError(ExMsgBaseException):
+    """
+    The codepage provided was not one we know of.
+    """
+
+class UnsupportedEncodingError(FeatureNotImplemented):
+    """
+    The codepage provided is known but is not supported.
+    """
+
+class UnknownTypeError(ExMsgBaseException):
+    """
+    The type specified is not one that is recognized.
+    """
+
+class UnsupportedMSGTypeError(FeatureNotImplemented):
+    """
+    An exception that is raised when an MSG class is recognized by not
+    supported.
+    """
+
+class UnrecognizedMSGTypeError(ExMsgBaseException):
+    """
+    An exception that is raised when the module cannot determine how to properly
+    open a specific class of MSG file.
+    """
+
+class WKError(DependencyError):
+    """
+    An error occured while running wkhtmltopdf.
+    """

extract_msg/msg_classes/__init__.py

@@ -0,0 +1,49 @@
+"""
+Classes for opening an MSG file with.
+"""
+
+__all__ = [
+    # Classes:
+    'AppointmentMeeting',
+    'Calendar',
+    'CalendarBase',
+    'Contact',
+    'Journal',
+    'MeetingCancellation',
+    'MeetingException',
+    'MeetingForwardNotification',
+    'MeetingRelated',
+    'MeetingRequest',
+    'MeetingResponse',
+    'Message',
+    'MessageBase',
+    'MessageSigned',
+    'MessageSignedBase',
+    'MSGFile',
+    'Post',
+    'StickyNote',
+    'Task',
+    'TaskRequest',
+]
+
+
+from .appointment import AppointmentMeeting
+from .calendar_base import CalendarBase
+from .calendar import Calendar
+from .contact import Contact
+from .journal import Journal
+from .meeting_cancellation import MeetingCancellation
+from .meeting_exception import MeetingException
+from .meeting_forward import MeetingForwardNotification
+from .meeting_related import MeetingRelated
+from .meeting_request import MeetingRequest
+from .meeting_response import MeetingResponse
+from .message import Message
+from .message_base import MessageBase
+from .message_signed import MessageSigned
+from .message_signed_base import MessageSignedBase
+from .msg import MSGFile
+from .post import Post
+from .sticky_note import StickyNote
+from .task import Task
+from .task_request import TaskRequest

extract_msg/msg_classes/appointment.py

@@ -0,0 +1,195 @@
+__all__ = [
+    'AppointmentMeeting',
+]
+
+
+import datetime
+import functools
+import json
+
+from typing import Optional
+
+from ..constants import HEADER_FORMAT_TYPE, ps
+from .calendar import Calendar
+from ..enums import AppointmentStateFlag, RecurPatternType, ResponseStatus
+from ..structures.entry_id import EntryID
+
+
+class AppointmentMeeting(Calendar):
+    """
+    Parser for Microsoft Outlook Appointment or Meeting files.
+
+    Both Appointment and Meeting have the same class type but Meeting has
+    additional properties. These properties are meaningless on an Appointment
+    object.
+    """
+
+    def getJson(self) -> str:
+        meetingStatusString = {
+            ResponseStatus.NONE: None,
+            ResponseStatus.ORGANIZED: 'Meeting organizer',
+            ResponseStatus.TENTATIVE: 'Tentatively accepted',
+            ResponseStatus.ACCEPTED: 'Accepted',
+            ResponseStatus.DECLINED: 'Declined',
+            ResponseStatus.NOT_RESPONDED: 'Not yet responded',
+        }[self.responseStatus]
+
+        # Get the recurrence string.
+        recur = '(none)'
+        if self.appointmentRecur:
+            recur = {
+                RecurPatternType.DAY: 'Daily',
+                RecurPatternType.WEEK: 'Weekly',
+                RecurPatternType.MONTH: 'Monthly',
+                RecurPatternType.MONTH_NTH: 'Monthly',
+                RecurPatternType.MONTH_END: 'Monthly',
+                RecurPatternType.HJ_MONTH: 'Monthly',
+                RecurPatternType.HJ_MONTH_NTH: 'Monthly',
+                RecurPatternType.HJ_MONTH_END: 'Monthly',
+            }[self.appointmentRecur.patternType]
+
+        return json.dumps({
+            'recurrence': recur,
+            'recurrencePattern': self.recurrencePattern,
+            'body': self.body,
+            'meetingStatus': meetingStatusString,
+            'organizer': self.organizer,
+            'requiredAttendees': self.to,
+            'optionalAttendees': self.cc,
+            'resources': self.bcc,
+            'start': self.startDate.__format__(self.datetimeFormat) if self.endDate else None,
+            'end': self.endDate.__format__(self.datetimeFormat) if self.endDate else None,
+        })
+
+    @functools.cached_property
+    def appointmentCounterProposal(self) -> bool:
+        """
+        Indicates to the organizer that there are counter proposals that have
+        not been accepted or rejected by the organizer.
+        """
+        return bool(self.getNamedProp('8257', ps.PSETID_APPOINTMENT))
+
+    @functools.cached_property
+    def appointmentLastSequence(self) -> Optional[int]:
+        """
+        The last sequence number that was sent to any attendee.
+        """
+        return self.getNamedProp('8203', ps.PSETID_APPOINTMENT)
+
+    @functools.cached_property
+    def appointmentProposalNumber(self) -> Optional[int]:
+        """
+        The number of attendees who have sent counter propostals that have not
+        been accepted or rejected by the organizer.
+        """
+        return self.getNamedProp('8259', ps.PSETID_APPOINTMENT)
+
+    @functools.cached_property
+    def appointmentReplyName(self) -> Optional[datetime.datetime]:
+        """
+        The user who last replied to the meeting request or meeting update.
+        """
+        return self.getNamedProp('8230', ps.PSETID_APPOINTMENT)
+
+    @functools.cached_property
+    def appointmentReplyTime(self) -> Optional[datetime.datetime]:
+        """
+        The date and time at which the attendee responded to a received Meeting
+        Request object of Meeting Update object in UTC.
+        """
+        return self.getNamedProp('8220', ps.PSETID_APPOINTMENT)
+
+    @functools.cached_property
+    def appointmentSequenceTime(self) -> Optional[datetime.datetime]:
+        """
+        The date and time at which the appointmentSequence property was last
+        modified.
+        """
+        return self.getNamedProp('8202', ps.PSETID_APPOINTMENT)
+
+    @functools.cached_property
+    def autoFillLocation(self) -> bool:
+        """
+        A value of True indicates that the value of the location property is set
+        to the value of the displayName property from the recipientRow structure
+        that represents a Resource object.
+
+        A value of ``False`` indicates that the value of the location property
+        is not automatically set.
+        """
+        return bool(self.getNamedProp('823A', ps.PSETID_APPOINTMENT))
+
+    @functools.cached_property
+    def fInvited(self) -> bool:
+        """
+        Whether a Meeting Request object has been sent out.
+        """
+        return bool(self.getNamedProp('8229', ps.PSETID_APPOINTMENT))
+
+    @property
+    def headerFormatProperties(self) -> HEADER_FORMAT_TYPE:
+        meetingStatusString = {
+            ResponseStatus.NONE: None,
+            ResponseStatus.ORGANIZED: 'Meeting organizer',
+            ResponseStatus.TENTATIVE: 'Tentatively accepted',
+            ResponseStatus.ACCEPTED: 'Accepted',
+            ResponseStatus.DECLINED: 'Declined',
+            ResponseStatus.NOT_RESPONDED: 'Not yet responded',
+        }[self.responseStatus]
+
+        # Get the recurrence string.
+        recur = '(none)'
+        if self.appointmentRecur:
+            recur = {
+                RecurPatternType.DAY: 'Daily',
+                RecurPatternType.WEEK: 'Weekly',
+                RecurPatternType.MONTH: 'Monthly',
+                RecurPatternType.MONTH_NTH: 'Monthly',
+                RecurPatternType.MONTH_END: 'Monthly',
+                RecurPatternType.HJ_MONTH: 'Monthly',
+                RecurPatternType.HJ_MONTH_NTH: 'Monthly',
+                RecurPatternType.HJ_MONTH_END: 'Monthly',
+            }[self.appointmentRecur.patternType]
+
+        return {
+            '-main info-': {
+                'Subject': self.subject,
+                'Location': self.location,
+            },
+            '-date-': {
+                'Start': self.startDate.__format__(self.datetimeFormat) if self.startDate else None,
+                'End': self.endDate.__format__(self.datetimeFormat) if self.endDate else None,
+            },
+            '-recurrence-': {
+                'Recurrance': recur,
+                'Recurrence Pattern': self.recurrencePattern,
+            },
+            '-status-': {
+                'Meeting Status': meetingStatusString,
+            },
+            '-attendees-': {
+                'Organizer': self.organizer,
+                'Required Attendees': self.to,
+                'Optional Attendees': self.cc,
+                'Resources': self.bcc,
+            },
+            '-importance-': {
+                'Importance': self.importanceString,
+            },
+        }
+
+    @functools.cached_property
+    def isMeeting(self) -> bool:
+        """
+        Attempts to determine if the object is a Meeting.
+
+        ``True`` if meeting, ``False`` if appointment.
+        """
+        return bool(self.appointmentStateFlags) and (AppointmentStateFlag.MEETING in self.appointmentStateFlags)
+
+    @functools.cached_property
+    def originalStoreEntryID(self) -> Optional[EntryID]:
+        """
+        The EntryID of the delegator's message store.
+        """
+        return self.getNamedAs('8237', ps.PSETID_APPOINTMENT, EntryID.autoCreate)

extract_msg/msg_classes/calendar.py

@@ -0,0 +1,92 @@
+__all__ = [
+    'Calendar',
+]
+
+
+import datetime
+import functools
+
+from typing import Optional
+
+from ..constants import ps
+from .calendar_base import CalendarBase
+from ..enums import ClientIntentFlag
+
+
+class Calendar(CalendarBase):
+    """
+    A calendar object.
+    """
+
+    @functools.cached_property
+    def clientIntent(self) -> Optional[ClientIntentFlag]:
+        """
+        A set of the actions a user has taken on a Meeting object.
+        """
+        return self.getNamedAs('0015', ps.PSETID_CALENDAR_ASSISTANT, ClientIntentFlag)
+
+    @functools.cached_property
+    def fExceptionalAttendees(self) -> Optional[bool]:
+        """
+        Indicates that it is a Recurring Calendar object with one or more
+        excpetions and that at least one of the Exception Embedded Message
+        objects has at least one RecipientRow structure.
+
+        SHOULD NOT be set for any Calendar object other than that of the
+        organizer's.
+        """
+        return self.getNamedProp('822B', ps.PSETID_APPOINTMENT)
+
+    @functools.cached_property
+    def reminderDelta(self) -> Optional[int]:
+        """
+        The interval, in minutes, between the time at which the reminder first
+        becomes overdue and the start time of the Calendar object.
+        """
+        return self.getNamedProp('8501', ps.PSETID_COMMON)
+
+    @functools.cached_property
+    def reminderFileParameter(self) -> Optional[str]:
+        """
+        The full path (MAY only specify the file name) of the sound that a
+        client SHOULD play when the reminder for the Message Object becomes
+        overdue.
+        """
+        return self.getNamedProp('851F', ps.PSETID_COMMON)
+
+    @functools.cached_property
+    def reminderOverride(self) -> bool:
+        """
+        Specifies if clients SHOULD respect the value of the reminderPlaySound
+        property and the reminderFileParameter property.
+        """
+        return bool(self.getNamedProp('851C', ps.PSETID_COMMON))
+
+    @functools.cached_property
+    def reminderPlaySound(self) -> bool:
+        """
+        Specified that the cliebnt should play a sound when the reminder becomes
+        overdue.
+        """
+        return bool(self.getNamedProp('851E', ps.PSETID_COMMON))
+
+    @functools.cached_property
+    def reminderSet(self) -> bool:
+        """
+        Specifies whether a reminder is set on the object.
+        """
+        return bool(self.getNamedProp('8503', ps.PSETID_COMMON))
+
+    @functools.cached_property
+    def reminderSignalTime(self) -> Optional[datetime.datetime]:
+        """
+        The point in time when a reminder transitions from pending to overdue.
+        """
+        return self.getNamedProp('8560', ps.PSETID_COMMON)
+
+    @functools.cached_property
+    def reminderTime(self) -> Optional[datetime.datetime]:
+        """
+        The time after which the user would be late.
+        """
+        return self.getNamedProp('8502', ps.PSETID_COMMON)