Skip to content

[Outlook] (mobile) Update supported Office.Recipients methods #5273

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 7, 2025
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion docs/outlook/get-set-or-add-recipients.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Get, set, or add recipients when composing an appointment or message in Outlook
description: Learn how to get, set, or add recipients to a message or appointment in an Outlook add-in.
ms.date: 02/29/2024
ms.date: 08/06/2025
ms.topic: how-to
ms.localizationpriority: medium
---
Expand Down Expand Up @@ -139,6 +139,13 @@ When calling `setAsync`, provide an array as the input argument for the `recipie

You can optionally provide a callback function as an input argument to the `setAsync` method, to make sure any code that depends on successfully setting the recipients would execute only when that happens. If you implement a callback function, use the `status` and `error` properties of the `asyncResult` output parameter to check the status and any error messages of the asynchronous call. To provide additional information to the callback function, use the optional `asyncContext` parameter in the `setAsync` call.

> [!NOTE]
>
> In Outlook on mobile devices, be mindful of the following:
>
> - The `addAsync` method is supported starting in Version 4.2530.0.
> - The `addAsync` isn't supported when a user replies from the reply field at the bottom of a message.

```js
let item;

Expand Down Expand Up @@ -233,6 +240,13 @@ function setRecipients() {

If you don't want to overwrite any existing recipients in an appointment or message, instead of using `Recipients.setAsync`, use the `Recipients.addAsync` asynchronous method to append recipients. `addAsync` works similarly as `setAsync` in that it requires a `recipients` input argument. You can optionally provide a callback function, and any arguments for the callback using the `asyncContext` parameter. Then, check the status, result, and any error of the asynchronous `addAsync` call using the `asyncResult` output parameter of the callback function. The following example checks if the item being composed is an appointment, then appends two required attendees to it.

> [!NOTE]
>
> In Outlook on mobile devices, be mindful of the following:
>
> - The `addAsync` method is supported starting in Version 4.2530.0.
> - The `addAsync` isn't supported when a user replies from the reply field at the bottom of a message.

```js
let item;

Expand Down
4 changes: 1 addition & 3 deletions docs/outlook/outlook-mobile-apis.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Outlook JavaScript APIs supported in Outlook on mobile devices
description: Learn which Outlook JavaScript APIs are supported in Outlook on mobile devices.
ms.date: 06/12/2025
ms.date: 08/06/2025
ms.localizationpriority: medium
---

Expand Down Expand Up @@ -62,8 +62,6 @@ Although Outlook mobile supports up to requirement set 1.5, there are some APIs
|[Office.context.mailbox.item.getRegexMatches](/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#methods)|Mailbox 1.1|<ul><li>Message Read</li><li>Appointment Attendee</li></ul>|
|[Office.context.mailbox.item.getRegexMatchesByName](/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#methods)|Mailbox 1.1|<ul><li>Message Read</li><li>Appointment Attendee</li></ul>|
|[Office.context.mailbox.item.notificationMessages](/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#methods)|Mailbox 1.3|<ul><li>Appointment Attendee</li><li>Appointment Organizer</li></ul>|
|[Office.context.mailbox.item.bcc.addAsync](/javascript/api/outlook/office.recipients#outlook-office-recipients-addasync-member(1))<br><br>[Office.context.mailbox.item.cc.addAsync](/javascript/api/outlook/office.recipients#outlook-office-recipients-addasync-member(1))<br><br>[Office.context.mailbox.item.to.addAsync](/javascript/api/outlook/office.recipients#outlook-office-recipients-addasync-member(1))|Mailbox 1.1|<ul><li>Message Compose</li></ul>|
|[Office.context.mailbox.item.bcc.setAsync](/javascript/api/outlook/office.recipients#outlook-office-recipients-setasync-member(1))<br><br>[Office.context.mailbox.item.cc.setAsync](/javascript/api/outlook/office.recipients#outlook-office-recipients-setasync-member(1))<br><br>[Office.context.mailbox.item.to.setAsync](/javascript/api/outlook/office.recipients#outlook-office-recipients-setasync-member(1))|Mailbox 1.1|<ul><li>Message Compose</li></ul>|
|[Office.context.mailbox.item.body.getTypeAsync](/javascript/api/outlook/office.body#outlook-office-body-gettypeasync-member(1))|Mailbox 1.1|<ul><li>Message Compose</li></ul>|
|[Office.context.mailbox.item.body.prependAsync](/javascript/api/outlook/office.body#outlook-office-body-prependasync-member(1))|Mailbox 1.1|<ul><li>Message Compose</li></ul>|
|[Office.context.mailbox.item.body.setAsync](/javascript/api/outlook/office.body#outlook-office-body-setasync-member(1))|Mailbox 1.1|<ul><li>Message Compose</li></ul>|
Expand Down