Office.Mailbox interface

Reference

Package:: outlook

Provides access to the Microsoft Outlook add-in object model.

Key properties:

diagnostics: Provides diagnostic information to an Outlook add-in.
item: Provides methods and properties for accessing a message or appointment in an Outlook add-in.
userProfile: Provides information about the user in an Outlook add-in.

Remarks

Minimum permission level: restricted

Applicable Outlook mode: Compose or Read

Examples

Office.onReady(() => {
    document.addEventListener('DOMContentLoaded', () => {
        // Get a reference to the mailbox and use it to add an event handler.
        const mailbox = Office.context.mailbox;
        mailbox.addHandlerAsync(Office.EventType.ItemChanged, loadNewItem, (result) => {
            if (result.status === Office.AsyncResultStatus.Failed) {
                // Handle error.
            }
        });
    });
});

function loadNewItem(eventArgs) {
    const item = Office.context.mailbox.item;

    // Check that item isn't null.
    if (item !== null) {
        // Work with item. For example, define and call a function that
        // loads the properties of the newly selected item.
        loadProps(item);
    }
}

Properties

diagnostics	Provides diagnostic information to an Outlook add-in. Contains the following members. `hostName` (string): A string that represents the name of the Office application. It should be one of the following values: `Outlook`, `newOutlookWindows`, `OutlookWebApp`, `OutlookIOS`, or `OutlookAndroid`. Note: The "Outlook" value is returned for Outlook on Windows (classic) and on Mac. `hostVersion` (string): A string that represents the version of either the Office application or the Exchange Server (e.g., "15.0.468.0"). If the mail add-in is running in Outlook on Windows (classic), on Mac, or on mobile devices, the `hostVersion` property returns the version of the Outlook client. In Outlook on the web and new Outlook on Windows, the property returns the version of the Exchange Server. `OWAView` (`MailboxEnums.OWAView` or string): An enum (or string literal) that represents the current view of Outlook on the web. If the application is not Outlook on the web, then accessing this property results in undefined. Outlook on the web has three views (`OneColumn` - displayed when the screen is narrow, `TwoColumns` - displayed when the screen is wider, and `ThreeColumns` - displayed when the screen is wide) that correspond to the width of the screen and the window, and the number of columns that can be displayed. More information is under Office.Diagnostics.
ewsUrl	Gets the URL of the Exchange Web Services (EWS) endpoint for this email account.
item	The mailbox item. Depending on the context in which the add-in opened, the item type may vary. If you want to see IntelliSense for only a specific type or mode, cast this item to one of the following: MessageCompose, MessageRead, AppointmentCompose, AppointmentRead Important: When calling `Office.context.mailbox.item` on a message, note that the Reading Pane in the Outlook client must be turned on. For guidance on how to configure the Reading Pane, see Use and configure the Reading Pane to preview messages. `item` can be null if your add-in supports pinning the task pane. For details on how to handle, see Implement a pinnable task pane in Outlook.
userProfile	Information about the user associated with the mailbox. This includes their account type, display name, email address, and time zone. More information is under Office.UserProfile

Methods

