Outlook add-in API requirement set 1.3

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

Mailbox requirement set 1.3 includes all of the features of requirement set 1.2. It added the following features.

Added support for function commands. For more information, see Add-in commands.
Added a method to save an item being composed as a draft.
Added a method to close an item being composed.
Added methods to get or set the entire body of a message or appointment. For more information, see Get or set the body of a message or appointment in Outlook.
Added methods to convert item IDs between EWS and REST formats.

Important

Legacy Exchange Online user identity tokens and callback tokens are no longer supported and are turned off across all Microsoft 365 tenants. If an Outlook add-in requires delegated user access or user identity, we recommend using MSAL (Microsoft Authentication Library) and nested app authentication (NAA). Exchange user identity tokens are still supported for Exchange on-premises.
Added a property and methods to add, get, replace, and remove notification messages from an item.

API list

The following table lists the APIs introduced in Mailbox requirement set 1.3. To view API reference documentation for all APIs supported by Mailbox requirement set 1.3 or earlier, see Outlook APIs.

Class	Fields	Description
AppointmentCompose	close()	Closes the current item that is being composed.
	notificationMessages	Gets the notification messages for an item.
	saveAsync(callback: (asyncResult: Office.AsyncResult<string>) => void)	Asynchronously saves an item.
	saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void)	Asynchronously saves an item.
AppointmentRead	notificationMessages	Gets the notification messages for an item.
Body	getAsync(coercionType: Office.CoercionType \| string, callback?: (asyncResult: Office.AsyncResult<string>) => void)	Returns the entire current body in the format specified by `coercionType`.
	getAsync(coercionType: Office.CoercionType \| string, options: Office.AsyncContextOptions & { bodyMode?: MailboxEnums.BodyMode }, callback?: (asyncResult: Office.AsyncResult<string>) => void)	Returns the entire current body in the format specified by `coercionType`.
	setAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void)	Replaces the entire body with the specified text.
	setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions & { bodyMode?: MailboxEnums.BodyMode }, callback?: (asyncResult: Office.AsyncResult<void>) => void)	Replaces the entire body with the specified text.
Mailbox	convertToEwsId(id: string, restVersion: MailboxEnums.RestVersion \| string)	Converts a supported ID into the Exchange Web Services (EWS) format.
	convertToRestId(id: string, restVersion: MailboxEnums.RestVersion \| string)	Converts a supported ID into REST format.
MessageCompose	close()	Closes the current item that is being composed.
	notificationMessages	Gets the notification messages for an item.
	saveAsync(callback: (asyncResult: Office.AsyncResult<string>) => void)	Asynchronously saves the current message as a draft.
	saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void)	Asynchronously saves the current message as a draft.
MessageRead	notificationMessages	Gets the notification messages for an item.
NotificationMessageDetails	icon	A reference to a custom icon that's defined in the manifest.
	key	The identifier for the notification message.
	message	The text of the notification message.
	persistent	Specifies if the message should be persistent.
	type	Specifies the `ItemNotificationMessageType` of message.
NotificationMessages	addAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void)	Adds a notification to an item.
	addAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void)	Adds a notification to an item.
	getAllAsync(callback?: (asyncResult: Office.AsyncResult<NotificationMessageDetails[]>) => void)	Returns all keys and messages for an item.
	getAllAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<NotificationMessageDetails[]>) => void)	Returns all keys and messages for an item.
	removeAsync(key: string, callback?: (asyncResult: Office.AsyncResult<void>) => void)	Removes a notification message for an item.
	removeAsync(key: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void)	Removes a notification message for an item.
	replaceAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void)	Replaces a notification message that has a given key with another message.
	replaceAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void)	Replaces a notification message that has a given key with another message.
ItemNotificationMessageType	ErrorMessage	The notification message is an error message.
	InformationalMessage	The notification message is an informational message.
	ProgressIndicator	The notification message is a progress indicator.
RestVersion	Beta	Beta.
	v1_0	Version 1.0.
	v2_0	Version 2.0.

Feedback

Was this page helpful?

Last updated on 2026-02-06

Share via

Outlook add-in API requirement set 1.3

What's new in 1.3

API list

See also

Feedback

Additional resources