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

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
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
end	read item	Appointment Organizer	Time	1.1
		Appointment Attendee	Date	1.1
		Message Read (Meeting Request)	Date	1.1
from	read item	Message Read	EmailAddressDetails	1.1
internetMessageId	read item	Message Read	String	1.1
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 (Meeting Request)	String	1.1
normalizedSubject	read item	Appointment Attendee	String	1.1
		Message Read	String	1.1
optionalAttendees	read item	Appointment Organizer	Recipients	1.1
		Appointment Attendee	Array.<EmailAddressDetails>	1.1
organizer	read item	Appointment Attendee	EmailAddressDetails	1.1
requiredAttendees	read item	Appointment Organizer	Recipients	1.1
		Appointment Attendee	Array.<EmailAddressDetails>	1.1
sender	read item	Message Read	EmailAddressDetails	1.1
start	read item	Appointment Organizer	Time	1.1
		Appointment Attendee	Date	1.1
		Message Read (Meeting Request)	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
		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() (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
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.
  });
};