extract_msg.msg_classes.appointment Module

Module contents

class extract_msg.msg_classes.appointment.AppointmentMeeting(path, **kwargs)[source]

Bases: 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.

Supports all of the options from MSGFile.__init__() with some additional ones.

Parameters:

  • recipientSeparator – Optional, separator string to use between recipients.

  • deencapsulationFunc – Optional, if specified must be a callable that will override the way that HTML/text is deencapsulated from the RTF body. This function must take exactly 2 arguments, the first being the RTF body from the message and the second being an instance of the enum DeencapType that will tell the function what type of body is desired. The function should return a string for plain text and bytes for HTML. If any problems occur, the function must either return None or raise one of the appropriate exceptions from extract_msg.exceptions. All other exceptions must be handled internally or they will not be caught. The original deencapsulation method will not run if this is set.

getJson() → str[source]

Returns the JSON representation of the Message.

property appointmentCounterProposal: bool

Indicates to the organizer that there are counter proposals that have not been accepted or rejected by the organizer.

property appointmentLastSequence: int | None

The last sequence number that was sent to any attendee.

property appointmentProposalNumber: int | None

The number of attendees who have sent counter propostals that have not been accepted or rejected by the organizer.

property appointmentReplyName: datetime | None

The user who last replied to the meeting request or meeting update.

property appointmentReplyTime: datetime | None

The date and time at which the attendee responded to a received Meeting Request object of Meeting Update object in UTC.

property appointmentSequenceTime: datetime | None

The date and time at which the appointmentSequence property was last modified.

property autoFillLocation: 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.

property fInvited: bool

Whether a Meeting Request object has been sent out.

property headerFormatProperties: Dict[str, str | Tuple[str | None, bool] | None | Dict[str, str | Tuple[str | None, bool] | None]] | None

Returns a dictionary of properties, in order, to be formatted into the header.

Keys are the names to use in the header while the values are one of the following:

  • None: Signifies no data was found for the property and it should be omitted from the header.

  • str: A string to be formatted into the header using the string encoding.

  • Tuple[Union[str, None], bool]: A string should be formatted into the header. If the bool is True, then place an empty string if the first value is None, otherwise follow the same behavior as regular None.

Additional note: If the value is an empty string, it will be dropped as well by default.

Additionally you can group members of a header together by placing them in an embedded dictionary. Groups will be spaced out using a second instance of the join string. If any member of a group is being printed, it will be spaced apart from the next group/item.

If you class should not do any header injection, return None from this property.

property isMeeting: bool

Attempts to determine if the object is a Meeting.

True if meeting, False if appointment.

property originalStoreEntryID: EntryID | None

The EntryID of the delegator’s message store.

filename: str | None