MapiCalendar

MapiCalendar class

Inherits: Aspose::Email::Mapi::MapiMessageItemBase

Represents a MAPI calendar item.

This class serves as a wrapper for MapiMessage to simplify the process of handling calendar information from MAPI properties. It provides a more intuitive interface for accessing and manipulating calendar data within the MAPI message.

The following example demonstrates how to get a MapiCalendar object from a MapiMessage .

var msg = MapiMessage.Load("calendar.msg");
 
// Check if the loaded message is a supported calendar type
if (msg.SupportedType == MapiItemType.Calendar)
{
 // Convert the MAPI message to a MapiCalendar object
    var mapiCalendar = (MapiCalendar)msg.ToMapiMessageItem();
 
 // Display some calendar info
    Console.WriteLine(mapiCalendar.Subject);
    Console.WriteLine(mapiCalendar.StartDate);
}

Dim msg = MapiMessage.Load("calendar.msg")
 
' Check if the loaded message is a supported calendar type
If msg.SupportedType = MapiItemType.Calendar Then
    ' Convert the MAPI message to a MapiCalendar object
    Dim mapiCalendar = DirectCast(msg.ToMapiMessageItem(), MapiCalendar)
 
 ' Display some calendar info
    Console.WriteLine(mapiCalendar.Subject)
    Console.WriteLine(mapiCalendar.StartDate)
End If

Constructors

NameDescription
MapiCalendar (8 overloads)Initializes a new instance of the MapiCalendar class

Methods

NameDescription
ConvertToMapiMessageConverts the task object to mapi message
DisposeReleases all resources.
get_AppointmentCounterProposalGets a value indicating whether a Meeting Response object is a counter proposal.
get_AttachmentsGets the attachment collection.
get_AttendeesGets the attendees
get_AuxiliaryFlagsGets the auxiliary state
get_BusyStatusGets the busy status
get_ClientIntentGets the actions the user has taken on this Meeting object.
get_EndDateGets the end date and time of the event. If the date is not set, default value for DateTime is returned.
get_EndDateTimeZoneGets time zone information that indicates the time zone of the EndDate property
get_IsAllDayGets a value indicating whether the event is an all-day event
get_KeyWordsGets the categories of the calendar object
get_LocationGets the location of the event
get_OrganizerGets the organizer.
get_RecurrenceGets the recurrence properties
get_ReminderDeltaGets the interval, in minutes, between the time at which the reminder first becomes overdue and the start time of the Calendar object
get_ReminderFileParameterSpecifies the full path of the sound that a client SHOULD play when the reminder becomes overdue.
get_ReminderSetGets a value indicating whether a reminder is set on the object
get_SequenceGets the sequence number
get_StartDateGets the start date and time of the event. If the date is not set, default value for DateTime is returned.
get_StartDateTimeZoneGets time zone information that indicates the time zone of the StartDate property
get_StateGets the state of the calendar object
get_UidGets the unique identifier
GetUnderlyingMessageRetrieves the underlying MapiMessage object.
Save (6 overloads)Saves calendar object to the file with iCalendar format using te default save options
set_AppointmentCounterProposalSets a value indicating whether a Meeting Response object is a counter proposal.
set_AttendeesSets the attendees
set_AuxiliaryFlagsSets the auxiliary state
set_BusyStatusSets the busy status
set_ClientIntentSets the actions the user has taken on this Meeting object.
set_EndDateSets the end date and time of the event. If the date is not set, default value for DateTime is returned.
set_EndDateTimeZoneSets time zone information that indicates the time zone of the EndDate property
set_IsAllDaySets a value indicating whether the event is an all-day event
set_KeyWordsSets the categories of the calendar object
set_LocationSets the location of the event
set_OrganizerSets the organizer.
set_RecurrenceSets the recurrence properties
set_ReminderDeltaSets the interval, in minutes, between the time at which the reminder first becomes overdue and the start time of the Calendar object
set_ReminderFileParameterSpecifies the full path of the sound that a client SHOULD play when the reminder becomes overdue.
set_ReminderSetSets a value indicating whether a reminder is set on the object
set_SequenceSets the sequence number
set_StartDateSets the start date and time of the event. If the date is not set, default value for DateTime is returned.
set_StartDateTimeZoneSets time zone information that indicates the time zone of the StartDate property
set_StateSets the state of the calendar object
set_UidGets the unique identifier
SetStateForcedSets the state of the calendar object, overriding any default behavior.
ToIcalendarConverts this MapiCalendar into CalendarObject