convertToEwsId(id, restVersion)	Converts a supported ID into the Exchange Web Services (EWS) format.
convertToLocalClientTime(timeValue)	Gets a dictionary containing time information in local client time. The time zone used by the Outlook client varies by platform. Outlook on Windows (classic) and on Mac use the client computer time zone. Outlook on the web and new Outlook on Windows use the time zone set on the Exchange Admin Center (EAC). You should handle date and time values so that the values you display on the user interface are always consistent with the time zone that the user expects. In Outlook on Windows (classic) and on Mac, the `convertToLocalClientTime` method returns a dictionary object with the values set to the client computer time zone. In Outlook on the web and new Outlook on Windows, the `convertToLocalClientTime` method returns a dictionary object with the values set to the time zone specified in the EAC.
convertToRestId(id, restVersion)	Converts a supported ID into REST format.
convertToUtcClientTime(input)	Gets a `Date` object from a dictionary containing time information. The `convertToUtcClientTime` method converts a dictionary containing a local date and time to a `Date` object with the correct values for the local date and time.
displayAppointmentForm(itemId)	Displays an existing calendar appointment. The `displayAppointmentForm` method opens an existing calendar appointment in a new window on the desktop. In Outlook on Mac, you can use this method to display a single appointment that isn't part of a recurring series, or the master appointment of a recurring series. However, you can't display an instance of the series because you can't access the properties (including the item ID) of instances of a recurring series. In Outlook on the web and new Outlook on Windows, this method opens the specified form only if the body of the form is less than or equal to 32K characters. If the specified item identifier does not identify an existing appointment, a blank pane opens on the client computer or device, and no error message is returned.
displayMessageForm(itemId)	Displays an existing message. The `displayMessageForm` method opens an existing message in a new window on the desktop. In Outlook on the web and new Outlook on Windows, this method opens the specified form only if the body of the form is less than or equal to 32K characters. If the specified item identifier doesn't identify an existing message, no message will be displayed on the client computer, and no error message is returned.
displayNewAppointmentForm(parameters)	Displays a form for creating a new calendar appointment. The `displayNewAppointmentForm` method opens a form that enables the user to create a new appointment or meeting. If parameters are specified, the appointment form fields are automatically populated with the contents of the parameters. In Outlook on the web and new Outlook on Windows, this method always displays a form with an attendees field. If you don't specify any attendees as input arguments, the method displays a form with a Save button. If you have specified attendees, the form would include the attendees and a Send button. In Outlook on Windows (classic) and on Mac, if you specify any attendees or resources in the `requiredAttendees`, `optionalAttendees`, or `resources` parameter, this method displays a meeting form with a Send button. If you don't specify any recipients, this method displays an appointment form with a Save & Close button. If any of the parameters exceed the specified size limits, or if an unknown parameter name is specified, an exception is thrown.
getCallbackTokenAsync(callback, userContext)	Gets a string that contains a token used to get an attachment or item from an Exchange Server. The `getCallbackTokenAsync` method makes an asynchronous call to get an opaque token from the Exchange Server that hosts the user's mailbox. The lifetime of the callback token is 5 minutes. The token is returned as a string in the `asyncResult.value` property.
getIsIdentityManaged()	Returns true if the current mailbox is managed by Microsoft Intune.
getIsOpenFromLocationAllowed(openLocation)	Returns true if an organization's Intune mobile application management (MAM) policy allows an add-in to access data from the specified location.
getIsSaveToLocationAllowed(saveLocation)	Returns true if an organization's Intune mobile application management (MAM) policy allows an add-in to save data to the specified location.
getUserIdentityTokenAsync(callback, userContext)	Gets a token identifying the user and the Office Add-in. The token is returned as a string in the `asyncResult.value` property.
makeEwsRequestAsync(data, callback, userContext)	Makes an asynchronous request to an Exchange Web Services (EWS) service on the Exchange server that hosts the user's mailbox. The `makeEwsRequestAsync` method sends an EWS request on behalf of the add-in to Exchange.

Property Details

diagnostics

Provides diagnostic information to an Outlook add-in.

Contains the following members.

hostName (string): A string that represents the name of the Office application. It should be one of the following values: Outlook, newOutlookWindows, OutlookWebApp, OutlookIOS, or OutlookAndroid. Note: The "Outlook" value is returned for Outlook on Windows (classic) and on Mac.
hostVersion (string): A string that represents the version of either the Office application or the Exchange Server (e.g., "15.0.468.0"). If the mail add-in is running in Outlook on Windows (classic), on Mac, or on mobile devices, the hostVersion property returns the version of the Outlook client. In Outlook on the web and new Outlook on Windows, the property returns the version of the Exchange Server.
OWAView (MailboxEnums.OWAView or string): An enum (or string literal) that represents the current view of Outlook on the web. If the application is not Outlook on the web, then accessing this property results in undefined. Outlook on the web has three views (OneColumn - displayed when the screen is narrow, TwoColumns - displayed when the screen is wider, and ThreeColumns - displayed when the screen is wide) that correspond to the width of the screen and the window, and the number of columns that can be displayed.

More information is under Office.Diagnostics.

diagnostics: Diagnostics;

Property Value

Office.Diagnostics

Remarks

Minimum permission level: read item

Applicable Outlook mode: Compose or Read

Starting with Mailbox requirement set 1.5, you can also use the Office.context.diagnostics property to get similar information.

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-diagnostic-information.yaml

// This function gets a mailbox's diagnostic information, such as Outlook client and version, and logs it to the console.
const diagnostics = Office.context.mailbox.diagnostics;
console.log(`Client application: ${diagnostics.hostName}`);
console.log(`Client version: ${diagnostics.hostVersion}`);

switch (diagnostics.OWAView) {
  case undefined:
    console.log("Current view (Outlook on the web only): Not applicable. An Outlook desktop client is in use.");
    break;
  case Office.MailboxEnums.OWAView.OneColumnNarrow:
    console.log("Current view (Outlook on the web only): Viewed from an older generation mobile phone");
    break;
  case Office.MailboxEnums.OWAView.OneColumn:
    console.log("Current view (Outlook on the web only): Viewed from a newer generation mobile phone");
    break;
  case Office.MailboxEnums.OWAView.TwoColumns:
    console.log("Current view (Outlook on the web only): Viewed from a tablet");
    break;
  case Office.MailboxEnums.OWAView.ThreeColumns:
    console.log("Current view (Outlook on the web only): Viewed from a desktop computer");
    break;
}

