Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

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

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

  • Added support to append content to a mail item on send.
  • Added a method to get all custom properties of a mail item in a mailbox.
  • Added methods to display a new message or appointment form.
  • Added methods to display an existing message or appointment.
  • Added support for Dialog.messageChild to deliver a message from the host page, such as a task pane or a function command, to a dialog that was opened from the page.

API list

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

Class Fields Description
AppointmentRead displayReplyAllFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void) Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the
displayReplyAllFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the
displayReplyFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void) Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.
displayReplyFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.
Body appendOnSendAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Appends on send the specified content to the end of the item body, after any signature.
appendOnSendAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Appends on send the specified content to the end of the item body, after any signature.
CustomProperties getAll() Returns an object with all custom properties in a collection of name/value pairs.
Mailbox displayAppointmentFormAsync(itemId: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Displays an existing calendar appointment.
displayAppointmentFormAsync(itemId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Displays an existing calendar appointment.
displayMessageFormAsync(itemId: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Displays an existing message.
displayMessageFormAsync(itemId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Displays an existing message.
displayNewAppointmentFormAsync(parameters: AppointmentForm, callback?: (asyncResult: Office.AsyncResult<void>) => void) Displays a form for creating a new calendar appointment.
displayNewAppointmentFormAsync(parameters: AppointmentForm, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Displays a form for creating a new calendar appointment.
displayNewMessageFormAsync(parameters: MessageForm, callback?: (asyncResult: Office.AsyncResult<void>) => void) Displays a form for creating a new message.
displayNewMessageFormAsync(parameters: MessageForm, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Displays a form for creating a new message.
MessageRead displayReplyAllFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void) Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the
displayReplyAllFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the
displayReplyFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void) Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.
displayReplyFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.

Manifest updates

The following table lists manifest updates introduced in Mailbox requirement set 1.9. To learn more about the types of Office Add-in manifests, see Office Add-ins manifest.

Feature Unified manifest for Microsoft 365 Add-in only manifest Description
Append-on-send "authorization.permissions.resourceSpecific.name" set to "Mailbox.AppendOnSend.User" ExtendedPermissions element Enables support for the append-on-send feature.

See also

Feedback

Was this page helpful?

Additional resources

  • Last updated on