Recipients object (JavaScript API for Office)

Office Add-ins

Provides methods to get and set the recipients of an appointment or message. This object was introduced in version 1.1.

Last modified: July 06, 2015

Note Note

The name "apps for Office" is changing to "Office Add-ins". During the transition, the documentation and the UI of some Office host applications and Visual Studio tools might still use the term "apps for Office". For details, see New name for apps for Office and SharePoint.

Hosts:Outlook

App type: Mail

Available in requirement sets

Mailbox

Last changed in Mailbox

1.1

Applicable Outlook modes

Compose

See all support details

Office.context.mailbox.item.location;

Methods

Method name

Outlook mode

Description

Introduced in

addAsync

Compose

Adds recipients to the item.

Version 1.1

getAsync

Compose

Gets the recipients of an item.

Version 1.1

setAsync

Compose

Sets the recipients of an item.

Version 1.1

A Recipients object is returned from the following properties in compose mode.

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 Online
(in browser)

OWA for Devices

Outlook

Available in requirement sets

Mailbox

Minimum permission level

ReadItem

App types

Mail

Library

Office.js

Namespace

Office

Version

Changes

1.1

Introduced

Show:
© 2015 Microsoft