outlook package

Interfaces

Office.Appointment	The subclass of Item dealing with appointments. Important: This is an internal Outlook object, not directly exposed through existing interfaces. You should treat this as a mode of Office.context.mailbox.item. For more information, refer to the Object Model page. Child interfaces: AppointmentCompose AppointmentRead
Office.AppointmentCompose	The appointment organizer mode of Office.context.mailbox.item. Important: This is an internal Outlook object, not directly exposed through existing interfaces. You should treat this as a mode of Office.context.mailbox.item. For more information, refer to the Object Model page. Parent interfaces: ItemCompose Appointment
Office.AppointmentForm	The AppointmentForm object is used to access the currently selected appointment.
Office.AppointmentRead	The appointment attendee mode of Office.context.mailbox.item. Important: This is an internal Outlook object, not directly exposed through existing interfaces. You should treat this as a mode of Office.context.mailbox.item. For more information, refer to the Object Model page. Parent interfaces: ItemRead Appointment
Office.AppointmentTimeChangedEventArgs	Provides the current dates and times of the appointment that raised the Office.EventType.AppointmentTimeChanged event.
Office.AttachmentContent	Represents the content of an attachment on a message or appointment item.
Office.AttachmentDetails	Represents an attachment on an item from the server. Read mode only. An array of AttachmentDetails objects is returned as the attachments property of an appointment or message item.
Office.AttachmentDetailsCompose	Represents an attachment on an item. Compose mode only. An array of AttachmentDetailsCompose objects is returned by the getAttachmentsAsync method.
Office.AttachmentsChangedEventArgs	Provides information about the attachment on a mail item that raised the Office.EventType.AttachmentsChanged event.
Office.Body	The body object provides methods for adding and updating the content of the message or appointment. It is returned in the body property of the selected item.
Office.Categories	Represents the categories on an item. In Outlook, a user can tag messages and appointments by using a category to color-code them. The user defines categories in a master list on their mailbox. They can then apply one or more categories to an item. Important: In Outlook on the web and new Outlook on Windows, you can't use the API to manage categories applied to a message in Compose mode.
Office.CategoryDetails	Represents a category's details like name and associated color.
Office.CoercionTypeOptions	Provides an option for the data format.
Office.Contact	Represents the details about a contact (similar to what's on a physical contact or business card) extracted from the item's body. Read mode only. The list of contacts extracted from the body of an email message or appointment is returned in the contacts property of the Entities object returned by the getEntities or getEntitiesByType method of the current item. Warning: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported. We recommend updating your contextual add-in to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see Contextual Outlook add-ins.
Office.CustomProperties	The CustomProperties object represents custom properties that are specific to a particular mail item and specific to an Outlook add-in. For example, there might be a need for an add-in to save some data that's specific to the current message that activated the add-in. If the user revisits the same message in the future and activates the add-in again, the add-in will be able to retrieve the data that had been saved as custom properties. To learn more about CustomProperties, see Get and set add-in metadata for an Outlook add-in.
Office.Diagnostics	Provides diagnostic information to an Outlook add-in.
Office.EmailAddressDetails	Provides the email properties of the sender or specified recipients of an email message or appointment.
Office.EmailUser	Represents an email account on an Exchange Server.
Office.EnhancedLocation	Represents the set of locations on an appointment.
Office.EnhancedLocationsChangedEventArgs	Provides the current enhanced locations when the Office.EventType.EnhancedLocationsChanged event is raised.
Office.Entities	Represents a collection of entities found in an email message or appointment. Read mode only. The Entities object is a container for the entity arrays returned by the getEntities and getEntitiesByType methods when the item (either an email message or an appointment) contains one or more entities that have been found by the server. You can use these entities in your code to provide additional context information to the viewer, such as a map to an address found in the item, or to open a dialer for a phone number found in the item. If no entities of the type specified in the property are present in the item, the property associated with that entity is null. For example, if a message contains a street address and a phone number, the addresses property and phoneNumbers property would contain information, and the other properties would be null. To be recognized as an address, the string must contain a United States postal address that has at least a subset of the elements of a street number, street name, city, state, and zip code. To be recognized as a phone number, the string must contain a North American phone number format. Entity recognition relies on natural language recognition that is based on machine learning of large amounts of data. The recognition of an entity is non-deterministic and success sometimes relies on the particular context in the item. When the property arrays are returned by the getEntitiesByType method, only the property for the specified entity contains data; all other properties are null. Warning: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported. We recommend updating your contextual add-in to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see Contextual Outlook add-ins.
Office.From	Provides a method to get the from value of a message in an Outlook add-in.
Office.InfobarClickedEventArgs	Provides basic details about the notification message that raised the Office.EventType.InfobarClicked event.
Office.InfobarDetails	Provides additional details about the notification message that raised the Office.EventType.InfobarClicked event.
Office.InternetHeaders	The InternetHeaders object represents custom internet headers that are preserved after the message item leaves Exchange and is converted to a MIME message. Internet headers are stored as string key-value pairs on a per-item basis. Note: This object is intended for you to set and get your custom headers on a message item. To learn more, see Get and set internet headers on a message in an Outlook add-in.
Office.Item	The item namespace is used to access the currently selected message, meeting request, or appointment. You can determine the type of the item by using the itemType property. To see the full member list, refer to the Object Model page. If you want to see IntelliSense for only a specific type or mode, cast this item to one of the following: AppointmentCompose AppointmentRead MessageCompose MessageRead
Office.ItemCompose	The compose mode of Office.context.mailbox.item. Important: This is an internal Outlook object, not directly exposed through existing interfaces. You should treat this as a mode of Office.context.mailbox.item. For more information, refer to the Object Model page. Child interfaces: AppointmentCompose MessageCompose
Office.ItemRead	The read mode of Office.context.mailbox.item. Important: This is an internal Outlook object, not directly exposed through existing interfaces. You should treat this as a mode of Office.context.mailbox.item. For more information, refer to the Object Model page. Child interfaces: AppointmentRead MessageRead
Office.LocalClientTime	Represents a date and time in the local client's time zone. Read mode only.
Office.Location	Provides methods to get and set the location of a meeting in an Outlook add-in.
Office.LocationDetails	Represents a location. Read-only.
Office.LocationIdentifier	Represents the ID of a location.
Office.Mailbox	Provides access to the Microsoft Outlook add-in object model. Key properties: diagnostics: Provides diagnostic information to an Outlook add-in. item: Provides methods and properties for accessing a message or appointment in an Outlook add-in. userProfile: Provides information about the user in an Outlook add-in.
Office.MailboxEvent	The MailboxEvent object is passed as an argument to the event handler of an add-in that implements event-based activation, including Smart Alerts, or the integrated spam-reporting feature. It allows the add-in to signify to the Outlook client that it has completed processing an event.
Office.MasterCategories	Represents the categories master list on the mailbox. In Outlook, a user can tag messages and appointments by using a category to color-code them. The user defines categories in a master list on their mailbox. They can then apply one or more categories to an item. Important: In delegate or shared scenarios, the delegate can get the categories in the master list but can't add or remove categories.
Office.MeetingSuggestion	Represents a suggested meeting found in an item. Read mode only. The list of meetings suggested in an email message is returned in the meetingSuggestions property of the Entities object that's returned when the getEntities or getEntitiesByType method is called on the active item. The start and end values are string representations of a Date object that contains the date and time at which the suggested meeting is to begin and end. The values are in the default time zone specified for the current user. Warning: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported. We recommend updating your contextual add-in to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see Contextual Outlook add-ins.
Office.Message	A subclass of Item for messages. Important: This is an internal Outlook object, not directly exposed through existing interfaces. You should treat this as a mode of Office.context.mailbox.item. For more information, refer to the Object Model page. Child interfaces: MessageCompose MessageRead
Office.MessageCompose	The message compose mode of Office.context.mailbox.item. Important: This is an internal Outlook object, not directly exposed through existing interfaces. You should treat this as a mode of Office.context.mailbox.item. For more information, refer to the Object Model page. When calling Office.context.mailbox.item on a message, note that the Reading Pane in the Outlook client must be turned on. For guidance on how to configure the Reading Pane, see Use and configure the Reading Pane to preview messages. Parent interfaces: ItemCompose Message
Office.MessageRead	The message read mode of Office.context.mailbox.item. Important: This is an internal Outlook object, not directly exposed through existing interfaces. You should treat this as a mode of Office.context.mailbox.item. For more information, refer to the Object Model page. When calling Office.context.mailbox.item on a message, note that the Reading Pane in the Outlook client must be turned on. For guidance on how to configure the Reading Pane, see Use and configure the Reading Pane to preview messages. Parent interfaces: ItemRead Message
Office.NotificationMessageAction	The definition of the action for a notification message.
Office.NotificationMessageDetails	An array of NotificationMessageDetails objects are returned by the NotificationMessages.getAllAsync method.
Office.NotificationMessages	The NotificationMessages object is returned as the notificationMessages property of an item.
Office.Organizer	Represents the appointment organizer, even if an alias or a delegate was used to create the appointment. This object provides a method to get the organizer value of an appointment in an Outlook add-in.
Office.PhoneNumber	Represents a phone number identified in an item. Read mode only. An array of PhoneNumber objects containing the phone numbers found in an email message is returned in the phoneNumbers property of the Entities object that's returned when you call the getEntities method on the selected item. Warning: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported. We recommend updating your contextual add-in to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see Contextual Outlook add-ins.
Office.Recipients	Represents recipients of an item. Compose mode only.
Office.RecipientsChangedEventArgs	Provides change status of recipients fields when the Office.EventType.RecipientsChanged event is raised.
Office.RecipientsChangedFields	Represents RecipientsChangedEventArgs.changedRecipientFields object.
Office.Recurrence	The Recurrence object provides methods to get and set the recurrence pattern of appointments but only get the recurrence pattern of meeting requests. It will have a dictionary with the following keys: seriesTime, recurrenceType, recurrenceProperties, and recurrenceTimeZone (optional).
Office.RecurrenceChangedEventArgs	Provides updated recurrence object that raised the Office.EventType.RecurrenceChanged event.
Office.RecurrenceProperties	Represents the properties of the recurrence.
Office.RecurrenceTimeZone	Represents the time zone of the recurrence.
Office.ReplyFormAttachment	A file or item attachment. Used when displaying a reply form.
Office.ReplyFormData	A ReplyFormData object that contains body or attachment data and a callback function. Used when displaying a reply form.
Office.RoamingSettings	The settings created by using the methods of the RoamingSettings object are saved per add-in and per user. That is, they are available only to the add-in that created them, and only from the user's mailbox in which they are saved. While the Outlook add-in API limits access to these settings to only the add-in that created them, these settings shouldn't be considered secure storage. They can be accessed by Exchange Web Services or Extended MAPI. They shouldn't be used to store sensitive information, such as user credentials or security tokens. The name of a setting is a String, while the value can be a String, Number, Boolean, null, Object, or Array. The RoamingSettings object is accessible via the roamingSettings property in the Office.context namespace. To learn more about RoamingSettings, see Get and set add-in metadata for an Outlook add-in.
Office.SeriesTime	The SeriesTime object provides methods to get and set the dates and times of appointments in a recurring series and get the dates and times of meeting requests in a recurring series.
Office.SharedProperties	Represents the properties of an appointment or message in a shared folder or shared mailbox. For more information on how this object is used, see Enable shared folders and shared mailbox scenarios in an Outlook add-in.
Office.Subject	Provides methods to get and set the subject of an appointment or message in an Outlook add-in.
Office.TaskSuggestion	Represents a suggested task identified in an item. Read mode only. The list of tasks suggested in an email message is returned in the taskSuggestions property of the Entities object that's returned when the getEntities or getEntitiesByType method is called on the active item. Warning: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported. We recommend updating your contextual add-in to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see Contextual Outlook add-ins.
Office.Time	The Time object is returned as the start or end property of an appointment in compose mode.
Office.UserProfile	Information about the user associated with the mailbox. This includes their account type, display name, email address, and time zone.

Enums

Office.MailboxEnums.ActionType	Specifies the type of custom action in a notification message.
Office.MailboxEnums.AttachmentContentFormat	Specifies the formatting that applies to an attachment's content.
Office.MailboxEnums.AttachmentStatus	Specifies whether an attachment was added to or removed from an item.
Office.MailboxEnums.AttachmentType	Specifies the attachment's type.
Office.MailboxEnums.CategoryColor	Specifies the category color.
Office.MailboxEnums.ComposeType	Specifies a message's compose type.
Office.MailboxEnums.Days	Specifies the day of week or type of day.
Office.MailboxEnums.DelegatePermissions	This bitmask represents a delegate's permissions on a shared folder.
Office.MailboxEnums.EntityType	Specifies an entity's type. Warning: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported. We recommend updating your contextual add-in to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see Contextual Outlook add-ins.
Office.MailboxEnums.InfobarActionType	Action types supported by Office.EventType.InfobarClicked.
Office.MailboxEnums.InfobarType	Type of notification allowed by Office.EventType.InfobarClicked.
Office.MailboxEnums.ItemNotificationMessageType	Specifies the notification message type for an appointment or message.
Office.MailboxEnums.ItemType	Specifies an item's type.
Office.MailboxEnums.LocationType	Specifies an appointment location's type.
Office.MailboxEnums.Month	Specifies the month.
Office.MailboxEnums.OpenLocation	Specifies the location from which an add-in wants to access data.
Office.MailboxEnums.OWAView	Represents the current view of Outlook on the web.
Office.MailboxEnums.RecipientType	Specifies the type of recipient of a message or appointment.
Office.MailboxEnums.RecurrenceTimeZone	Specifies the time zone applied to the recurrence.
Office.MailboxEnums.RecurrenceType	Specifies the type of recurrence.
Office.MailboxEnums.ResponseType	Specifies the type of response to a meeting invitation.
Office.MailboxEnums.RestVersion	Specifies the version of the REST API that corresponds to a REST-formatted item ID.
Office.MailboxEnums.SaveLocation	Specifies the location in which an add-in wants to save data.
Office.MailboxEnums.SourceProperty	Specifies the source of the selected data in an item (see Office.mailbox.item.getSelectedDataAsync for details).
Office.MailboxEnums.WeekNumber	Specifies the week of the month.