Class Appointment

Represents a calendar appointment (IPM.Appointment) item, extending Message with appointment-specific properties defined in [MS-OXOCAL].

Inheritance
object
Message
Appointment
Meeting
PstAppointment
Inherited Members
Namespace: DRIT.Mail.Mapi.API
Assembly: DRIT.Mail.dll
Syntax
public class Appointment : Message

Constructors

View Source

Appointment(MapiAppointment)

Initialises a new instance of Appointment backed by the given MAPI appointment node.

Declaration
public Appointment(MapiAppointment mapiAppointment)
Parameters
Type Name Description
MapiAppointment mapiAppointment

The underlying MAPI appointment property accessor.

Properties

View Source

AllDayEvent

Gets or sets whether this appointment occupies the entire day.

Declaration
public bool? AllDayEvent { get; set; }
Property Value
Type Description
bool?
Remarks

Setting this to true normalises StartUTC and EndUTC to midnight. Reference: MS-OXOCAL 2.2.1.9 PidLidAppointmentSubType Property

Exceptions
Type Condition
InvalidOperationException

Thrown when neither StartUTC nor EndUTC is set.
View Source

AuxiliaryFlags

Gets the auxiliary flags for this appointment.

Declaration
public AppointmentAuxiliaryFlags AuxiliaryFlags { get; }
Property Value
Type Description
AppointmentAuxiliaryFlags
Remarks

Reference: MS-OXOCAL 2.2.1.21 PidLidAppointmentAuxiliaryFlags Property

View Source

BusyStatus

Gets or sets the busy status value.

Declaration
public BusyStatus? BusyStatus { get; set; }
Property Value
Type Description
BusyStatus?
View Source

Categories

Gets the list of keyword categories assigned to this appointment.

Declaration
public List<string> Categories { get; }
Property Value
Type Description
List<string>
Remarks

Reference: MS-OXOCAL PidLidKeywords (PidNameKeywords) Property

View Source

ClipEnd

Gets or sets the end date of the last instance of a recurring series, or the end date of a single appointment.

Declaration
public DateTime? ClipEnd { get; set; }
Property Value
Type Description
DateTime?
Remarks

Reference: MS-OXOCAL 2.2.1.25 PidLidClipEnd Property

View Source

ClipStart

Gets or sets the start date of the first instance of a recurring series, or the start date of a single appointment.

Declaration
public DateTime? ClipStart { get; set; }
Property Value
Type Description
DateTime?
Remarks

Reference: MS-OXOCAL 2.2.1.26 PidLidClipStart Property

View Source

Duration

Gets or sets the duration value.

Declaration
public TimeSpan? Duration { get; }
Property Value
Type Description
TimeSpan?
View Source

End

Gets or sets the end date and time of the appointment in the time zone specified by DRIT.Mail.Mapi.API.Appointment.EndTimeZoneDefinition.

Declaration
public DateTime? End { get; set; }
Property Value
Type Description
DateTime?
View Source

EndUTC

Gets or sets the end date and time of the appointment in UTC.

Declaration
public DateTime? EndUTC { get; set; }
Property Value
Type Description
DateTime?
Remarks

Reference: MS-OXOCAL 2.2.1.29 PidLidAppointmentEndWhole Property

View Source

IsRecurring

Gets or sets whether this appointment is part of a recurring series.

Declaration
public bool? IsRecurring { get; set; }
Property Value
Type Description
bool?
Remarks

Reference: MS-OXOCAL 2.2.1.44 PidLidIsRecurring Property

View Source

Location

Gets or sets the location of the appointment.

Declaration
public string Location { get; set; }
Property Value
Type Description
string
Remarks

Reference: MS-OXOCAL 2.2.1.4 PidLidLocation Property

View Source

ResponseStatus

Gets or sets the response status of an attendee.

Declaration
public ResponseStatus? ResponseStatus { get; set; }
Property Value
Type Description
ResponseStatus?
View Source

Sequence

Gets or sets the sequence number.

Declaration
public int? Sequence { get; set; }
Property Value
Type Description
int?
View Source

Start

Gets or sets the start date and time of the event.

Declaration
public DateTime? Start { get; set; }
Property Value
Type Description
DateTime?
View Source

StartUTC

Gets or sets the start date and time of the appointment in UTC.

Declaration
public DateTime? StartUTC { get; set; }
Property Value
Type Description
DateTime?
Remarks

Reference: MS-OXOCAL 2.2.1.27 PidLidAppointmentStartWhole Property

View Source

StateFlags

Gets a collection of flags describing the state of the appointment.

Declaration
public AppointmentStateFlags StateFlags { get; }
Property Value
Type Description
AppointmentStateFlags
View Source

UnsendableRecipients

Gets the list of recipients who could not be sent the meeting request, encoded as a recipient table.

Declaration
public AppointmentUnsendableRecipients UnsendableRecipients { get; }
Property Value
Type Description
AppointmentUnsendableRecipients
Remarks

Reference: MS-OXOCAL 2.2.4.9 PidLidAppointmentUnsendableRecipients Property

Methods

View Source

CreateNew(MapiAppointment, TimeZoneInfo)

Creates a new Appointment with default property values applied.

Declaration
public static Appointment CreateNew(MapiAppointment mapiAppointment, TimeZoneInfo timeZoneInfo)
Parameters
Type Name Description
MapiAppointment mapiAppointment

The underlying MAPI appointment node.
TimeZoneInfo timeZoneInfo

The time zone to use for start and end times.
Returns
Type Description
Appointment

A new Appointment instance with default values set.
View Source

Save()

Saves the data to the specified destination.

Declaration
public override void Save()
Overrides
View Source

SetDefaultValues()

Sets the default values.

Declaration
protected override void SetDefaultValues()
Overrides