Aspose.Email.Mapi

The Aspose.Email.Mapi namespace contains classes that represent Outlook messages, contacts, appointments and classes for work with Microsoft Outlook PST\OST file format.

Classes

ClassDescription
ContactSaveOptionsServes as the abstract base class for contact save options when saving contact objects to various formats. This class provides common configuration properties such as save format and vCard version for contact serialization.
FileAccessViolationExceptionThis exception wile be thrown when the file open and locked by another caller.
FollowUpManagerProvides methods for managing Outlook follow-up flags, categories, and voting options on MAPI messages. This static class enables setting and removing follow-up flags, managing categories (keywords), setting due dates and reminders, and configuring voting buttons on MapiMessageItemBase objects.
FollowUpOptionsRepresents configuration options for follow-up flags, reminders, categories, and voting buttons in Outlook messages. This class encapsulates all the properties needed to set follow-up behavior on MapiMessage objects through the FollowUpManager class.
InlineAttachmentExtractorProvides ability to extract files from MSO packages. Can be used to process “oledata.mso” and similar files typically attached to messages created using Outlook.
KnownPropertyListThe read-only Master Property List provides implementers with a single source of information about all the properties that are described by the specifications that comprise the Exchange Server Protocols documentation (MS-OXPROPS). Coincides MS-OXPROPS revision 16.2 from 7/31/2014
KnownPropertySets[MS-OXCDATA]: Commonly Used Property Sets
MailConversionOptionsProvides options for controlling how MapiMessage instances are converted to MailMessage objects. This class allows you to customize the conversion behavior for TNEF handling, embedded message format preservation, RTF content, and email address management.
MapiAttachment
MapiAttachmentCollectionRepresents a strongly-typed collection of MapiAttachment objects that belong to a MAPI message or item. This collection class provides methods for adding, removing, and managing attachments in Outlook messages, including support for embedded messages and file attachments.
MapiAttachmentPropertyStreamRepresents the property stream of attachment object.
MapiCalendarRepresents a MAPI calendar item.
MapiCalendarAttendeesRepresents the attendees and related properties for a MAPI calendar item (meeting request, appointment). This class manages recipient information for calendar events, including required and optional attendees, unsendable recipients, and meeting-specific options like proposal restrictions.
MapiCalendarCollectionRepresents a strongly-typed collection of MapiCalendar objects for managing multiple calendar items in a single collection. This class provides standard collection operations while maintaining type safety for MAPI calendar entries.
MapiCalendarDailyRecurrencePatternRepresents a daily recurrence pattern for MAPI calendar items, allowing you to define how recurring meetings or events repeat on a daily basis. This class provides properties to configure the recurrence interval and specific days of the week for weekly-based daily patterns.
MapiCalendarEventRecurrenceRepresents the recurrence properties of a calendar object, including the recurrence pattern, time zone information, and the date range of recurrence. This class encapsulates all the data needed to define how recurring calendar events repeat over time.
MapiCalendarExceptionInfoAn exception specifies changes to an instance of a recurring series.
MapiCalendarIcsSaveOptionsProvides options for controlling how MapiCalendar instances are saved to iCalendar (ICS) format. This class extends MapiCalendarSaveOptions and adds iCalendar-specific configuration options for date/time handling and product identification.
MapiCalendarMonthlyNthRecurrencePatternRepresents a monthly recurrence pattern that occurs on the Nth occurrence of specific days of the week (e.g., “the 2nd Monday of each month”). This class inherits from MapiCalendarYearlyAndMonthlyRecurrencePattern and provides the base functionality for monthly recurrence patterns in MAPI calendar items.
MapiCalendarMonthlyRecurrencePatternRepresents a monthly recurrence pattern for MAPI calendar items, allowing events to repeat on a specific day of each month. This class inherits from MapiCalendarYearlyAndMonthlyRecurrencePattern and provides the base functionality for monthly recurrence patterns in MAPI calendar items.
MapiCalendarMsgSaveOptionsProvides options for controlling how MapiCalendar instances are saved to Outlook MSG format. This class extends MapiCalendarSaveOptions and is specifically designed for saving calendar items in the native Outlook message format.
MapiCalendarRecurrencePatternServes as the abstract base class for all MAPI calendar recurrence patterns. This class provides common properties and functionality for defining how calendar events repeat over time, including frequency, date ranges, occurrence counts, and exception handling.
MapiCalendarRecurrencePatternFactoryRepresents the factory of MapiCalendarRecurrencePattern
MapiCalendarSaveOptionsServes as the abstract base class for format-specific options when saving MapiCalendar objects to various formats (ICS, MSG). This class provides common configuration properties such as save format and factory methods for creating format-specific save options.
MapiCalendarTimeZoneRepresents the mapi calendar time zone information
MapiCalendarTimeZoneInfoRepresents the mapi calendar time zone rule
MapiCalendarTimeZoneInfoCollectionRepresents a collection of MapiCalendarTimeZoneInfo
MapiCalendarTimeZoneRuleRepresents time zone rule that indicate when to begin using the Standard/Daylight time.
MapiCalendarWeeklyRecurrencePatternRepresents a weekly recurrence pattern for MAPI calendar items, allowing events to repeat on specific days of the week at regular weekly intervals. This class provides properties to configure the recurrence interval and the specific days of the week when the event occurs.
MapiCalendarYearlyAndMonthlyRecurrencePatternRepresents the base class for yearly and monthly recurrence patterns in MAPI calendar items. This abstract class provides common properties and functionality for patterns that can recur either monthly (on a specific day) or yearly (on a specific day of a specific month).
MapiContactRepresents a MAPI contact item.
MapiContactAddressServes as the abstract base class for contact address types in MAPI contact items. This class provides common functionality for managing electronic addresses (MapiContactElectronicAddress) and physical addresses (MapiContactPhysicalAddress) through shared property access methods.
MapiContactCollectionRepresents a strongly-typed collection of MapiContact objects for managing multiple contacts in a single collection. This class provides standard collection operations while maintaining type safety for MAPI contact entries.
MapiContactElectronicAddressRepresents a group of properties that define an electronic address (email or fax) for a contact. This class provides functionality for managing contact email addresses and fax numbers through properties such as display name, address type, email address, and fax number.
MapiContactElectronicAddressPropertySetSpecify properties for up to three different e-mail addresses (Email1, Email2, and Email3) and three different fax addresses (Primary Fax, Business Fax, and Home Fax)
MapiContactEventPropertySetSpecify events associated with a contact
MapiContactNamePropertySetThe properties are used to specify the name of the person represented by the contact
MapiContactOtherPropertySetThe properties are used to specify additional properies of contact.
MapiContactPersonalInfoPropertySetSpecify other additional contact information
MapiContactPhotoContains data and type of contact’s photo.
MapiContactPhysicalAddressRepresents a group of properties that define a physical address for a contact. This class provides functionality for managing contact physical addresses through properties such as street, city, state, postal code, country, and mail address flags.
MapiContactPhysicalAddressPropertySetSpecify three physical addresses: Home Address, Work Address, and Other Address. One of the addresses can be marked as the Mailing Address
MapiContactProfessionalPropertySetProperties are used to store professional details for the person represented by the contact
MapiContactPropertySetBase class for all sets of MapiContact properties.
MapiContactSaveOptionsSpecifies the contact save options.
MapiContactTelephonePropertySetSpecify optional telephone numbers for the contact
MapiConversionOptionsThis class allows the user to specify additional options when converting from MailMessage to MapiMessage.
MapiDistributionListRepresents a MAPI distribution list item.
MapiDistributionListMemberRepresents the members of the personal distribution list.
MapiDistributionListMemberCollectionRepresents a collection of MapiDistributionListMember objects.
MapiDistributionListSaveOptionsSpecifies the DistributionList save options.
MapiElectronicAddressRefers to the group of properties that define the e-mail address or fax address.
MapiJournalRepresents a MAPI journal item.
MapiMessageRepresents an Outlook Message format document that can be parsed.
MapiMessageItemBaseRepresents the base class for all MapiMessageItem classes and keeps common collections of mapi properties, attachments, recipients.
MapiMessageParseExceptionThis exception is thrown when errors occur in parsing MapiMessage.
MapiMessagePropertyStreamRepresents the property stream.
MapiMessageReaderRepresents a reader that can read a Microsoft Outlook Message format document.
MapiNamedPropertyRepresents the data type of Named Property.
MapiNamedPropertyMappingStorageRepresents the named property mapping
MapiNoteRepresents a MAPI note (“sticky note”) item.
MapiObjectPropertyRepresents a Custom object included in Outlook Message documents.
MapiPropertyRepresents the mapi property.
MapiPropertyCollectionRepresents the collection of MapiProperty items.
MapiPropertyContainerRepresents the base class for MapiAttachment, MapiRecipient, MapiMessage.
MapiPropertyStreamRepresents the property stream.
MapiPropertyTagRepresents the MAPI property tags definition.
MapiRecipientRepresents the recipient information in the Microsoft Outlook Message.
MapiRecipientCollectionRepresents a collection of MapiRecipient objects.
MapiRecipientPropertyStreamRepresents the property stream of recipient object.
MapiTaskRepresents a MAPI task item.
MapiTaskCollectionRepresents the collection of MapiTask
MapiTaskUsersRepresents information about task users.
OleDocumentFormatRepresents the format for OLE document.
PidLidPropertyDescriptorContains descriptive information about a MAPI named property. This class provides properties and functionality for working with properties identified by a 32-bit long ID (LID) combined with a property set GUID, typically used for custom or non-standard MAPI properties.
PidNamePropertyDescriptorContains descriptive information about a MAPI named property identified by a string name. This class provides properties and functionality for working with properties identified by a string name combined with a property set GUID, typically used for custom or non-standard MAPI properties with string-based identifiers.
PidTagPropertyDescriptorContains descriptive information about a MAPI tagged property. This class provides properties and functionality for working with properties identified by a 16-bit property ID and 16-bit property type, typically used for standard MAPI properties.
PropertyDescriptorClass contains property description information.
ReferenceAttachmentOptionsRepresents configuration options for adding a reference attachment to a MAPI message.
UserReactionRepresents a user’s reaction.
WebDavContactSaveOptionsSpecifies the contact save options.

