mailbox (requirement set 1.7)
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 | read item | Compose Read |
Diagnostics | 1.1 |
| ewsUrl | read item | Compose Read |
String | 1.1 |
| item | restricted | Compose Read |
Item | 1.1 |
| restUrl | read item | Compose Read |
String | 1.5 |
| userProfile | read item | Compose Read |
UserProfile | 1.1 |
Methods
| Method | Minimum permission level |
Modes | Minimum requirement set |
|---|---|---|---|
| addHandlerAsync(eventType, handler, [options], [callback]) | read item | Compose Read |
1.5 |
| convertToEwsId(id, restVersion) | restricted | Compose Read |
1.3 |
| convertToLocalClientTime(timeValue) | read item | Compose Read |
1.1 |
| convertToRestId(id, restVersion) | restricted | Compose Read |
1.3 |
| convertToUtcClientTime(input) | read item | Compose Read |
1.1 |
| displayAppointmentForm(itemId) | read item | Compose Read |
1.1 |
| displayMessageForm(itemId) | read item | Compose Read |
1.1 |
| displayNewAppointmentForm(parameters) | read item | Read | 1.1 |
| displayNewMessageForm(parameters) | read item | Read | 1.6 |
| getCallbackTokenAsync([options], callback) | read item | Compose Read |
1.5 |
| getCallbackTokenAsync(callback, [userContext]) | read item | Compose Read |
1.3 1.1 |
| getUserIdentityTokenAsync(callback, [userContext]) | read item | Compose Read |
1.1 |
| makeEwsRequestAsync(data, callback, [userContext]) | read/write mailbox | Compose Read |
1.1 |
| removeHandlerAsync(eventType, [options], [callback]) | read item | 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 |