Edit

Share via

Outlook JavaScript APIs supported in Outlook on mobile devices

  • Article

Outlook on Android and on iOS support up to Mailbox requirement set 1.5. To further extend the capabilities of an Outlook mobile add-in, certain APIs from later requirement sets, previously available only to Outlook desktop and web clients, are now enabled for mobile support. This article outlines the APIs supported in Outlook mobile and any implementation exceptions.

Supported APIs

The following table lists a subset of APIs from requirement sets beyond 1.5 that can now be implemented in Outlook mobile add-ins. Even if the minimum requirement set specified in the manifest of your add-in is greater than 1.5, as long as the API used from the later requirement set is supported, the add-in will appear and activate in Outlook on Android or on iOS. For more information on how to specify the minimum requirement set in your add-in, see Outlook JavaScript API requirement sets.

API Minimum requirement set Supported Outlook modes Supported Outlook on mobile clients
Office.context.mailbox.getIsIdentityManaged Not applicable
  • Compose
  • Read
  • Android (Version 4.2443.0 or later)
  • iOS (Version 4.2443.0 or later)
Office.context.mailbox.getIsOpenFromLocationAllowed Not applicable
  • Compose
  • Read
  • Android (Version 4.2443.0 or later)
  • iOS (Version 4.2443.0 or later)
Office.context.mailbox.getIsSaveToLocationAllowed Not applicable
  • Compose
  • Read
  • Android (Version 4.2443.0 or later)
  • iOS (Version 4.2443.0 or later)
Office.context.mailbox.item.addFileAttachmentFromBase64Async Mailbox 1.8
  • Message Compose
  • Android (Version 4.2352.0 or later)
  • iOS (Version 4.2352.0 or later)
Office.context.mailbox.item.body.setSignatureAsync Mailbox 1.10
  • Message Compose
  • Android (Version 4.2352.0 or later)
  • iOS (Version 4.2352.0 or later)
Office.context.mailbox.item.disableClientSignatureAsync Mailbox 1.10
  • Message Compose
  • Android (Version 4.2352.0 or later)
  • iOS (Version 4.2352.0 or later)
Office.context.mailbox.item.from.getAsync Mailbox 1.7
  • Message Compose
  • Android (Version 4.2352.0 or later)
  • iOS (Version 4.2352.0 or later)
Office.context.mailbox.item.getComposeTypeAsync Mailbox 1.10
  • Message Compose
  • Android (Version 4.2352.0 or later)
  • iOS (Version 4.2352.0 or later)
Office.context.mailbox.item.internetHeaders.getAsync Mailbox 1.8
  • Message Compose
  • Android (Version 4.2405.0 or later)
  • iOS (Version 4.2405.0 or later)
Office.context.mailbox.item.internetHeaders.removeAsync Mailbox 1.8
  • Message Compose
  • Android (Version 4.2405.0 or later)
  • iOS (Version 4.2405.0 or later)
Office.context.mailbox.item.internetHeaders.setAsync Mailbox 1.8
  • Message Compose
  • Android (Version 4.2405.0 or later)
  • iOS (Version 4.2405.0 or later)
Office.context.mailbox.item.sessionData Mailbox 1.11
  • Message Compose
  • Android (Version 4.2425.0)
  • iOS (Version 4.2425.0)

Unsupported APIs

Although Outlook mobile supports up to requirement set 1.5, there are some APIs from these earlier requirement sets that aren't supported. The following table lists these APIs and also notes features that aren't supported in certain Outlook modes.

API Minimum requirement set Unsupported Outlook modes
Office.context.officeTheme Mailbox 1.14
  • Message Read
  • Message Compose
  • Appointment Attendee
  • Appointment Organizer
Office.context.mailbox.ewsUrl Mailbox 1.1
  • Message Read
  • Message Compose
  • Appointment Attendee
  • Appointment Organizer
Office.context.mailbox.convertToEwsId Mailbox 1.3
  • Message Read
  • Message Compose
  • Appointment Attendee
  • Appointment Organizer
Office.context.mailbox.convertToRestId Mailbox 1.3
  • Message Read
  • Message Compose
  • Appointment Attendee
  • Appointment Organizer
Office.context.mailbox.displayAppointmentForm Mailbox 1.1
  • Message Read
  • Message Compose
  • Appointment Attendee
  • Appointment Organizer
Office.context.mailbox.displayMessageForm Mailbox 1.1
  • Message Read
  • Message Compose
  • Appointment Attendee
  • Appointment Organizer
Office.context.mailbox.displayNewAppointmentForm Mailbox 1.1
  • Message Read
  • Appointment Attendee
Office.context.mailbox.getCallbackTokenAsync(options, callback) Mailbox 1.5
  • Message Compose
  • Appointment Organizer
Office.context.mailbox.getCallbackTokenAsync(callback, userContext) Mailbox 1.1 (Read mode support)

Mailbox 1.3 (Compose mode support)
  • Message Read
  • Message Compose
  • Appointment Attendee
  • Appointment Organizer
Office.context.mailbox.makeEwsRequestAsync Mailbox 1.1
  • Message Read
  • Message Compose
  • Appointment Attendee
  • Appointment Organizer
Office.context.mailbox.item.addFileAttachmentAsync Mailbox 1.1 (classic Windows, Mac)

Mailbox 1.8 (Web, new Windows)
  • Message Compose
  • Appointment Organizer
Office.context.mailbox.item.dateTimeModified Mailbox 1.1
  • Message Read
  • Appointment Attendee
Office.context.mailbox.item.displayReplyAllForm Mailbox 1.1
  • Message Read
  • Appointment Attendee
Office.context.mailbox.item.displayReplyForm Mailbox 1.1
  • Message Read
  • Appointment Attendee
Office.context.mailbox.item.getRegexMatches Mailbox 1.1
  • Message Read
  • Appointment Attendee
Office.context.mailbox.item.getRegexMatchesByName Mailbox 1.1
  • Message Read
  • Appointment Attendee
Office.context.mailbox.item.bcc.addAsync

Office.context.mailbox.item.cc.addAsync

Office.context.mailbox.item.to.addAsync		 Mailbox 1.1
  • Message Compose
Office.context.mailbox.item.bcc.setAsync

Office.context.mailbox.item.cc.setAsync

Office.context.mailbox.item.to.setAsync		 Mailbox 1.1
  • Message Compose
Office.context.mailbox.item.body.getTypeAsync Mailbox 1.1
  • Message Compose
Office.context.mailbox.item.body.prependAsync Mailbox 1.1
  • Message Compose
Office.context.mailbox.item.body.setAsync Mailbox 1.1
  • Message Compose
Office.context.mailbox.item.subject.setAsync Mailbox 1.1
  • Message Compose

See also