Interfaces

InterfaceDescription
IMapiMessageItemDefines the base interface for all Outlook message item types including messages, appointments, tasks, contacts, and notes. This interface provides common properties for accessing message class, item type, body content, and subject across different Outlook item types.
INamedPropertyTagProviderInterface of named mapi property tag provider.

Enumeration

EnumerationDescription
BodyContentTypeSpecifies the content type format of a message body in MAPI messages.
ContactSaveFormatEnumerates contact save formats
MapiCalendarBusyStatusEnumerates the mapi calendar possible busy status
MapiCalendarClientIntentEnumerates the actions the user can taken on the Meeting object
MapiCalendarDayOfWeekEnumerates the days of week of the mapi calendar recurrence pattern
MapiCalendarOverrideFlagsSpecifies what data in the MapiCalendarOverrideFlags structure has a value different from the recurring series.
MapiCalendarRecurrenceCalendarTypeSpecifies the calendar type used for MAPI calendar recurrence patterns. This enumeration supports multiple calendar systems including Gregorian, Hijri, Hebrew, lunar, and various regional calendars used around the world.
MapiCalendarRecurrenceEndTypeEnumerates the ending type for the recurrence.
MapiCalendarRecurrenceFrequencyEnumerates mapi calendar recurrence frequency
MapiCalendarRecurrencePatternTypeSpecifies the type of recurrence pattern for MAPI calendar items.
MapiCalendarStateEnumerates the appointment state
MapiCalendarTimeZoneFlagsEnumerates the individual bit flags that specify information about TimeZoneRule
MapiContactGenderGender of the contact
MapiContactPhotoImageFormatEnumerates MapiContact photo image format.
MapiDistributionListContactAddressTypeRepresents the address type of a personal distribution list member.
MapiDistributionListEntryIdTypeSpecifies the type of EntryID.
MapiItemTypeRepresents a MAPI item type that can be explicitly converted into an object of the corresponding class derived from the IMapiMessageItem interface.
MapiJournalDocumentStatusIndicates the status of document.
MapiJournalFlagsContains metadata about the Journal object. Must be either zero or the following values.
MapiMessageFlagsMapiMessageFlags.
MapiObjectTypeRepresents the mapi object type.
MapiPropertyTypeRepresents the data type of MapiProperty data.
MapiRecipientTrackStatusRepresents the response status returned by the attendee.
MapiRecipientTypeRepresent the PR_RECIPIENT_TYPE property which contains the recipient type for a message recipient.
MapiTaskAcceptanceStateIndicates the acceptance state of the task.
MapiTaskFlagsContains indication flags of the Task object.
MapiTaskHistoryIndicates the type of change that was last made to the Task object.
MapiTaskModeRepresents the assignment statuses of the task object.
MapiTaskOwnershipIndicates the role of the current user relative to the Task object.
MapiTaskPriorityRepresents the priority on the task.
MapiTaskStateIndicates the assignment state of the Task object.
MapiTaskStatusRepresents the statuses of the user’s progress on the task.
NoteColorSpecifies the suggested background color of the Note object
NoteSaveFormatEnumerates NoteSaveFormat
OutlookMessageFormatRepresents outlook message format.
PropertyDataType[MS-OXCDATA]: Data Structures
ReactionTypeSpecifies the type of reaction a user can have on a message.
TaskSaveFormatEnumerates TaskSaveFormat