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

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

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

API list

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

Class Fields Description
AppointmentCompose disableClientSignatureAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void) Disables the Outlook client signature.
disableClientSignatureAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Disables the Outlook client signature.
isClientSignatureEnabledAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void) Gets if the client signature is enabled.
isClientSignatureEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void) Gets if the client signature is enabled.
Body setSignatureAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Adds a signature to the item body if it doesn't have an existing signature.
setSignatureAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Adds a signature to the item body if it doesn't have an existing signature.
InfobarClickedEventArgs infobarDetails Gets additional details about the notification message.
type Gets the type of the event.
InfobarDetails actionType The action type.
infobarType The notification type.
MailboxEvent completed() Indicates that the event-based or spam-reporting add-in has completed processing an event.
MessageCompose disableClientSignatureAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void) Disables the Outlook client signature.
disableClientSignatureAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Disables the Outlook client signature.
getComposeTypeAsync(callback: (asyncResult: Office.AsyncResult) => void) Specifies the type of message compose and its coercion type.
getComposeTypeAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void) Specifies the type of message compose and its coercion type.
isClientSignatureEnabledAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void) Gets if the client signature is enabled.
isClientSignatureEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void) Gets if the client signature is enabled.
NotificationMessageAction actionText The text of the action link.
actionType The type of action to be performed.
commandId The button defined in the manifest.
contextData Any JSON data the action button needs to pass on to the add-in.
NotificationMessageDetails actions Specifies actions for the message.
ActionType ShowTaskPane The showTaskPane action.
ComposeType Forward Forward.
NewMail New mail.
Reply Reply.
InfobarActionType Dismiss Dismiss action was selected.
InfobarType Error Notification displays an error message.
Informational Notification displays an informational message.
Insight Notification displays an informational message with actions.
ProgressIndicator Notification displays a progress indicator.
ItemNotificationMessageType InsightMessage The notification message is an informational message with actions.

Manifest updates

The following table lists manifest updates introduced in Mailbox requirement set 1.10. 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
Event-based activation "extensions.autoRunEvents" LaunchEvent extension point Configures event-based activation functionality.

See also

Feedback

Was this page helpful?

Additional resources

  • Last updated on