Mail app features per version

apps for Office

Find out the mail app features available for each version of JavaScript API for Office (office.js) and of the schema for apps for Office manifests.

Last modified: February 27, 2015

Applies to: Access app for SharePoint | apps for Office | Excel | Outlook | PowerPoint | Project | Word

Learn more about supported hosts and other requirements.

When you are exploring the features available to your mail app scenario, it's helpful to first think of the form in which the mail app is relevant and should be activated – would that be in a read form where the user is reading an email, meeting request, meeting response, or an appointment in the calendar? Or would that be in a compose form where the user is creating an email or meeting request, replying inline or in a compose inspector, or responding to or forwarding a meeting item? There are features (and API) available to mail apps in both read and compose forms, and there are a number of other features (and API) that are relevant and available in only read forms or only compose forms.

The 3 tables below list these features accordingly. You can create a mail app that works in only one type of form, or in both read and compose forms. Regardless, behind the scenes, when you implement the mail app, you should be aware of the user's Outlook mode (reading or composing) in context, so that you use the appropriate API.

Following are 3 tables that list the features available in each type of form per version:

  • Table 1 lists the features that are available to mail apps in both read and compose forms in Outlook, in each version of office.js and the schema. Note that for office.js v1.0 and schema v1.0, mail apps are activated in only read forms, so these features apply to only read forms. For versions of office.js and the schema that are v1.1 or later, mail apps can be activated in read or compose forms.

  • Table 2 lists the features available to mail apps in only read forms in Outlook, in each version of office.js and the schema. If you are looking for all the features that are available in read forms, refer to both Table 1 and 2.

  • Table 3 lists the features available to mail apps in only compose forms in Outlook, in each version of office.js and the schema. If you are looking for all the features that are available in compose forms, refer to both Table 1 and 3.

Table 1. Mail app features supported per version in read and compose forms

Features available in read and compose forms

Office.js v1.1

Office.js v1.0

Schema v1.1

Schema v1.0

More information

Related reference

Accessing user’s profile

Check symbol

Check symbol

-

-

User profile

Mailbox.userProfile property

Providing separate apps for different locales

Check symbol

Check symbol

Check symbol

Check symbol

Localization for apps for Office

Context.displayLanguage property

Description element

DisplayName element

IconUrl element

SourceLocation element

Providing the same app for tablets and smartphones

-

-

Check symbol

Check symbol

Write-once run-all principle allows the same office.js API to work properly independent of the device.

Schema v1.1:

Set up a mail app for Outlook on desktops, tablets and mobile devices (schema v1.1)

Schema v1.0:

Set up a mail app for Outlook on desktops, tablets and mobile devices (schema v1.0)

Schema v1.1:

Form element

TabletSettings element

PhoneSettings element

Schema v1.0:

TabletSettings element

PhoneSettings element

Displaying a specific appointment or message

Check symbol

Check symbol

-

-

Mailbox.displayAppointmentForm method

Mailbox.displayMessageForm method

Getting properties of an appointment or message

Check symbol

Check symbol

-

-

The following members are available in v1.1 and v1.0 of office.js, in both compose and read forms.

Mailbox.item property

Item.itemType property, accessible synchronously

Message.conversationId property, accessible synchronously

There are other members available in only read forms in Table 2, and those only in compose forms in Table 3.

Getting and setting metadata for item or mailbox

Check symbol

Check symbol

-

-

Get and set app metadata for a mail app in Outlook

CustomProperties object

RoamingSettings object

Calling Exchange Web Services

Check symbol

Check symbol

Call web services from a mail app for Outlook

Mailbox.makeEwsRequestAsync method

Enabling single sign-on for app users to access protected services

Check symbol

Check symbol

-

-

Authenticate a mail app by using Exchange identity tokens

Mailbox.getUserIdentityTokenAsync

Table 2. Mail app features supported per version in only read forms

Features available in only a read form

Office.js v1.1

Office.js v1.0

Schema v1.1

Schema v1.0

More information

Related reference

Activating a mail app by matching subject or body with regular expressions

-

-

Check symbol

Check symbol