ewsUrl

Gets the URL of the Exchange Web Services (EWS) endpoint for this email account.

ewsUrl: string;

Property Value

string

Remarks

[ API set: Mailbox 1.1 ]

Minimum permission level: read item

Applicable Outlook mode: Compose or Read

Important:

Your app must have the read item permission specified in its manifest to call the ewsUrl member in read mode.
In compose mode, you must call the saveAsync method before you can use the ewsUrl member. Your app must have read/write item permissions to call the saveAsync method.
This property isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see Outlook JavaScript APIs supported in Outlook on mobile devices.
The ewsUrl value can be used by a remote service to make EWS calls to the user's mailbox. For example, you can create a remote service to get attachments from the selected item.

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/85-tokens-and-service-calls/ids-and-urls.yaml

// Get the EWS URL and EWS item ID.
console.log("EWS URL: " + Office.context.mailbox.ewsUrl);
const ewsId = Office.context.mailbox.item.itemId;
console.log("EWS item ID: " + Office.context.mailbox.item.itemId);

// Convert the EWS item ID to a REST-formatted ID.
const restId = Office.context.mailbox.convertToRestId(ewsId, Office.MailboxEnums.RestVersion.v2_0);
console.log("REST item ID: " + restId);

// Convert the REST-formatted ID back to an EWS-formatted ID.
const ewsId2 = Office.context.mailbox.convertToEwsId(restId, Office.MailboxEnums.RestVersion.v2_0);
console.log("EWS ID (from REST ID): " + ewsId2);

item

The mailbox item. Depending on the context in which the add-in opened, the item type may vary. If you want to see IntelliSense for only a specific type or mode, cast this item to one of the following:

MessageCompose, MessageRead, AppointmentCompose, AppointmentRead

Important:

When calling Office.context.mailbox.item on a message, note that the Reading Pane in the Outlook client must be turned on. For guidance on how to configure the Reading Pane, see Use and configure the Reading Pane to preview messages.
item can be null if your add-in supports pinning the task pane. For details on how to handle, see Implement a pinnable task pane in Outlook.

item?: Item & ItemCompose & ItemRead & Message & MessageCompose & MessageRead & Appointment & AppointmentCompose & AppointmentRead;

Property Value

Office.Item & Office.ItemCompose & Office.ItemRead & Office.Message & Office.MessageCompose & Office.MessageRead & Office.Appointment & Office.AppointmentCompose & Office.AppointmentRead

userProfile

Information about the user associated with the mailbox. This includes their account type, display name, email address, and time zone.

More information is under Office.UserProfile

userProfile: UserProfile;

Property Value

Office.UserProfile

Method Details

convertToEwsId(id, restVersion)

Converts a supported ID into the Exchange Web Services (EWS) format.

convertToEwsId(id: string, restVersion: MailboxEnums.RestVersion | string): string;

Parameters

id: string

The ID to be converted into EWS format. This string can be an item ID formatted for the Outlook REST APIs or a conversation ID retrieved from Office.context.mailbox.item.conversationId.

restVersion: Office.MailboxEnums.RestVersion | string

A value indicating the version of the Outlook REST API used to retrieve the item ID.

Returns

string

Remarks

[ API set: Mailbox 1.3 ]

Minimum permission level: restricted

Applicable Outlook mode: Compose or Read

Important:

In February 2025, legacy Exchange user identity and callback tokens will be turned off by default for all Exchange Online tenants. This is part of Microsoft's Secure Future Initiative, which gives organizations the tools needed to respond to the current threat landscape. Exchange user identity tokens will still work for Exchange on-premises. Nested app authentication (NAA) is the recommended approach for tokens going forward. For more information, see the FAQ page.
This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see Outlook JavaScript APIs supported in Outlook on mobile devices.
Item IDs retrieved via a REST API (such as Microsoft Graph) use a different format than the format used by EWS. The convertToEwsId method converts a REST-formatted ID into the proper format for EWS.

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/85-tokens-and-service-calls/ids-and-urls.yaml

// Get the EWS URL and EWS item ID.
console.log("EWS URL: " + Office.context.mailbox.ewsUrl);
const ewsId = Office.context.mailbox.item.itemId;
console.log("EWS item ID: " + Office.context.mailbox.item.itemId);

// Convert the EWS item ID to a REST-formatted ID.
const restId = Office.context.mailbox.convertToRestId(ewsId, Office.MailboxEnums.RestVersion.v2_0);
console.log("REST item ID: " + restId);

