Edit

Share via

Outlook Item object model

Use the Office.context.mailbox.item object to access and perform operations on messages and appointments in read or compose mode.

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

Property Minimum permission level Details by mode Return type Minimum requirement set
attachments read item Appointment Attendee Array.<AttachmentDetails> 1.1
Message Read Array.<AttachmentDetails> 1.1
bcc read item Message Compose Recipients 1.1
body read item Appointment Organizer Body 1.1
Appointment Attendee Body 1.1
Message Compose Body 1.1
Message Read Body 1.1
categories read item Appointment Organizer Categories 1.8
Appointment Attendee Categories 1.8
Message Compose Categories 1.8
Message Read Categories 1.8
cc read item Message Compose Recipients 1.1
Message Read Array.<EmailAddressDetails> 1.1
conversationId read item Message Compose String 1.1
Message Read String 1.1
dateTimeCreated read item Appointment Attendee Date 1.1
Message Read Date 1.1
dateTimeModified read item Appointment Attendee Date 1.1
Message Read Date 1.1
delayDeliveryTime read item Message Compose DelayDeliveryTime 1.13
display read/write item Message Read Display Preview
end read item Appointment Organizer Time 1.1
Appointment Attendee Date 1.1
Message Read Date 1.1
enhancedLocation read item Appointment Organizer EnhancedLocation 1.8
Appointment Attendee EnhancedLocation 1.8
from read item Message Compose From 1.7
Message Read EmailAddressDetails 1.1
inReplyTo read item Message Compose String 1.14
internetHeaders read item Message Compose InternetHeaders 1.8
internetMessageId read item Message Read String 1.1
isAllDayEvent read item Appointment Organizer IsAllDayEvent Preview
Appointment Attendee Boolean Preview
itemClass read item Appointment Attendee String 1.1
Message Read String 1.1
itemId read item Appointment Attendee String 1.1
Message Read String 1.1
itemType read item Appointment Organizer MailboxEnums.ItemType 1.1
Appointment Attendee MailboxEnums.ItemType 1.1
Message Compose MailboxEnums.ItemType 1.1
Message Read MailboxEnums.ItemType 1.1
location read item Appointment Organizer Location 1.1
Appointment Attendee String 1.1
Message Read String 1.1
normalizedSubject read item Appointment Attendee String 1.1
Message Read String 1.1
notificationMessages read item Appointment Organizer NotificationMessages 1.3
Appointment Attendee NotificationMessages 1.3
Message Compose NotificationMessages 1.3
Message Read NotificationMessages 1.3
optionalAttendees read item Appointment Organizer Recipients 1.1
Appointment Attendee Array.<EmailAddressDetails> 1.1
organizer read/write item Appointment Organizer Organizer 1.7
read item Appointment Attendee EmailAddressDetails 1.1
recurrence read item Appointment Organizer Recurrence 1.7
Appointment Attendee Recurrence 1.7
Message Read Recurrence 1.7
requiredAttendees read item Appointment Organizer Recipients 1.1
Appointment Attendee Array.<EmailAddressDetails> 1.1
sender read item Message Read EmailAddressDetails 1.1
sensitivity read item Appointment Organizer Sensitivity 1.14
Appointment Attendee MailboxEnums.AppointmentSensitivityType 1.14
sensitivityLabel read/write item Appointment Organizer SensitivityLabel 1.13
Message Compose SensitivityLabel 1.13
seriesId read item Appointment Organizer String 1.7
Appointment Attendee String 1.7
Message Compose String 1.7
Message Read String 1.7
sessionData read item Appointment Organizer SessionData 1.11
Message Compose SessionData 1.11
start read item Appointment Organizer Time 1.1
Appointment Attendee Date 1.1
Message Read Date 1.1
subject read item Appointment Organizer Subject 1.1
Appointment Attendee String 1.1
Message Compose Subject 1.1
Message Read String 1.1
to read item Message Compose Recipients 1.1
Message Read Array.<EmailAddressDetails> 1.1

