Context.mailbox property (JavaScript API for Office)

apps for Office

Gets the mailbox object that provides access to API members specifically for mail apps.

Last modified: February 27, 2015

Hosts:

Outlook

Available in Requirement set

Mailbox

Last changed in

1.0

See all support details

var outlookOm = Office.context.mailbox;

In this article, "Outlook" refers to Outlook for Windows, Outlook for Mac, Outlook RT, OWA for Devices (OWA for Android phones, OWA for iPad, OWA for iPhone), and Outlook Web App. "Outlook rich clients" refers to Outlook for Windows, Outlook for Mac and Outlook RT. At this point, Outlook for Mac supports JavaScript API for Office in only Outlook read mode, and can activate mail apps that reference office.js version 1.0 or 1.1 and use apps for Office schema version 1.0.

The following line of code access the item object of the JavaScript API for Office.

// Access the Item object.
var item = Office.context.mailbox.item;

A checkmark (√) in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.

For more information about Office host application and server requirements, see Requirements for running apps for Office.

Office for Windows desktop

Office for Windows RT

Office Online
(in browser)

Outlook for Mac

Outlook

Available in requirement sets

Mailbox

Minimum permission level

Restricted

App types

Mail

Library

Office.js

Namespace

Office

Version

Changes

1.0

Introduced

Show:
© 2015 Microsoft