Outlook_1_5 package

Interfaces

Office.Appointment

The subclass of Office.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. Refer to the Object Model pages for more information.

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. Refer to the Object Model pages for more information.

Office.AppointmentForm

The AppointmentForm namespace is used to access the currently selected appointment.

[ API set: Mailbox 1.0 ]

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'. Refer to the Object Model pages for more information.

Office.AttachmentDetails

Represents an attachment on an item from the server. Read mode only.

An array of AttachmentDetail objects is returned as the attachments property of an Appointment or Message object.

[ API set: Mailbox 1.0 ]

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.

[ API set: Mailbox 1.1 ]

Office.CoercionTypeOptions

The subclass of Office.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. Refer to the Object Model pages for more information.

Office.Contact

Represents a contact stored on the server. Read mode only.

The list of contacts associated with an email message or appointment is returned in the contacts property of the Office.Entities object that is returned by the getEntities or getEntitiesByType method of the active item.

[ API set: Mailbox 1.0 ]

Office.CustomProperties

The CustomProperties object represents custom properties that are specific to a particular item and specific to a mail add-in for Outlook. For example, there might be a need for a mail add-in to save some data that is specific to the current email message that activated the add-in. If the user revisits the same message in the future and activates the mail add-in again, the add-in will be able to retrieve the data that had been saved as custom properties.

Because Outlook for Mac doesn't cache custom properties, if the user's network goes down, mail add-ins cannot access their custom properties.

[ API set: Mailbox 1.0 ]

Office.Diagnostics

Provides diagnostic information to an Outlook add-in.

[ API set: Mailbox 1.0 ]

Office.EmailAddressDetails

Provides the email properties of the sender or specified recipients of an email message or appointment.

[ API set: Mailbox 1.0 ]

Office.EmailUser

Represents an email account on an Exchange Server.

[ API set: Mailbox 1.0 ]

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.

[ API set: Mailbox 1.0 ]

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.

[ API set: Mailbox 1.0 ]

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. Refer to the Object Model pages for more information.

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. Refer to the Object Model pages for more information.

Office.LocalClientTime

Represents a date and time in the local client's time zone. Read mode only.

[ API set: Mailbox 1.0 ]

Office.Location

Provides methods to get and set the location of a meeting in an Outlook add-in.

[ API set: Mailbox 1.1 ]

Office.Mailbox

Provides access to the Outlook add-in object model for Microsoft Outlook and Microsoft Outlook on the web.

Namespaces:

  • 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.

[ API set: Mailbox 1.0 ]

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 is 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.

[ API set: Mailbox 1.0 ]

Office.Message

A subclass of Office.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. Refer to the Object Model pages for more information.

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. Refer to the Object Model pages for more information.

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. Refer to the Object Model pages for more information.

Office.NotificationMessageDetails

An array of NotificationMessageDetails objects are returned by the NotificationMessages.getAllAsync method.

[ API set: Mailbox 1.3 ]

Office.NotificationMessages

The NotificationMessages object is returned as the notificationMessages property of an item.

[ API set: Mailbox 1.3 ]

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 is returned when you call the getEntities method on the selected item.

[ API set: Mailbox 1.0 ]

Office.Recipients

[ API set: Mailbox 1.1 ]

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 mail box 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 should not be considered secure storage. They can be accessed by Exchange Web Services or Extended MAPI. They should not 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.

Important: The RoamingSettings object is initialized from the persisted storage only when the add-in is first loaded. For task panes, this means that it is only initialized when the task pane first opens. If the task pane navigates to another page or reloads the current page, the in-memory object is reset to its initial values, even if your add-in has persisted changes. The persisted changes will not be available until the task pane is closed and reopened.

[ API set: Mailbox 1.0 ]

Office.Subject

Provides methods to get and set the subject of an appointment or message in an Outlook add-in.

[ API set: Mailbox 1.1 ]

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]Entities object that is returned when the getEntities or getEntitiesByType method is called on the active item.

[ API set: Mailbox 1.0 ]

Office.Time

The Time object is returned as the start or end property of an appointment in compose mode.

[ API set: Mailbox 1.1 ]

Office.UserProfile

Information about the user associated with the mailbox. This includes their account type, display name, email adddress, and time zone.

[ API set: Mailbox 1.0 ]

Enums

Office.MailboxEnums.AttachmentType

Specifies an attachment's type.

[ API set: Mailbox 1.0 ]

Office.MailboxEnums.EntityType

Specifies an entity's type.

[ API set: Mailbox 1.0 ]

Office.MailboxEnums.ItemNotificationMessageType

Specifies the notification message type for an appointment or message.

[ API set: Mailbox 1.3 ]

Office.MailboxEnums.ItemType

Specifies an item's type.

[ API set: Mailbox 1.0 ]

Office.MailboxEnums.RecipientType

Specifies the type of recipient for an appointment.

[ API set: Mailbox 1.1 ]

Office.MailboxEnums.ResponseType

Specifies the type of response to a meeting invitation.

[ API set: Mailbox 1.0 ]

Office.MailboxEnums.RestVersion

Specifies the version of the REST API that corresponds to a REST-formatted item ID.

[ API set: Mailbox 1.3 ]

Office.SourceProperty

Specifies an attachment's type.

[ API set: Mailbox 1.0 ]