Mailbox object (JavaScript API for Office)

Office Add-ins

Provides access to the app for Office object model for Microsoft Outlook 2013 and Microsoft Outlook Web App.

Last modified: July 06, 2015

Note Note

The name "apps for Office" is changing to "Office Add-ins". During the transition, the documentation and the UI of some Office host applications and Visual Studio tools might still use the term "apps for Office". For details, see New name for apps for Office and SharePoint.

Hosts:Outlook

App type: Mail

Available in requirement sets

Mailbox

Last changed in Mailbox

1.0

Applicable Outlook modes

Compose or read

See all support details

Office.context.mailbox

Methods

Method name

Outlook mode

Description

Introduced in

convertToLocalClientTime

Compose or read

Gets a dictionary containing time information in local client time.

Version 1.0

convertToUtcClientTime

Compose or read

Gets a Date object from a dictionary containing time information.

Version 1.0

displayAppointmentForm

Compose or read

Displays an existing calendar appointment.

Version 1.0

displayMessageForm

Compose or read

Displays an existing email message.

Version 1.0

displayNewAppointmentForm

Compose or read

Displays a form that enables the user to create a new calendar appointment.

Version 1.0

getCallbackTokenAsync

Compose or read

Gets a token that can be used in a request for attachments to an item.

Version 1.0

getUserIdentityTokenAsync

Compose or read

Gets a token that identifies the user and the app.

Version 1.0

makeEwsRequestAsync

Compose or read

Makes a request to an Exchange Web Services (EWS) service.

Version 1.0

Properties

Property name

Outlook mode

Description

Introduced in

diagnostics

Compose or read

Gets an object that provides troubleshooting capabilities for the mail app.

Version 1.0

ewsUrl

Compose or read

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

Version 1.0

item

Compose or read

Gets the item (email message or appointment) that activated the app.

Version 1.0

userProfile

Compose or read

Gets information about the client application user.

Version 1.0

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

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

Supported hosts, by platform

Office for Windows desktop

Office Online
(in browser)

OWA for Devices

Office for Mac

Outlook

√ (Read mode only)

Available in requirement sets

Mailbox

Minimum permission level

ReadWriteMailbox, but some members accessible with lesser permissions

App types

Mail

Library

Office.js

Namespace

Office

Version

Changes

1.0

Introduced

Show:
© 2015 Microsoft