// Convert the REST-formatted ID back to an EWS-formatted ID.
const ewsId2 = Office.context.mailbox.convertToEwsId(restId, Office.MailboxEnums.RestVersion.v2_0);
console.log("EWS ID (from REST ID): " + ewsId2);

convertToLocalClientTime(timeValue)

Gets a dictionary containing time information in local client time.

The time zone used by the Outlook client varies by platform. Outlook on Windows (classic) and on Mac use the client computer time zone. Outlook on the web and new Outlook on Windows use the time zone set on the Exchange Admin Center (EAC). You should handle date and time values so that the values you display on the user interface are always consistent with the time zone that the user expects.

In Outlook on Windows (classic) and on Mac, the convertToLocalClientTime method returns a dictionary object with the values set to the client computer time zone. In Outlook on the web and new Outlook on Windows, the convertToLocalClientTime method returns a dictionary object with the values set to the time zone specified in the EAC.

convertToLocalClientTime(timeValue: Date): LocalClientTime;

Parameters

timeValue: Date

A Date object.

Returns

Office.LocalClientTime

Remarks

Minimum permission level: read item

Applicable Outlook mode: Compose or Read

convertToRestId(id, restVersion)

Converts a supported ID into REST format.

convertToRestId(id: string, restVersion: MailboxEnums.RestVersion | string): string;

Parameters

id: string

The ID to be converted into REST format. This string can be an item ID formatted for EWS that's usually retrieved from Office.context.mailbox.item.itemId, a conversation ID retrieved from Office.context.mailbox.item.conversationId, or a series ID retrieved from Office.context.mailbox.item.seriesId.

restVersion: Office.MailboxEnums.RestVersion | string

A value indicating the version of the Outlook REST API used with the converted ID.

Returns

string

Remarks

[ API set: Mailbox 1.3 ]

Minimum permission level: restricted

Applicable Outlook mode: Compose or Read

Important:

This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see Outlook JavaScript APIs supported in Outlook on mobile devices.
Item IDs retrieved via Exchange Web Services (EWS) or via the itemId property use a different format than the format used by REST APIs (such as Microsoft Graph). The convertToRestId method converts an EWS-formatted ID into the proper format for REST.

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/85-tokens-and-service-calls/ids-and-urls.yaml

// Get the EWS URL and EWS item ID.
console.log("EWS URL: " + Office.context.mailbox.ewsUrl);
const ewsId = Office.context.mailbox.item.itemId;
console.log("EWS item ID: " + Office.context.mailbox.item.itemId);

// Convert the EWS item ID to a REST-formatted ID.
const restId = Office.context.mailbox.convertToRestId(ewsId, Office.MailboxEnums.RestVersion.v2_0);
console.log("REST item ID: " + restId);

// Convert the REST-formatted ID back to an EWS-formatted ID.
const ewsId2 = Office.context.mailbox.convertToEwsId(restId, Office.MailboxEnums.RestVersion.v2_0);
console.log("EWS ID (from REST ID): " + ewsId2);

convertToUtcClientTime(input)

Gets a Date object from a dictionary containing time information.

The convertToUtcClientTime method converts a dictionary containing a local date and time to a Date object with the correct values for the local date and time.

convertToUtcClientTime(input: LocalClientTime): Date;

Parameters

input: Office.LocalClientTime

The local time value to convert.

Returns

Date

A Date object with the time expressed in UTC.

Remarks

Minimum permission level: read item

Applicable Outlook mode: Compose or Read

Examples

// Represents 3:37 PM PDT on Monday, August 26, 2019.
const input = {
    date: 26,
    hours: 15,
    milliseconds: 2,
    minutes: 37,
    month: 7,
    seconds: 2,
    timezoneOffset: -420,
    year: 2019
};

// result should be a Date object.
const result = Office.context.mailbox.convertToUtcClientTime(input);

// Output should be "2019-08-26T22:37:02.002Z".
console.log(result.toISOString());

displayAppointmentForm(itemId)

Displays an existing calendar appointment.

The displayAppointmentForm method opens an existing calendar appointment in a new window on the desktop.

In Outlook on Mac, you can use this method to display a single appointment that isn't part of a recurring series, or the master appointment of a recurring series. However, you can't display an instance of the series because you can't access the properties (including the item ID) of instances of a recurring series.

In Outlook on the web and new Outlook on Windows, this method opens the specified form only if the body of the form is less than or equal to 32K characters.

If the specified item identifier does not identify an existing appointment, a blank pane opens on the client computer or device, and no error message is returned.

displayAppointmentForm(itemId: string): void;

Parameters

itemId: string

The Exchange Web Services (EWS) identifier for an existing calendar appointment.

Returns

void

Remarks

[ API set: Mailbox 1.1 ]

Minimum permission level: read item