Methods

Method Minimum permission level Details by mode Minimum requirement set
addFileAttachmentAsync(uri, attachmentName, [options], [callback]) read/write item Appointment Organizer 1.1
(classic Windows, Mac)

1.8
(Web, new Windows)
Message Compose 1.1
(classic Windows, Mac)

1.8
(Web, new Windows)
addFileAttachmentFromBase64Async(base64File, attachmentName, [options], [callback]) read/write item Appointment Organizer 1.8
Message Compose 1.8
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
closeAsync([options], [callback]) read/write item Message Compose 1.14
disableClientSignatureAsync([options], [callback]) read/write item Appointment Organizer 1.10
Message Compose 1.10
displayReplyAllForm(formData) read item Appointment Attendee 1.1
Message Read 1.1
displayReplyAllFormAsync(formData, [options], [callback]) read item Appointment Attendee 1.9
Message Read 1.9
displayReplyForm(formData) read item Appointment Attendee 1.1
Message Read 1.1
displayReplyFormAsync(formData, [options], [callback]) read item Appointment Attendee 1.9
Message Read 1.9
getAllInternetHeadersAsync([options], [callback]) read item Message Read 1.8
getAsFileAsync([options], callback) read item Message Read 1.14
getAttachmentContentAsync(attachmentId, [options], [callback]) read item Appointment Organizer 1.8
Appointment Attendee 1.8
Message Compose 1.8
Message Read 1.8
getAttachmentsAsync([options], [callback]) read item Appointment Organizer 1.8
Message Compose 1.8
getComposeTypeAsync([options], callback) read item Message Compose 1.10
getConversationIndexAsync([options], callback) read item Message Compose 1.14
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
getInitializationContextAsync([options], callback) read item Appointment Organizer 1.8
Appointment Attendee 1.8
Message Compose 1.8
Message Read 1.8
getItemClassAsync([options], callback) read item Message Compose 1.14
getItemIdAsync([options], callback) read item Appointment Organizer 1.8
Message Compose 1.8
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
getSharedPropertiesAsync([options], callback) read item Appointment Organizer 1.8
(shared folder support)

1.13
(shared mailbox support)
Appointment Attendee 1.8
(shared folder support)

1.13
(shared mailbox support)
Message Compose 1.8
(shared folder support)

1.13
(shared mailbox support)
Message Read 1.8
(shared folder support)

1.13
(shared mailbox support)
isClientSignatureEnabledAsync([options], callback) read item Appointment Organizer 1.10
Message Compose 1.10
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
sendAsync([options], [callback]) read/write mailbox Appointment Organizer 1.15
Message Compose 1.15
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. For more information, see Office.EventType.

Event Description Minimum requirement set
AppointmentTimeChanged Occurs when any date or time of the selected appointment or series is changed in Outlook. Only available with task pane implementation. 1.7
AttachmentsChanged Occurs when an attachment is added to or removed from an item. Only available with task pane implementation. 1.8
EnhancedLocationsChanged Occurs when the appointment location is changed in Outlook. Only available with task pane implementation. 1.8
InfobarClicked Occurs in Outlook when an action is selected on a notification message with a defined custom action. Only available with task pane implementation. 1.10
InitializationContextChanged Occurs in Outlook when an add-in's task pane is opened from an actionable message, InsightMessage notification, Smart Alerts dialog, or integrated spam-reporting dialog. Only available with task pane implementation. 1.15
RecipientsChanged Occurs when the recipient list of the selected item or the appointment location is changed in Outlook. Only available with task pane implementation. 1.7
RecurrenceChanged Occurs when the recurrence pattern of the selected series is changed in Outlook. Only available with task pane implementation. 1.7
SensitivityLabelChanged Occurs in Outlook when the sensitivity label of a message or appointment changes. Only available with task pane implementation. 1.13
SpamReporting Occurs in Outlook when an unsolicited message is reported. 1.14

Note

For events supported in an event-based activation add-in, see Activate add-ins with events.

  • Last updated on