Outlook add-in API requirement set 1.5
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.5?
Requirement set 1.5 includes all of the features of requirement set 1.4. It added the following features.
- Added support for pinnable task panes.
- Added support for calling REST APIs.
- Added ability to mark an attachment as inline.
- Added ability to close a task pane or dialog.
- Added support for the Office.context.diagnostics property and its related objects.
Change log
- Added Office.context.mailbox.addHandlerAsync: Adds an event handler for a supported event.
- Added Office.context.mailbox.removeHandlerAsync: Removes the event handlers for a supported event type.
- Added Office.EventType: Specifies the event associated with an event handler and includes support for ItemChanged event.
- Added Office.context.mailbox.restUrl: Gets the URL of the REST endpoint for this email account.
- Modified Office.context.mailbox.getCallbackTokenAsync: A new version of this method with a new signature (
getCallbackTokenAsync([options], callback)) has been added. The original version is still available and is unchanged. - Added Office.context.ui.closeContainer.
- Modified Office.context.mailbox.item.addFileAttachmentAsync: A new value in the
optionsdictionary calledisInline, used to specify that an image is used inline in the message body. - Modified Office.context.mailbox.item.displayReplyAllForm: A new value in the
formData.attachmentsdictionary calledisInline, used to specify that an image is used inline in the message body. - Modified Office.context.mailbox.item.displayReplyForm: A new value in the
formData.attachmentsdictionary calledisInline, used to specify that an image is used inline in the message body. - Added Office.ContextInformation: Provides information about the environment in which the add-in is running.
- Added Office.context.diagnostics: Gets information about the environment in which the add-in is running, including host, platform, and version information.
- Added Office.context.host: Gets the Office application that is hosting the add-in.
- Added Office.context.platform: Gets the platform on which the add-in is running.
- Added Office.HostType: Specifies the host Office application in which the add-in is running.
- Added Office.PlatformType: Specifies the OS or other platform on which the Office host application is running.
See also
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Office Add-ins