Applicable Outlook mode: Compose or Read

Important: This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see Outlook JavaScript APIs supported in Outlook on mobile devices.

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-existing-appointment.yaml

const itemId = $("#itemId").val();
Office.context.mailbox.displayAppointmentForm(itemId);

displayMessageForm(itemId)

Displays an existing message.

The displayMessageForm method opens an existing message in a new window on the desktop.

In Outlook on the web and new Outlook on Windows, this method opens the specified form only if the body of the form is less than or equal to 32K characters.

If the specified item identifier doesn't identify an existing message, no message will be displayed on the client computer, and no error message is returned.

displayMessageForm(itemId: string): void;

Parameters

itemId: string

The Exchange Web Services (EWS) identifier for an existing message.

Returns

void

Remarks

[ API set: Mailbox 1.1 ]

Minimum permission level: read item

Applicable Outlook mode: Compose or Read

Important:

This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see Outlook JavaScript APIs supported in Outlook on mobile devices.
Don't use the displayMessageForm with an itemId that represents an appointment. Use the displayAppointmentForm method to display an existing appointment, and displayNewAppointmentForm to display a form to create a new appointment.

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-existing-message.yaml

const itemId = $("#itemId").val();
Office.context.mailbox.displayMessageForm(itemId);

displayNewAppointmentForm(parameters)

Displays a form for creating a new calendar appointment.

The displayNewAppointmentForm method opens a form that enables the user to create a new appointment or meeting. If parameters are specified, the appointment form fields are automatically populated with the contents of the parameters.

In Outlook on the web and new Outlook on Windows, this method always displays a form with an attendees field. If you don't specify any attendees as input arguments, the method displays a form with a Save button. If you have specified attendees, the form would include the attendees and a Send button.

In Outlook on Windows (classic) and on Mac, if you specify any attendees or resources in the requiredAttendees, optionalAttendees, or resources parameter, this method displays a meeting form with a Send button. If you don't specify any recipients, this method displays an appointment form with a Save & Close button.

If any of the parameters exceed the specified size limits, or if an unknown parameter name is specified, an exception is thrown.

displayNewAppointmentForm(parameters: AppointmentForm): void;

Parameters

parameters: Office.AppointmentForm

An AppointmentForm describing the new appointment. All properties are optional.

Returns

void

Remarks

[ API set: Mailbox 1.1 ]

Minimum permission level: read item

Applicable Outlook mode: Read

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-new-appointment.yaml

const start = new Date();
const end = new Date();
end.setHours(start.getHours() + 1);

Office.context.mailbox.displayNewAppointmentForm({
  requiredAttendees: ["bob@contoso.com"],
  optionalAttendees: ["sam@contoso.com"],
  start: start,
  end: end,
  location: "Home",
  subject: "meeting",
  resources: ["projector@contoso.com"],
  body: "Hello World!"
});

getCallbackTokenAsync(callback, userContext)

Gets a string that contains a token used to get an attachment or item from an Exchange Server.

The getCallbackTokenAsync method makes an asynchronous call to get an opaque token from the Exchange Server that hosts the user's mailbox. The lifetime of the callback token is 5 minutes.

The token is returned as a string in the asyncResult.value property.

getCallbackTokenAsync(callback: (asyncResult: Office.AsyncResult<string>) => void, userContext?: any): void;

Parameters

callback: (asyncResult: Office.AsyncResult<string>) => void

When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. The token is returned as a string in the asyncResult.value property. If there was an error, the asyncResult.error and asyncResult.diagnostics properties may provide additional information.

userContext: any

Optional. Any state data that is passed to the asynchronous method.

Returns

void

Remarks

[ API set: All support Read mode; Mailbox 1.3 introduced Compose mode support ]

Minimum permission level: read item

Applicable Outlook mode: Compose or Read

Important:

In February 2025, legacy Exchange user identity and callback tokens will be turned off by default for all Exchange Online tenants. This is part of Microsoft's Secure Future Initiative, which gives organizations the tools needed to respond to the current threat landscape. Exchange user identity tokens will still work for Exchange on-premises. Nested app authentication (NAA) is the recommended approach for tokens going forward. For more information, see the FAQ page.
You can pass both the token and either an attachment identifier or item identifier to an external system. That system uses the token as a bearer authorization token to call the Exchange Web Services (EWS) GetAttachment or GetItem operation to return an attachment or item. For example, you can create a remote service to get attachments from the selected item.
Calling the getCallbackTokenAsync method in read mode requires a minimum permission level of read item.
Calling the getCallbackTokenAsync method in compose mode requires you to have saved the item. The saveAsync method requires a minimum permission level of read/write item.
This method isn't supported in Outlook on Android or on iOS. EWS operations aren't supported in add-ins running in Outlook on mobile clients. For more information on supported APIs in Outlook mobile, see Outlook JavaScript APIs supported in Outlook on mobile devices.
This method isn't supported if you load an add-in in an Outlook.com or Gmail mailbox.
For guidance on delegate or shared scenarios, see the shared folders and shared mailbox article.