Use regular expression activation rules to show a mail app in Outlook

ItemHasRegularExpressionMatch complexType

Activating a mail app by matching specific strings as well-known entities

-

-

Check symbol

Check symbol

Match strings in an Outlook item as well-known entities

ItemHasKnownEntity complexType

Activating a mail app by the existence of an attachment

-

-

Check symbol

Check symbol

Schema v1.1:

"Activating mail apps in Outlook clients (schema v1.1)"

Schema v1.1:

Activate mail apps in Outlook clients (schema v1.1)

ItemHasAttachment complexType

Matching strings in an item as well-known entities

Check symbol

Check symbol

-

-

Retrieving entities in your mail app

Appointment.getEntities method

Appointment.getEntitiesByType method

Message.getEntities method

Message.getEntitiesByType method

Entities object

Contact object

MeetingSuggestion object

PhoneNumber object

TaskSuggestion object

Activating a mail app for items of a specific message class

-

-

Check symbol

Check symbol

How to: Activate a mail app in Outlook for a specific message class

Schema v1.1:

ItemIs complexType

Schema v1.0:

ItemIs complexType

Displaying a form for a new appointment

Check symbol

Check symbol

-

-

Mailbox.displayNewAppointmentForm method

Getting properties of an appointment or message

Check symbol

Check symbol

-

-

Assumes mail app is already activated in a read form with ReadItem or higher permission.

Get and set Outlook item data in read or compose forms

Office.js v1.1:

dateTimeCreated, dateTimeModified, itemClass, and itemId properties of the Item object

attachments, end, location, normalizedSubject, optionalAttendees, organizer, requiredAttendees, resources, start, and subject of the Appointment object, directly accessible synchronously as child members

attachments, cc, conversationId, from, internetMessageId, normalizedSubject, sender, subject, and to properties of the Message object, directly accessible synchronously as child members

Office.js v1.0:

All members in the Item, Appointment and Message objects in that version.

Getting attachments of an item in a read form

Check symbol

Check symbol

-

-

Assumes mail app is already activated with ReadItem permission.

How to: Get attachments of an Outlook item from an Exchange server

Mailbox.ewsUrl property

attachments property of an appointment or message item

Mailbox.getCallbackTokenAsync

Table 3. Mail app features supported per version in only compose forms

Features available in only a compose form

Office.js v1.1

Office.js v1.0

Schema v1.1

Schema v1.0

More information

Related reference

Getting properties of a message or appointment

Check symbol

Cross symbol

-

-

Assumes mail app is already activated in a compose form.

Get and set item data in a compose form in Outlook

Office.js v1.1:

getAsync method of the Location, Recipients, and Subject objects

Body.getTypeAsync method

body, end, location, optionalAttendees, requiredAttendees, start, subject properties of the Appointment object accessible by the corresponding getAsync method

bcc, body, cc, subject, and to properties of the Message object accessible by the corresponding getAsync method

Setting properties of a message or appointment

Check symbol

Cross symbol

-

-

Assumes mail app is already activated in a compose form.

Get and set item data in a compose form in Outlook

Office.js v1.1:

setAsync method of the Location, Recipients, and Subject objects.

Body.prependAsync method

body, location, optionalAttendees, requiredAttendees, subject properties of the Appointment object accessible by the corresponding setAsync method

bcc, body, cc, subject, and to properties of the Message object accessible by the corresponding setAsync method

Setting data in selection in the body of a message or appointment

Check symbol

Cross symbol

-

-

Assumes mail app is already activated in a compose form.

How to: Insert data in the body when composing an appointment or message in Outlook

Office.js v1.1:

Body.setSelectedDataAsync method

Appointment.body property

Message.body property

Adding or removing attachments from an item

Check symbol

Cross symbol

-

-

Assumes mail app is already activated in a compose form.

Add and remove attachments to an item in a compose form in Outlook

Office.js v1.1:

addFileAttachmentAsync method of the appointment or message item

addItemAttachmentAsync method of the appointment or message item

removeAttachmentAsync method of the appointment or message item

Show:
© 2015 Microsoft