extract-msg 0.48.2__py3-none-any.whl

extract_msg/msg_classes/journal.py

@@ -0,0 +1,131 @@
+__all__ = [
+    'Journal',
+]
+
+
+import base64
+import datetime
+import functools
+import json
+
+from typing import List, Optional
+
+from ..constants import HEADER_FORMAT_TYPE, ps
+from ..enums import LogFlags
+from .message_base import MessageBase
+from ..utils import minutesToDurationStr
+
+
+class Journal(MessageBase):
+    """
+    Class for parsing Journal messages.
+    """
+
+    def getJson(self) -> str:
+        return json.dumps({
+            'subject': self.subject,
+            'entryType': self.logTypeDesc,
+            'company': self.companies[0] if self.companies else None,
+            'start': self.logStart.__format__(self.datetimeFormat) if self.logStart else None,
+            'end': self.logEnd.__format__(self.datetimeFormat) if self.logEnd else None,
+            'duration': minutesToDurationStr(self.duration),
+            'body': self.body,
+            # There is a good chance the body property won't exist, so this is a
+            # backup.
+            'rtfBodyB64': base64.b64encode(self.rtfBody).decode('ascii') if self.rtfBody else None,
+        })
+
+    @functools.cached_property
+    def companies(self) -> Optional[List[str]]:
+        """
+        Contains a list of company names, each of which is accociated with a
+        contact this is precified in the contacts property.
+        """
+        return self.getNamedProp('8539', ps.PSETID_COMMON)
+
+    @functools.cached_property
+    def logDocumentPosted(self) -> bool:
+        """
+        Indicates whether the document was sent by email of posted to a server
+        folder during journaling.
+        """
+        return bool(self.getNamedProp('8711', ps.PSETID_LOG))
+
+    @functools.cached_property
+    def logDocumentPrinted(self) -> bool:
+        """
+        Indicates whether the document was printed during journaling.
+        """
+        return bool(self.getNamedProp('870E', ps.PSETID_LOG))
+
+    @functools.cached_property
+    def logDocumentRouted(self) -> bool:
+        """
+        Indicates whether the document was sent to a routing recipient during
+        journaling.
+        """
+        return bool(self.getNamedProp('8710', ps.PSETID_LOG))
+
+    @functools.cached_property
+    def logDocumentSaved(self) -> bool:
+        """
+        Indicates whether the document was saved during journaling.
+        """
+        return bool(self.getNamedProp('870F', ps.PSETID_LOG))
+
+    @functools.cached_property
+    def logDuration(self) -> int:
+        """
+        The duration, in minutes, of the activity.
+        """
+        return self.getNamedProp('8707', ps.PSETID_LOG, 0)
+
+    @functools.cached_property
+    def logEnd(self) -> Optional[datetime.datetime]:
+        """
+        The name of the activity that is being recorded.
+        """
+        return self.getNamedProp('8708', ps.PSETID_LOG)
+
+    @functools.cached_property
+    def logFlags(self) -> LogFlags:
+        """
+        The name of the activity that is being recorded.
+        """
+        return LogFlags(self.getNamedProp('870C', ps.PSETID_LOG, 0))
+
+    @functools.cached_property
+    def logStart(self) -> Optional[datetime.datetime]:
+        """
+        The name of the activity that is being recorded.
+        """
+        return self.getNamedProp('8706', ps.PSETID_LOG)
+
+    @functools.cached_property
+    def logType(self) -> Optional[str]:
+        """
+        The name of the activity that is being recorded.
+        """
+        return self.getNamedProp('8700', ps.PSETID_LOG)
+
+    @functools.cached_property
+    def logTypeDesc(self) -> Optional[str]:
+        """
+        The description of the activity that is being recorded.
+        """
+        return self.getNamedProp('8712', ps.PSETID_LOG)
+
+    @property
+    def headerFormatProperties(self) -> HEADER_FORMAT_TYPE:
+        return {
+            '-main details-': {
+                'Subject': self.subject,
+                'Entry Type': self.logTypeDesc,
+                'Company': self.companies[0] if self.companies else None,
+            },
+            '-time-': {
+                'Start': self.logStart.__format__(self.datetimeFormat) if self.logStart else None,
+                'End': self.logEnd.__format__(self.datetimeFormat) if self.logEnd else None,
+                'Duration': minutesToDurationStr(self.duration),
+            },
+        }

extract_msg/msg_classes/meeting_cancellation.py