Errors:

If your call fails, use the asyncResult.diagnostics property to view details about the error.

GenericTokenError: An internal error has occurred. - In Exchange Online environments, this error occurs when the token can't be retrieved because legacy Exchange tokens for Outlook add-ins are turned off. We recommend using NAA as a single sign-on solution for your add-in. For guidance on how to implement NAA, see the FAQ page.
HTTPRequestFailure: The request has failed. Please look at the diagnostics object for the HTTP error code.
InternalServerError: The Exchange server returned an error. Please look at the diagnostics object for more information. - In Exchange Online environments, this error occurs when the token can't be retrieved because legacy Exchange tokens for Outlook add-ins are turned off. We recommend using NAA as a single sign-on solution for your add-in. For guidance on how to implement NAA, see the FAQ page.
NetworkError: The user is no longer connected to the network. Please check your network connection and try again.

getIsIdentityManaged()

Returns true if the current mailbox is managed by Microsoft Intune.

getIsIdentityManaged(): boolean;

Returns

boolean

True if the current mailbox is managed by Microsoft Intune.

Remarks

Minimum permission level: read item

Applicable Outlook mode: Compose, Read

Important: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To learn more about APIs supported in Outlook on mobile devices, see Outlook JavaScript APIs supported in Outlook on mobile devices.

Errors:

MAMServiceNotAvailable: The client is unable to fetch the mobile application management (MAM) policy.

Examples

// Checks if the mailbox is managed by Microsoft Intune.
const isIdentityManaged = Office.context.mailbox.getIsIdentityManaged();
console.log(`Intune-managed mailbox: ${isIdentityManaged}`);

getIsOpenFromLocationAllowed(openLocation)

Returns true if an organization's Intune mobile application management (MAM) policy allows an add-in to access data from the specified location.

getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean;

Parameters

openLocation: Office.MailboxEnums.OpenLocation

The location from which the add-in is attempting to access data.

Returns

boolean

True if an organization's Intune MAM policy allows an add-in to access data from the specified location.

Remarks

Minimum permission level: read item

Applicable Outlook mode: Compose, Read

Important: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see Outlook JavaScript APIs supported in Outlook on mobile devices.

Errors:

InvalidOpenLocationInput: The value of the specified location is invalid.
MAMServiceNotAvailable: The client is unable to fetch the MAM policy.

Examples

// Checks if the add-in can access data from the device's photo library.
const isOpenFromPhotoLibraryAllowed = Office.context.mailbox.getIsOpenFromLocationAllowed(Office.MailboxEnums.OpenLocation.PhotoLibrary);
if (isOpenFromPhotoLibraryAllowed) {
    console.log("Access to the photo library is allowed.");
    // Do something.
} else {
    console.log("Access to the photo library isn't allowed.");
}

getIsSaveToLocationAllowed(saveLocation)

Returns true if an organization's Intune mobile application management (MAM) policy allows an add-in to save data to the specified location.

getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean;

Parameters

saveLocation: Office.MailboxEnums.SaveLocation

The location in which the add-in is attempting to save data.

Returns

boolean

True if an organization's Intune MAM policy allows an add-in to save data to the specified location.

Remarks

Minimum permission level: read item

Applicable Outlook mode: Compose, Read

Important: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see Outlook JavaScript APIs supported in Outlook on mobile devices.

Errors:

InvalidSaveLocationInput: The value of the specified location is invalid.
MAMServiceNotAvailable: The client is unable to fetch the MAM policy.

Examples

// Checks if the add-in can save data to SharePoint.
const isSaveToSharePointAllowed = Office.context.mailbox.getIsSaveToLocationAllowed(Office.MailboxEnums.SaveLocation.SharePoint);
if (isSaveToSharePointAllowed) {
    console.log("Saving to SharePoint is allowed.");
    // Do something.
} else {
    console.log("Saving to SharePoint isn't allowed.");
}

getUserIdentityTokenAsync(callback, userContext)

Gets a token identifying the user and the Office Add-in.

The token is returned as a string in the asyncResult.value property.

getUserIdentityTokenAsync(callback: (asyncResult: Office.AsyncResult<string>) => void, userContext?: any): void;

Parameters

callback: (asyncResult: Office.AsyncResult<string>) => void

userContext: any

Optional. Any state data that is passed to the asynchronous method.

Returns

void

Remarks

Minimum permission level: read item

