item (Mailbox requirement set 1.1)
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 | ||
addItemAttachmentAsync(itemId, attachmentName, [options], [callback]) | read/write item | Appointment Organizer | 1.1 |
Message Compose | 1.1 | ||
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() | read item | Appointment Attendee | 1.1 |
Message Read | 1.1 | ||
getEntitiesByType(entityType) | restricted | Appointment Attendee | 1.1 |
Message Read | 1.1 | ||
getFilteredEntitiesByName(name) | 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 | ||
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 |
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.
});
};
Samarbeid med oss på GitHub
Du finner kilden for dette innholdet på GitHub. Der du også kan opprette og se gjennom problemer og pull-forespørsler. Hvis du vil ha mer informasjon, kan du se vår bidragsyterveiledning.
Office Add-ins
Tilbakemeldinger
https://aka.ms/ContentUserFeedback.
Kommer snart: Gjennom 2024 faser vi ut GitHub Issues som tilbakemeldingsmekanisme for innhold, og erstatter det med et nytt system for tilbakemeldinger. Hvis du vil ha mer informasjon, kan du se:Send inn og vis tilbakemelding for