Edit

Share via

Outlook add-in API requirement set 1.2

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

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

  • Added methods to get selected data from the subject or body of an appointment or message being composed.
  • Added methods to insert data at the user's cursor position in the subject or body of an appointment or message being composed.
  • Added a property to include attachments to a message reply form.

API list

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

Class Fields Description
AppointmentCompose getSelectedDataAsync(coercionType: Office.CoercionType | string, callback: (asyncResult: Office.AsyncResult<string>) => void) Asynchronously returns selected data from the subject or body of a message.
getSelectedDataAsync(coercionType: Office.CoercionType | string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void) Asynchronously returns selected data from the subject or body of a message.
setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Asynchronously inserts data into the body or subject of a message.
setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Asynchronously inserts data into the body or subject of a message.
MessageCompose getSelectedDataAsync(coercionType: Office.CoercionType | string, callback: (asyncResult: Office.AsyncResult) => void) Asynchronously returns selected data from the subject or body of a message.
getSelectedDataAsync(coercionType: Office.CoercionType | string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void) Asynchronously returns selected data from the subject or body of a message.
setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Asynchronously inserts data into the body or subject of a message.
setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Asynchronously inserts data into the body or subject of a message.
SourceProperty Body The source of the data is from the body of the item.
Subject The source of the data is from the subject of the item.
ReplyFormData attachments An array of ReplyFormAttachment that are Base64-encoded files, Exchange items, or file attachments.

See also

  • Last updated on