Applicable Outlook mode: Compose or Read

Important:

In February 2025, legacy Exchange user identity and callback tokens will be turned off by default for all Exchange Online tenants. This is part of Microsoft's Secure Future Initiative, which gives organizations the tools needed to respond to the current threat landscape. Exchange user identity tokens will still work for Exchange on-premises. Nested app authentication (NAA) is the recommended approach for tokens going forward. For more information, see the FAQ page.
The getUserIdentityTokenAsync method returns a token that you can use to identify and authenticate the add-in and user with an external system.
This method isn't supported if you load an add-in in an Outlook.com or Gmail mailbox.

Errors:

If your call fails, use the asyncResult.diagnostics property to view details about the error.

GenericTokenError: An internal error has occurred. - In Exchange Online environments, this error occurs when the token can't be retrieved because legacy Exchange tokens for Outlook add-ins are turned off. We recommend using NAA as a single sign-on solution for your add-in. For guidance on how to implement NAA, see the FAQ page.
HTTPRequestFailure: The request has failed. Please look at the diagnostics object for the HTTP error code.
InternalServerError: The Exchange server returned an error. Please look at the diagnostics object for more information. - In Exchange Online environments, this error occurs when the token can't be retrieved because legacy Exchange tokens for Outlook add-ins are turned off. We recommend using NAA as a single sign-on solution for your add-in. For guidance on how to implement NAA, see the FAQ page.
NetworkError: The user is no longer connected to the network. Please check your network connection and try again.

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/85-tokens-and-service-calls/user-identity-token.yaml

Office.context.mailbox.getUserIdentityTokenAsync((result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
        console.error(`Token retrieval failed with message: ${result.error.message}`)
        return;
    }

    console.log(result.value);
});

makeEwsRequestAsync(data, callback, userContext)

Makes an asynchronous request to an Exchange Web Services (EWS) service on the Exchange server that hosts the user's mailbox.

The makeEwsRequestAsync method sends an EWS request on behalf of the add-in to Exchange.

makeEwsRequestAsync(data: any, callback: (asyncResult: Office.AsyncResult<string>) => void, userContext?: any): void;

Parameters

data: any

The EWS request.

callback: (asyncResult: Office.AsyncResult<string>) => void

When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an Office.AsyncResult object. The XML response of the EWS request is provided as a string in the asyncResult.value property. In Outlook on the web, on Windows (new and classic (starting in Version 2303, Build 16225.10000)), and on Mac (starting in Version 16.73 (23042601)), if the response exceeds 5 MB in size, an error message is returned in the asyncResult.error property. In earlier versions of Outlook on Windows (classic) and on Mac, an error message is returned if the response exceeds 1 MB in size.

userContext: any

Optional. Any state data that is passed to the asynchronous method.

Returns

void

Remarks

[ API set: Mailbox 1.1 ]

Minimum permission level: read/write mailbox

Applicable Outlook mode: Compose or Read

Important:

In February 2025, legacy Exchange user identity and callback tokens will be turned off by default for all Exchange Online tenants. This is part of Microsoft's Secure Future Initiative, which gives organizations the tools needed to respond to the current threat landscape. Exchange user identity tokens will still work for Exchange on-premises. Nested app authentication (NAA) is the recommended approach for tokens going forward. For more information, see the FAQ page.
To enable the makeEwsRequestAsync method to make EWS requests, the server administrator must set OAuthAuthentication to true on the Client Access Server EWS directory .
Your add-in must have the read/write mailbox permission to use the makeEwsRequestAsync method. For information about using the read/write mailbox permission and the EWS operations that you can call with the makeEwsRequestAsync method, see Specify permissions for mail add-in access to the user's mailbox.
If your add-in needs to access Folder Associated Items or its XML request must specify UTF-8 encoding (\<?xml version="1.0" encoding="utf-8"?\>), it must use Microsoft Graph or REST APIs to access the user's mailbox instead.
This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see Outlook JavaScript APIs supported in Outlook on mobile devices.
This method isn't supported when the add-in is loaded in a Gmail mailbox.
When you use the makeEwsRequestAsync method in add-ins that run in Outlook versions earlier than Version 15.0.4535.1004, you must set the encoding value to ISO-8859-1 (<?xml version="1.0" encoding="iso-8859-1"?>). To determine the version of an Outlook client, use the mailbox.diagnostics.hostVersion property. You don't need to set the encoding value when your add-in is running in Outlook on the web or new Outlook on Windows. To determine the Outlook client in which your add-in is running, use the mailbox.diagnostics.hostName property.

Examples

