item (Mailbox requirement set 1.7)
Office.context.mailbox.item
item
is used to access the currently selected message, meeting request, or appointment. You can determine the type of the item by using the itemType
property.
Requirements
Requirement | Value |
---|---|
Minimum mailbox requirement set version | 1.1 |
Minimum permission level | restricted |
Applicable Outlook mode | Appointment Organizer, Appointment Attendee, Message Compose, or Message Read |
Important
Android and iOS: There are limitations on when add-ins activate and which APIs are available. To learn more, refer to Add mobile support to an Outlook add-in.
Properties
Methods
Method | Minimum permission level |
Details by mode | Minimum requirement set |
---|---|---|---|
addFileAttachmentAsync(uri, attachmentName, [options], [callback]) | read/write item | Appointment Organizer | 1.1 |
Message Compose | 1.1 | ||
addHandlerAsync(eventType, handler, [options], [callback]) | read item | Appointment Organizer | 1.7 |
Appointment Attendee | 1.7 | ||
Message Compose | 1.7 | ||
Message Read | 1.7 | ||
addItemAttachmentAsync(itemId, attachmentName, [options], [callback]) | read/write item | Appointment Organizer | 1.1 |
Message Compose | 1.1 | ||
close() | restricted | Appointment Organizer | 1.3 |
Message Compose | 1.3 | ||
displayReplyAllForm(formData) | read item | Appointment Attendee | 1.1 |
Message Read | 1.1 | ||
displayReplyForm(formData) | read item | Appointment Attendee | 1.1 |
Message Read | 1.1 | ||
getEntities() (deprecated) | read item | Appointment Attendee | 1.1 |
Message Read | 1.1 | ||
getEntitiesByType(entityType) (deprecated) | restricted | Appointment Attendee | 1.1 |
Message Read | 1.1 | ||
getFilteredEntitiesByName(name) (deprecated) | read item | Appointment Attendee | 1.1 |
Message Read | 1.1 | ||
getRegExMatches() | read item | Appointment Attendee | 1.1 |
Message Read | 1.1 | ||
getRegExMatchesByName(name) | read item | Appointment Attendee | 1.1 |
Message Read | 1.1 | ||
getSelectedDataAsync(coercionType, [options], callback) | read item | Appointment Organizer | 1.2 |
Message Compose | 1.2 | ||
getSelectedEntities() (deprecated) | read item | Appointment Attendee | 1.6 |
Message Read | 1.6 | ||
getSelectedRegExMatches() | read item | Appointment Attendee | 1.6 |
Message Read | 1.6 | ||
loadCustomPropertiesAsync(callback, [userContext]) | read item | Appointment Organizer | 1.1 |
Appointment Attendee | 1.1 | ||
Message Compose | 1.1 | ||
Message Read | 1.1 | ||
removeAttachmentAsync(attachmentId, [options], [callback]) | read/write item | Appointment Organizer | 1.1 |
Message Compose | 1.1 | ||
removeHandlerAsync(eventType, [options], [callback]) | read item | Appointment Organizer | 1.7 |
Appointment Attendee | 1.7 | ||
Message Compose | 1.7 | ||
Message Read | 1.7 | ||
saveAsync([options], callback) | read/write item | Appointment Organizer | 1.3 |
Message Compose | 1.3 | ||
setSelectedDataAsync(data, [options], callback) | read/write item | Appointment Organizer | 1.2 |
Message Compose | 1.2 |
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 |
---|---|---|
AppointmentTimeChanged |
The date or time of the selected appointment or series has changed. | 1.7 |
RecipientsChanged |
The recipient list of the selected item or appointment location has changed. | 1.7 |
RecurrenceChanged |
The recurrence pattern of the selected series has changed. | 1.7 |
Example
The following JavaScript code example shows how to access the subject
property of the current item in Outlook.
// The initialize function is required for all apps.
Office.initialize = function () {
// Checks for the DOM to load using the jQuery ready method.
$(document).ready(function () {
// After the DOM is loaded, app-specific code can run.
const item = Office.context.mailbox.item;
const subject = item.subject;
// Continue with processing the subject of the current item,
// which can be a message or appointment.
});
};
Office Add-ins
Feedback
https://aka.ms/ContentUserFeedback.
Binnenkort beschikbaar: In de loop van 2024 zullen we GitHub-problemen geleidelijk uitfaseren als het feedbackmechanisme voor inhoud en deze vervangen door een nieuw feedbacksysteem. Zie voor meer informatie:Feedback verzenden en weergeven voor