Edit

Outlook add-in API requirement set 1.16

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.

What's new in 1.16

Mailbox requirement set 1.16 includes all of the features of requirement set 1.15. It added the following features.

  • Added an event and objects to support decrypting a message and its attachments.
  • Extended support for the contentId property to get the content identifier of an inline attachment.
  • Added a method to check if Exchange Web Services (EWS) tokens are supported in an organization.
  • Updated the Recipients APIs to increase the maximum number of recipients you can retrieve from a target field.
  • Increased the SessionData object limit to 2,621,440 characters.

API list

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

Class Fields Description
AttachmentDetails contentId Gets the content identifier of an inline attachment.
AttachmentDetailsCompose contentId Gets the content identifier of an inline attachment.
DecryptedMessageAttachment attachmentType Specifies the type of attachment.
content Specifies the Base64-encoded content of the attachment.
contentId Specifies the content identifier of an inline attachment.
isInline If true, specifies that the decrypted attachment appears as an image in the body of the message instead of in the attachment list.
name Specifies the name of the attachment.
path Specifies the URL reference path of the attachment if its type is MailboxEnums.AttachmentType.Cloud.
DecryptedMessageBody coercionType Specifies the format of the body of a message.
content Specifies the content displayed in the body of the message.
Diagnostics ews Gets an object to identify whether Exchange Web Services (EWS) callback tokens are supported in an organization.
Ews getTokenStatusAsync(callback: (asyncResult: Office.AsyncResult<MailboxEnums.TokenStatus>) => void) Gets the status of EWS callback tokens in an organization.
getTokenStatusAsync(options: Office.AsyncContextOptions & { isRest?: boolean }, callback: (asyncResult: Office.AsyncResult<MailboxEnums.TokenStatus>) => void) Gets the status of EWS callback tokens in an organization.
MailboxEvent completed(options?: SmartAlertsEventCompletedOptions | SpamReportingEventCompletedOptions | MessageDecryptEventCompletedOptions) Indicates that the event-based, spam-reporting, or decryption add-in has completed processing an event.
MessageDecryptEventCompletedOptions allowEvent When you use the completed method to signal completion of an event handler,
attachments When you use the completed method to signal completion of an event handler
contextData When you use the completed method to signal completion of an event handler
emailBody When you use the completed method to signal completion of an event handler
TokenStatus Disabled EWS callback tokens or REST API tokens are turned off in the organization.
Enabled EWS callback tokens or REST API tokens are supported in the organization.
Removed The mailbox is hosted in an Exchange Online environment where EWS tokens are turned off and are no longer supported.

See also

  • Last updated on