function getSubjectRequest(id) {
    // Return a GetItem operation request for the subject of the specified item.
    const request =
        '<?xml version="1.0" encoding="utf-8"?>' +
        '<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"' +
        '               xmlns:xsd="http://www.w3.org/2001/XMLSchema"' +
        '               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"' +
        '               xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types">' +
        '  <soap:Header>' +
        '    <RequestServerVersion Version="Exchange2016" xmlns="http://schemas.microsoft.com/exchange/services/2006/types" soap:mustUnderstand="0" />' +
        '  </soap:Header>' +
        '  <soap:Body>' +
        '    <GetItem xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">' +
        '      <ItemShape>' +
        '        <t:BaseShape>IdOnly</t:BaseShape>' +
        '        <t:AdditionalProperties>' +
        '            <t:FieldURI FieldURI="item:Subject"/>' +
        '        </t:AdditionalProperties>' +
        '      </ItemShape>' +
        '      <ItemIds><t:ItemId Id="' + id + '"/></ItemIds>' +
        '    </GetItem>' +
        '  </soap:Body>' +
        '</soap:Envelope>';

    return request;
}

function sendRequest() {
    // Create a local variable that contains the mailbox.
    Office.context.mailbox.makeEwsRequestAsync(
        getSubjectRequest(mailbox.item.itemId), callback);
}

function callback(asyncResult)  {
    const result = asyncResult.value;
    const context = asyncResult.asyncContext;

    // Process the returned response here.
}

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/85-tokens-and-service-calls/get-icaluid-as-attendee.yaml

const ewsId = Office.context.mailbox.item.itemId;
const request = `<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages" xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
      <soap:Header><t:RequestServerVersion Version="Exchange2013" /></soap:Header>
      <soap:Body>
        <m:GetItem>
          <m:ItemShape>
            <t:BaseShape>AllProperties</t:BaseShape>
          </m:ItemShape >
          <m:ItemIds>
            <t:ItemId Id="${ewsId}" />
          </m:ItemIds>
        </m:GetItem>
      </soap:Body>
    </soap:Envelope>`;

Office.context.mailbox.makeEwsRequestAsync(request, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.error(result.error.message);
    return;
  }

  console.log(getUID(result.value));
});

...

const request = '<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages" xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">'+
    '  <soap:Header><t:RequestServerVersion Version="Exchange2010" /></soap:Header>'+
    '  <soap:Body>'+
    '    <m:CreateItem MessageDisposition="SendAndSaveCopy">'+
    '      <m:SavedItemFolderId><t:DistinguishedFolderId Id="sentitems" /></m:SavedItemFolderId>'+
    '      <m:Items>'+
    '        <t:Message>'+
    '          <t:Subject>Hello, Outlook!</t:Subject>'+
    '          <t:Body BodyType="HTML">This message was sent from a ScriptLab code sample, used from ' + Office.context.mailbox.diagnostics.hostName + ', version ' + Office.context.mailbox.diagnostics.hostVersion + '!</t:Body>'+
    '          <t:ToRecipients>'+
    '            <t:Mailbox><t:EmailAddress>' + Office.context.mailbox.userProfile.emailAddress + '</t:EmailAddress></t:Mailbox>'+
    '          </t:ToRecipients>'+
    '        </t:Message>'+
    '      </m:Items>'+
    '    </m:CreateItem>'+
    '  </soap:Body>'+
    '</soap:Envelope>';

Office.context.mailbox.makeEwsRequestAsync(request, (result) => {
    console.log(result);
});

Share via

Office.Mailbox interface

Remarks

Examples

Properties

Methods

Property Details

diagnostics

Property Value

Remarks

Examples

ewsUrl

Property Value

Remarks

Examples

item

Property Value

userProfile

Property Value

Method Details

convertToEwsId(id, restVersion)

Parameters

Returns

Remarks

Examples

convertToLocalClientTime(timeValue)

Parameters

Returns

Remarks

convertToRestId(id, restVersion)

Parameters

Returns

Remarks

Examples

convertToUtcClientTime(input)

Parameters

Returns

Remarks

Examples

displayAppointmentForm(itemId)

Parameters

Returns

Remarks

Examples

displayMessageForm(itemId)

Parameters

Returns

Remarks

Examples

displayNewAppointmentForm(parameters)

Parameters

Returns

Remarks

Examples

getCallbackTokenAsync(callback, userContext)

Parameters

Returns

Remarks

getIsIdentityManaged()

Returns

Remarks

Examples

getIsOpenFromLocationAllowed(openLocation)

Parameters

Returns

Remarks

Examples

getIsSaveToLocationAllowed(saveLocation)

Parameters

Returns

Remarks

Examples

getUserIdentityTokenAsync(callback, userContext)

Parameters

Returns

Remarks

Examples

makeEwsRequestAsync(data, callback, userContext)

Parameters

Returns