Skip to content
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

[Outlook] (EWS, REST) Update guidance and supported Exchange environments #4850

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all 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
8 changes: 8 additions & 0 deletions .openpublishing.redirection.json
Original file line number Diff line number Diff line change
Expand Up @@ -1292,6 +1292,14 @@
{
"source_path": "docs/outlook/activation-rules.md",
"redirect_url": "/javascript/api/manifest/rule"
},
{
"source_path": "docs/outlook/get-and-set-item-data-in-a-compose-form.md",
"redirect_url": "/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets"
},
{
"source_path": "docs/outlook/item-data.md",
"redirect_url": "/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets"
}
]
}
2 changes: 1 addition & 1 deletion docs/includes/mailbox-object-desc.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Outlook add-ins primarily use a subset of the API exposed through the [Mailbox](/javascript/api/outlook/office.mailbox) object. To access the objects and members specifically for use in Outlook add-ins, such as the [Item](/javascript/api/outlook/office.item) object, use the [mailbox](/javascript/api/office/office.context#office-office-context-mailbox-member) property of the **Context** object to access the **Mailbox** object, as shown in the following line of code.
Outlook add-ins primarily use a subset of the API exposed through the [Mailbox](/javascript/api/outlook/office.mailbox) object. To access the objects and members for use in Outlook add-ins, such as the [Item](/javascript/api/outlook/office.item) object in compose or read mode, use the [mailbox](/javascript/api/office/office.context#office-office-context-mailbox-member) property of the **Context** object to access the **Mailbox** object. The following code is an example.

```js
// Access the Item object.
Expand Down

Large diffs are not rendered by default.

12 changes: 5 additions & 7 deletions docs/outlook/add-mobile-support.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Add support for add-in commands in Outlook on mobile devices
description: Learn how to add support for Outlook on mobile devices including how to update the add-in manifest and change your code for mobile scenarios, if necessary.
ms.date: 09/25/2024
ms.date: 10/17/2024
ms.localizationpriority: medium
---

Expand All @@ -20,7 +20,7 @@ The first step to enabling add-in commands in Outlook mobile is to define them i
```json
"formFactors": [
"mobile",
<!-- Typically there will be other form factors listed. -->
<!-- Typically, there will be other form factors listed. -->
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<!-- Typically, there will be other form factors listed. -->
<!-- Typically, there'll be other form factors listed. -->

]
```

Expand Down Expand Up @@ -58,7 +58,7 @@ The first step to enabling add-in commands in Outlook mobile is to define them i
{
"builtInTabId": "TabDefault",
"groups": [
<-- non-mobile group objects omitted -->
<-- Non-mobile group objects omitted. -->
],
"customMobileRibbonGroups": [
{
Expand Down Expand Up @@ -181,11 +181,9 @@ This is very similar to the elements that appear in a [DesktopFormFactor](/javas

Designing an add-in for mobile introduces some additional considerations.

### Use REST instead of Exchange Web Services
### Use Microsoft Graph

The [Office.context.mailbox.makeEwsRequestAsync](/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox#methods) method isn't supported in Outlook mobile. Add-ins should prefer to get information from the Office.js API when possible. If add-ins require information not exposed by the Office.js API, then they should use the [Outlook REST APIs](use-rest-api.md) to access the user's mailbox.

Mailbox requirement set 1.5 introduced a new version of [Office.context.mailbox.getCallbackTokenAsync](/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox#methods) that can request an access token compatible with the REST APIs, and a new [Office.context.mailbox.restUrl](/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox#properties) property that can be used to find the REST API endpoint for the user.
Add-ins should prefer to get information from the Office.js API when possible. If your add-in requires information not exposed by the Office.js API, use [Microsoft Graph](/graph/overview) to access the user's mailbox.

### Pinch zoom

Expand Down
1 change: 0 additions & 1 deletion docs/outlook/compose-scenario.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ Compose add-ins are implemented as [add-in commands](../design/add-in-commands.m
## API features available to compose add-ins

- [Add and remove attachments to an item in a compose form in Outlook](add-and-remove-attachments-to-an-item-in-a-compose-form.md)
- [Get and set item data in a compose form in Outlook](get-and-set-item-data-in-a-compose-form.md)
- [Get, set, or add recipients when composing an appointment or message in Outlook](get-set-or-add-recipients.md)
- [Get or set the subject when composing an appointment or message in Outlook](get-or-set-the-subject.md)
- [Insert data in the body when composing an appointment or message in Outlook](insert-data-in-the-body.md)
Expand Down
42 changes: 0 additions & 42 deletions docs/outlook/get-and-set-item-data-in-a-compose-form.md

This file was deleted.

Loading