mailbox (requirement set 1.5)

Office.context.mailbox

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

Requirements
Requirement Value
Minimum mailbox requirement set version 1.1
Minimum permission level Restricted
Applicable Outlook mode Compose or Read

Properties

Property Minimum
permission level
Modes Return type Minimum
requirement set
diagnostics ReadItem Compose
Read
Diagnostics 1.1
ewsUrl ReadItem Compose
Read
String 1.1
item Restricted Compose
Read
Item 1.1
restUrl ReadItem Compose
Read
String 1.5
userProfile ReadItem Compose
Read
UserProfile 1.1

Methods

Method Minimum
permission level
Modes Minimum
requirement set
addHandlerAsync(eventType, handler, [options], [callback]) ReadItem Compose
Read
1.5
convertToEwsId(itemId, restVersion) Restricted Compose
Read
1.3
convertToLocalClientTime(timeValue) ReadItem Compose
Read
1.1
convertToRestId(itemId, restVersion) Restricted Compose
Read
1.3
convertToUtcClientTime(input) ReadItem Compose
Read
1.1
displayAppointmentForm(itemId) ReadItem Compose
Read
1.1
displayMessageForm(itemId) ReadItem Compose
Read
1.1
displayNewAppointmentForm(parameters) ReadItem Read 1.1
getCallbackTokenAsync([options], callback) ReadItem Compose
Read
1.5
getCallbackTokenAsync(callback, [userContext]) ReadItem Compose
Read
1.3
1.1
getUserIdentityTokenAsync(callback, [userContext]) ReadItem Compose
Read
1.1
makeEwsRequestAsync(data, callback, [userContext]) ReadWriteMailbox Compose
Read
1.1
removeHandlerAsync(eventType, [options], [callback]) ReadItem Compose
Read
1.5

Events

You can subscribe to and unsubscribe from the following events using addHandlerAsync and removeHandlerAsync respectively.

Important

Events are only available with task pane implementation.

Event Description Minimum
requirement set
ItemChanged A different Outlook item is selected for viewing while the task pane is pinned. 1.5