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?

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

• Added support for add-in commands.
• Added ability to save or close an item being composed.
• Enhanced Body object to allow add-ins to get or set the entire body.
• Added conversion methods to convert IDs between EWS and REST formats.
• Added ability to add notification messages to the info bar on items.

Change log

• Added Body.getAsync: Returns the current body in a specified format.
• Added Body.setAsync: Replaces the entire body with the specified text.
• Added Event object: Passed as a parameter to UI-less command functions in an Outlook add-in. Used to signal completion of processing.
• Added Office.context.mailbox.item.close: Closes the current item that is being composed.
• Added Office.context.mailbox.item.saveAsync: Asynchronously saves an item.
• Added Office.context.mailbox.item.notificationMessages: Gets the notification messages for an item.
• Added Office.context.mailbox.convertToEwsId: Converts a supported ID into EWS format.
• Added Office.context.mailbox.convertToRestId: Converts a supported ID into REST format.
• Added Office.MailboxEnums.ItemNotificationMessageType: Specifies the notification message type for an appointment or message.
• Added Office.MailboxEnums.RestVersion: Specifies the version of the REST API that corresponds to a REST-formatted item ID.
• Added NotificationMessages object: Provides methods for accessing notification messages in an Outlook add-in.
• Added NotificationMessageDetails type: Returned by the NotificationMessages.getAllAsync method.

See also

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