Outlook add-in API requirement set 1.9

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.9?

Requirement set 1.9 includes all of the features of requirement set 1.8. It added the following features.

• Added new APIs for append-on-send, custom properties, and display form features.
• Added support for Dialog.messageChild.

Change log

• Added CustomProperties.getAll: Adds a new method to the CustomProperties object that gets all custom properties.
• Added Dialog.messageChild: Adds a new method that delivers a message from the host page, such as a task pane or a UI-less function file, to a dialog that was opened from the page.
• Added ExtendedPermissions manifest element: Adds a child element to the VersionOverrides manifest element. For an add-in to support the append-on-send feature, the AppendOnSend extended permission must be included in the collection of extended permissions.
• Added Office.context.mailbox.displayAppointmentFormAsync: Adds a new method to the Mailbox object that displays an existing appointment. This is the async version of the displayAppointmentForm method.
• Added Office.context.mailbox.displayMessageFormAsync: Adds a new method to the Mailbox object that displays an existing message. This is the async version of the displayMessageForm method.
• Added Office.context.mailbox.displayNewAppointmentFormAsync: Adds a new method to the Mailbox object that displays a new appointment form. This is the async version of the displayNewAppointmentForm method.
• Added Office.context.mailbox.displayNewMessageFormAsync: Adds a new method to the Mailbox object that displays a new message form. This is the async version of the displayNewMessageForm method.
• Added Office.context.mailbox.item.body.appendOnSendAsync: Adds a new method to the Body object that appends data to the end of the item body in Compose mode.
• Added Office.context.mailbox.item.displayReplyAllFormAsync: Adds a new method to the Item object that displays the "Reply all" form in Read mode. This is the async version of the displayReplyAllForm method.
• Added Office.context.mailbox.item.displayReplyFormAsync: Adds a new method to the Item object that displays the "Reply" form in Read mode. This is the async version of the displayReplyForm method.

See also

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