Export (0) Print
Expand All

Entities object (JavaScript API for Office)

apps for Office

Represents a collection of entities found in an email message or appointment.

Last modified: March 09, 2015

Hosts:Outlook

App type: Mail

Available in requirement sets

Mailbox

Last changed in Mailbox

1.0

Applicable Outlook modes

Read

See all support details

Entities

Properties

Property name

Outlook mode

Description

Introduced in

addresses

Read

Gets one or more physical addresses found in the item.

Version 1.0

contacts

Read

Gets one or more contacts found in the item.

Version 1.0

emailAddresses

Read

Gets one or more SMTP email addresses found in the item.

Version 1.0

meetingSuggestions

Read

Gets one or more meeting suggestions found in the item.

Version 1.0

phoneNumbers

Read

Gets one or more phone numbers found in the item.

Version 1.0

taskSuggestions

Read

Gets one or more task suggestions found in the item.

Version 1.0

urls

Read

Gets one or more URLs found in the item.

Version 1.0

The Entities object is a container for the entity arrays returned by the getEntities and getEntitiesByType methods when the item (either an email message or an appointment) contains one or more entities that have been found by the Exchange Server 2013 server. You can use these entities in your code to provide additional context information to the viewer, such as a map to an address found in the item, or to open a dialer for a phone number found in the item.

You access the properties of the Entities object as an array without reference to the Entities object in your code. For example, to access the addresses property, you would use the following code:

var addresses = getEntities().addresses[];

If no entities of the type specified in the property are present in the item, the property associated with that entity is null. For example, if a message contains a street address and a phone number, the addresses property and phoneNumbers property would contain information, and the other properties would be null.

Entity recognition relies on natural language recognition that is based on machine learning of large amounts of data. The recognition of an entity is non-deterministic and success sometimes relies on the particular context in the item.

When the property arrays are returned by the getEntitiesByType method, only the property for the specified entity contains data; all other properties are null.

A checkmark (√) in the following table indicates that this property is supported in the corresponding Outlook host application. An empty cell indicates that the Outlook host application doesn't support this property.

For more information about Office host application and server requirements, see Requirements for running apps for Office.

Supported hosts, by platform

Office for Windows desktop

Office for Windows RT

Office Online
(in browser)

OWA for Devices

Office for Mac

Outlook

√ (Read mode only)

Available in requirement sets

Mailbox

Minimum permission level

ReadItem but some properties accessible with Restricted.

App types

Mail

Library

Office.js

Namespace

Office

Version

Changes

1.0

Introduced

Show:
© 2015 Microsoft