@@ -0,0 +1,108 @@
+__all__ = [
+    'MeetingCancellation',
+]
+
+
+import json
+
+from .. import constants
+from ..enums import RecurPatternType, ResponseStatus
+from .meeting_related import MeetingRelated
+
+
+# The documentation for this only specifies restrictions on existing properties,
+# so we just mostly leave this alone.
+class MeetingCancellation(MeetingRelated):
+    """
+    Class for a Meeting Cancellation 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,
+        })
+
+    @property
+    def headerFormatProperties(self) -> constants.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,
+                'Show Time As': 'Free',
+            },
+            '-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,
+            },
+        }

extract_msg/msg_classes/meeting_exception.py

@@ -0,0 +1,55 @@
+__all__ = [
+    'MeetingException',
+]
+
+
+import datetime
+import functools
+
+from typing import Optional
+
+from .. import constants
+from ..enums import SaveType
+from .meeting_related import MeetingRelated
+
+
+class MeetingException(MeetingRelated):
+    """
+    Class for handling Meeting Exceptions.
+    """
+
+    def save(self, **_) -> constants.SAVE_TYPE:
+        """
+        Meeting Exceptions are hidden attachments with no save behaviors.
+
+        If you want something to happen for saving, you can call the save of a
+        parent class or write your own code.
+        """
+        return (SaveType.NONE, None)
+
+    @functools.cached_property
+    def exceptionReplaceTime(self) -> Optional[datetime.datetime]:
+        """
+        The date and time within the recurrence pattern that the exception will
+        replace.
+
+        The value is specified in UTC.
+        """
+        return self.getNamedProp('8228', constants.ps.PSETID_APPOINTMENT)
+
+    @functools.cached_property
+    def fExceptionalBody(self) -> bool:
+        """
+        Indicates that the Exception Embedded Message object has a body that
+        differs from the Recurring Calendar object.
+
+        If ``True``, the Exception MUST have a body.
+        """
+        return bool(self.getNamedProp('8206', constants.ps.PSETID_APPOINTMENT))
+
+    @functools.cached_property
+    def fInvited(self) -> bool:
+        """
+        Indicates if invitations have been sent for this exception.
+        """
+        return bool(self.getNamedProp('8229', constants.ps.PSETID_APPOINTMENT))

extract_msg/msg_classes/meeting_forward.py

@@ -0,0 +1,115 @@
+__all__ = [
+    'MeetingForwardNotification',
+]
+
+
+import functools
+import json
+
+from typing import Optional
+
+from .. import constants
+from .meeting_related import MeetingRelated
+from ..enums import RecurPatternType, ResponseStatus
+
+
+class MeetingForwardNotification(MeetingRelated):
+    """
+    Class for handling Meeting Forward Notification objects.
+    """
+
+    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 forwardNotificationRecipients(self) -> Optional[bytes]:
+        """
+        Bytes containing a list of RecipientRow structures that indicate the
+        recipients of a meeting forward.
+
+        Incomplete, looks to be the same structure as
+        appointmentUnsendableRecipients, so we need more examples of this.
+        """
+        return self.getNamedProp('8261', constants.ps.PSETID_APPOINTMENT)
+
+    @property
+    def headerFormatProperties(self) -> constants.HEADER_FORMAT_TYPE:
+        # 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,
+            },
+            '-attendees-': {
+                'Organizer': self.organizer,
+                'Required Attendees': self.to,
+                'Optional Attendees': self.cc,
+                'Resources': self.bcc,
+            },
+            '-importance-': {
+                'Importance': self.importanceString,
+            },
+        }
+
+    @functools.cached_property
+    def promptSendUpdate(self) -> bool:
+        """
+        Indicates that the Meeting Forward Notification object was out-of-date
+        when it was received.
+        """
+        return bool(self.getNamedProp('8045', constants.ps.PSETID_COMMON))

extract_msg/msg_classes/meeting_related.py

@@ -0,0 +1,65 @@
+__all__ = [
+    'MeetingRelated',
+]
+
+
+import datetime
+import functools
+
+from typing import Optional
+
+from ..constants import ps
+from .calendar_base import CalendarBase
+from ..enums import ServerProcessingAction
+
+
+class MeetingRelated(CalendarBase):
+    """
+    Base class for meeting-related objects.
+    """
+
+    @functools.cached_property
+    def attendeeCriticalChange(self) -> Optional[datetime.datetime]:
+        """
+        The date and time at which the meeting-related object was sent.
+        """
+        return self.getNamedProp('0001', ps.PSETID_MEETING)
+
+    @functools.cached_property
+    def processed(self) -> bool:
+        """
+        Indicates whether a client has processed a meeting-related object.
+        """
+        return bool(self.getPropertyVal('7D01000B'))
+
+    @functools.cached_property
+    def serverProcessed(self) -> bool:
+        """
+        Indicates that the Meeting Request object or Meeting Update object has
+        been processed.
+        """
+        return bool(self.getNamedProp('85CC', ps.PSETID_CALENDAR_ASSISTANT))
+
+    @functools.cached_property
+    def serverProcessingActions(self) -> Optional[ServerProcessingAction]:
+        """
+        A union of which actions have been taken on the Meeting Request object
+        or Meeting Update object.
+        """
+        return self.getNamedAs('85CD', ps.PSETID_CALENDAR_ASSISTANT, ServerProcessingAction)
+
+    @functools.cached_property
+    def timeZone(self) -> Optional[int]:
+        """
+        Specifies information about the time zone of a recurring meeting.
+
+        See PidLidTimeZone in [MS-OXOCAL] for details.
+        """
+        return self.getNamedProp('000C', ps.PSETID_MEETING)
+
+    @functools.cached_property
+    def where(self) -> Optional[str]:
+        """
+        PidLidWhere. Should be the same as location.
+        """
+        return self.getNamedProp('0002', ps.PSETID_MEETING)

extract_msg/msg_classes/meeting_request.py

@@ -0,0 +1,189 @@
+__all__ = [
+    'MeetingRequest',
+]
+
+
+import datetime
+import functools
+import json
+
+from typing import Optional
+
+from ..constants import HEADER_FORMAT_TYPE, ps
+from .meeting_related import MeetingRelated
+from ..enums import BusyStatus, MeetingObjectChange, MeetingType, RecurCalendarType, RecurPatternType, ResponseStatus
+
+
+class MeetingRequest(MeetingRelated):
+    """
+    Class for handling Meeting Request and Meeting Update objects.
+    """
+
+    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 appointmentMessageClass(self) -> Optional[str]:
+        """
+        Indicates the value of the PidTagMessageClass property of the Meeting
+        object that is to be generated from the Meeting Request object. MUST
+        start with "IPM.Appointment".
+        """
+        return self.getNamedProp('0024', ps.PSETID_MEETING)
+
+    @functools.cached_property
+    def calendarType(self) -> Optional[RecurCalendarType]:
+        """
+        The value of the CalendarType field from the PidLidAppointmentRecur
+        property if the Meeting Request object represents a recurring series or
+        an exception.
+        """
+        return self.getNamedAs('001C', ps.PSETID_MEETING, RecurCalendarType)
+
+    @functools.cached_property
+    def changeHighlight(self) -> Optional[MeetingObjectChange]:
+        """
+        Soecifies a bit field that indicates how the Meeting object has been
+        changed.
+
+        Returns a union of the set flags.
+        """
+        return self.getNamedAs('8204', ps.PSETID_APPOINTMENT, MeetingObjectChange)
+
+    @functools.cached_property
+    def forwardInstance(self) -> bool:
+        """
+        Indicates that the Meeting Request object represents an exception to a
+        recurring series, and it was forwarded (even when forwarded by the
+        organizer) rather than being an invitation sent by the organizer.
+        """
+        return bool(self.getNamedProp('820A', 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]
+
+        showTime = None if self.appointmentNotAllowPropose else 'Tentative'
+
+        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,
+                'Show Time As': showTime,
+            },
+            '-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 intendedBusyStatus(self) -> Optional[BusyStatus]:
+        """
+        The value of the busyStatus on the Meeting object in the organizer's
+        calendar at the time the Meeting Request object or Meeting Update object
+        was sent.
+        """
+        return self.getNamedAs('8224', ps.PSETID_APPOINTMENT, BusyStatus)
+
+    @functools.cached_property
+    def meetingType(self) -> Optional[MeetingType]:
+        """
+        The type of Meeting Request object or Meeting Update object.
+        """
+        return self.getNamedAs('0026', ps.PSETID_MEETING, MeetingType)
+
+    @functools.cached_property
+    def oldLocation(self) -> Optional[str]:
+        """
+        The original value of the location property before a meeting update.
+        """
+        return self.getNamedProp('0028', ps.PSETID_MEETING)
+
+    @functools.cached_property
+    def oldWhenEndWhole(self) -> Optional[datetime.datetime]:
+        """
+        The original value of the appointmentEndWhole property before a meeting
+        update.
+        """
+        return self.getNamedProp('002A', ps.PSETID_MEETING)
+
+    @functools.cached_property
+    def oldWhenStartWhole(self) -> Optional[datetime.datetime]:
+        """
+        The original value of the appointmentStartWhole property before a
+        meeting update.
+        """
+        return self.getNamedProp('0029', ps.PSETID_MEETING)