Outlook add-in API Preview requirement set

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.

Important

This documentation is for a preview requirement set. This requirement set is not fully implemented yet, and clients will not accurately report support for it. You should not specify this requirement set in your add-in manifest.

Note

Preview APIs are subject to change and are not intended for use in a production environment. We recommend that you try them out in test and development environments only. Do not use preview APIs in a production environment or within business-critical documents.

To use preview APIs:

Tip

You may be able to preview features in Outlook on the web by configuring targeted release on your Microsoft 365 tenant. "Configure preview access" is noted on this page for applicable features.

For other features, you may be able to request access to preview bits for Outlook on the web using your Microsoft 365 account by completing and submitting this form. "Request preview access" is noted on those features.

The Preview Requirement set includes all of the features of Requirement set 1.9.

Features in preview

The following features are in preview.

Add-in activation on items protected by Information Rights Management (IRM)

Add-ins can now activate on IRM-protected items. To turn on this capability, a tenant administrator needs to enable the OBJMODEL usage right by setting the Allow programmatic access custom policy option in Office. See Usage rights and descriptions for more information.

Available in: Outlook on Windows, starting with build 13229.10000 (connected to a Microsoft 365 subscription)




Additional calendar properties

IsAllDayEvent

Added a new object that represents the all-day event property of an appointment in Compose mode.

Available in: Outlook on Windows (connected to a Microsoft 365 subscription)

Sensitivity

Added a new object that represents the sensitivity of an appointment in Compose mode.

Available in: Outlook on Windows (connected to a Microsoft 365 subscription)

Office.context.mailbox.item.isAllDayEvent

Added a new property that represents if an appointment is an all-day event.

Available in: Outlook on Windows (connected to a Microsoft 365 subscription)

Office.context.mailbox.item.sensitivity

Added a new property that represents the sensitivity of an appointment.

Available in: Outlook on Windows (connected to a Microsoft 365 subscription)

Office.MailboxEnums.AppointmentSensitivityType

Added a new enum AppointmentSensitivityType that represents the sensitivity options available on an appointment.

Available in: Outlook on Windows (connected to a Microsoft 365 subscription)




Event-based activation

Added support for event-based activation functionality in Outlook add-ins. See Configure your Outlook add-in for event-based activation to learn more.

LaunchEvent extension point

Added LaunchEvent extension point support to manifest. It configures event-based activation functionality.

Available in: Outlook on Windows (connected to a Microsoft 365 subscription), Outlook on the web (modern, Configure preview access)

LaunchEvents manifest element

Added LaunchEvents element to manifest. It supports configuring event-based activation functionality.

Available in: Outlook on Windows (connected to a Microsoft 365 subscription), Outlook on the web (modern, Configure preview access)

Runtimes manifest element

Added Outlook support to the Runtimes manifest element. It references the HTML and JavaScript files needed for event-based activation functionality.

Available in: Outlook on Windows (connected to a Microsoft 365 subscription), Outlook on the web (modern, Configure preview access)




Integration with actionable messages

Office.context.mailbox.item.getInitializationContextAsync

Added a new function that returns initialization data passed when the add-in is activated by an actionable message.

Available in: Outlook on Windows (connected to a Microsoft 365 subscription), Outlook on the web (modern)




Mail signature

Office.context.mailbox.item.body.setSignatureAsync

Added a new function to the Body object that adds or replaces the signature in the item body in Compose mode.

Available in: Outlook on Windows (connected to a Microsoft 365 subscription), Outlook on the web (modern, Configure preview access)

Office.context.mailbox.item.disableClientSignatureAsync

Added a new function that disables the client signature for the sending mailbox in Compose mode.

Available in: Outlook on Windows (connected to a Microsoft 365 subscription), Outlook on the web (modern, Configure preview access)

Office.context.mailbox.item.getComposeTypeAsync

Added a new function that gets the compose type of a message in Compose mode.

Available in: Outlook on Windows (connected to a Microsoft 365 subscription), Outlook on the web (modern, Configure preview access)

Office.context.mailbox.item.isClientSignatureEnabledAsync

Added a new function that checks if the client signature is enabled on the item in Compose mode.

Available in: Outlook on Windows (connected to a Microsoft 365 subscription), Outlook on the web (modern, Configure preview access)

Office.MailboxEnums.ComposeType

Added a new enum ComposeType available in Compose mode.

Available in: Outlook on Windows (connected to a Microsoft 365 subscription), Outlook on the web (modern, Configure preview access)




Notification messages with actions

This feature allows your add-in to include a notification message with a custom action besides the default Dismiss action. In modern Outlook on the web, this feature is available in Compose mode only.

Office.NotificationMessageDetails.actions

Added a new property that enables you to add an InsightMessage notification with a custom action.

Available in: Outlook on Windows (connected to a Microsoft 365 subscription), Outlook on the web (modern)

Office.NotificationMessageAction

Added a new object where you define a custom action for your InsightMessage notification.

Available in: Outlook on Windows (connected to a Microsoft 365 subscription), Outlook on the web (modern)

Office.MailboxEnums.ActionType

Added a new enum ActionType.

Available in: Outlook on Windows (connected to a Microsoft 365 subscription), Outlook on the web (modern)

Office.MailboxEnums.ItemNotificationMessageType.InsightMessage

Added a new type InsightMessage to the ItemNotificationMessageType enum.

Available in: Outlook on Windows (connected to a Microsoft 365 subscription), Outlook on the web (modern)




Office theme

Office.context.officeTheme

Added ability to get Office theme.

Available in: Outlook on Windows (connected to a Microsoft 365 subscription)

Office.EventType.OfficeThemeChanged

Added OfficeThemeChanged event to Mailbox.

Available in: Outlook on Windows (connected to a Microsoft 365 subscription)




Session data

Office.SessionData

Added a new object that represents the session data of an item.

Available in: Outlook on Windows (connected to a Microsoft 365 subscription), Outlook on the web (modern)

Office.context.mailbox.item.sessionData

Added a new property to manage the session data of an item in Compose mode.

Available in: Outlook on Windows (connected to a Microsoft 365 subscription), Outlook on the web (modern)

See also