Outlook add-in API requirement set 1.13

The Outlook add-in API subset of the Office JavaScript API includes objects, methods, properties, and events that you can use in an Outlook add-in.

Note

This documentation is for a requirement set other than the latest requirement set.

What's new in 1.13?

Requirement set 1.13 includes all of the features of requirement set 1.12. It added the following features.

• Added support to activate an add-in without the Reading Pane enabled or a message selected.
• Added support to manage the delivery data and time of a message.
• Added new events for event-based activation.
• Added the item multi-select feature.
• Added the prepend-on-send feature.
• Added the sensitivity label feature.
• Added support for shared mailbox scenarios.

Change log

• Added the SupportsNoItemContext add-in only manifest element: Allows task pane add-ins to activate without the Reading Pane enabled or a message selected.
• Added Office.context.mailbox.item.delayDeliveryTime: Adds a property that provides the object to manage the delivery date and time of a message in compose mode.
• Added Office.DelayDeliveryTime: Adds an object to manage the delivery date and time of a message in compose mode.
• Added new events for event-based activation: Adds support for the following events.
  • OnMessageFromChanged
  • OnAppointmentFromChanged
  • OnSensitivityLabelChanged
• Added Office.context.mailbox.getSelectedItemsAsync: Adds a method to retrieve currently selected messages.
• Added Office.EventType.SelectedItemsChanged: Adds a new event to Mailbox. This event occurs when one or more messages are selected or deselected.
• Added Office.context.mailbox.item.body.prependOnSendAsync: Adds a method to prepend content to the beginning of a message or appointment body when the mail item is sent.
• Added Office.context.sensitivityLabelsCatalog: Adds a property that provides the object to check the status of the catalog of sensitivity labels and retrieve all available sensitivity labels if the catalog is enabled.
• Added Office.context.mailbox.item.sensitivityLabel: Adds a property that provides the object to get or set the sensitivity label of a message or appointment in compose mode.
• Added Office.EventType.SensitivityLabelChanged: Adds a new event to Item. This event occurs when the sensitivity label of a message or appointment is changed.
• Added Office.SensitivityLabelChangedEventArgs: Adds an object that provides the change status of the sensitivity label applied to a message or appointment in compose mode.
• Added Office.SensitivityLabelsCatalog: Adds an object that represents the catalog of sensitivity labels in Outlook.
• Added Office.SensitivityLabel: Adds an object that represents the sensitivity label of a message or appointment in compose mode.
• Added Office.SensitivityLabelDetails: Adds an object that represents the properties of a sensitivity label.
• Modified Office.context.mailbox.item.getSharedPropertiesAsync: Adds support for shared mailbox scenarios. This method gets an object that represents the shared properties of a message or appointment.
• Modified Office.SharedProperties: Adds support for shared mailbox scenarios. This object represents the properties of a message or appointment in a shared folder or shared mailbox.
• Modified the SupportsSharedFolders add-in only manifest element: Adds support for shared mailbox scenarios. This element defines whether the add-in is available in shared folder and shared mailbox scenarios.

See also

• Outlook add-ins
• Outlook add-in code samples
• Get started
• Requirement sets and supported clients