extract_msg.structures.recurrence_pattern Module

Module contents

class extract_msg.structures.recurrence_pattern.RecurrencePattern(data: bytes)[source]

Bases: object

A RecurrencePattern structure, as specified in [MS-OXOCAL].

toBytes() → bytes[source]
property calendarType: RecurCalendarType

The type of calendar that is used.

property deletedInstanceDates: Tuple[int, ...]

A tuple of the dates (stored as number of minutes between midnight, January 1, 1601, and midnight on the specified day in the timezone specified in the calendar object), ordered from earliest to latest, of either a deleted instance or a modified instance for this recurrence.

property endDate: int

An integer that specifies the ending date for the recurrence.

The value is the number of minutes between midnight, January 1, 1601, and midnight of the date of the last occurrence. When the value of the endType field is END_AFTER_N_OCCURRENCES, this value is calculated based on the number of occurrences. If the recurrence does not have an end date, the value of the endDate field MUST be set to 0x5AE980DF.

property endType: RecurEndType

The ending type for the recurrence.

property firstDateTime: int

The first ever dat, week, or month of a recurring series, dating back to a reference date, which is January 1, 1601, for a Gregorian calendar.

property firstDayOfWeek: RecurDOW

The day on which the calendar week begins.

property modifiedInstanceDates: Tuple[int, ...]

A tuple of the dates (stored as number of minutes between midnight, January 1, 1601, and midnight on the specified day in the timezone specified in the calendar object), ordered from earliest to latest, of a modified instance.

property occurrenceCount: int

Number of occurrences for a recurrence that ends after N occurrences.

property patternType: RecurPatternType

The type of recurrence pattern.

property patternTypeSpecific: Any

The specifics for the pattern type.

Return is different depending on what type of pattern is being used.

  • RecurPatternType.DAY: No value is returned.

  • RecurPatternType.WEEK: A set of RecurPatternTypeSpecificWeekday bits.

  • RecurPatternType.MONTH: The day of the month on which the recurrence falls.

  • RecurPatternType.MONTH_NTH: A tuple containing information from [MS-OXOCAL] PatternTypeSpecific MonthNth.

  • RecurPatternType.MONTH_END: The day of the month on which the recurrence falls.

  • RecurPatternType.HJ_MONTH: The day of the month on which the recurrence falls.

  • RecurPatternType.HJ_MONTH_NTH: A tuple containing information from [MS-OXOCAL] PatternTypeSpecific MonthNth.

  • RecurPatternType.HJ_MONTH_END: The day of the month on which the recurrence falls.

property period: int

An integer that specifies the interval at which the meeting pattern specified in PatternTypeSpecific field repeats.

The Period value MUST be between 1 and the maximum recurrence interval, which is 999 days for daily recurrences, 99 weeks for weekly recurrences, and 99 months for monthly recurrences.

property readerVersion: int
property recurFrequency: RecurFrequency

The frequency of the recurring series.

property slidingFlag: int
property startDate: int

An integer that specifies the date of the first occurrence.

The value is the number of minutes between midnight, January 1, 1601, and midnight of the date of the first occurrence.

property writerVersion: int