mailbox

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
masterCategories ReadWriteMailbox Compose
Read
MasterCategories 1.8
restUrl ReadItem Compose
Read
String 1.5
userProfile ReadItem Compose
Read
UserProfile 1.1

Methods

Method Minimum
permission level
Modes Minimum
requirement set
addHandlerAsync ReadItem Compose
Read
1.5
convertToEwsId Restricted Compose
Read
1.3
convertToLocalClientTime ReadItem Compose
Read
1.1
convertToRestId Restricted Compose
Read
1.3
convertToUtcClientTime ReadItem Compose
Read
1.1
displayAppointmentForm ReadItem Compose
Read
1.1
displayMessageForm ReadItem Compose
Read
1.1
displayNewAppointmentForm ReadItem Read 1.1
displayNewMessageForm ReadItem Compose
Read
1.6
getCallbackTokenAsync ReadItem Compose
Read
1.5
getCallbackTokenAsync ReadItem Compose
Read
1.3
1.1
getUserIdentityTokenAsync ReadItem Compose
Read
1.1
makeEwsRequestAsync ReadWriteMailbox Compose
Read
1.1
removeHandlerAsync ReadItem Compose
Read
1.5

Events

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

Event Description Minimum
requirement set
ItemChanged A different Outlook item is selected for viewing while the task pane is pinned. 1.5
OfficeThemeChanged The Office theme on the mailbox has changed. Preview