Skip to content

Commit 4178132

Browse files
authored
Merge pull request #28275 from microsoftgraph/exoimexapi-ga-updates
Mailbox Import and Export API GA
2 parents 2d632c1 + 1af9a63 commit 4178132

76 files changed

Lines changed: 2443 additions & 75 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

api-reference/beta/api/mailbox-createimportsession.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "mailbox: createImportSession"
3-
description: "Create a session to import an Exchange mailbox item using its FastTransfer stream (FTS) format."
3+
description: "Create a session to import an Exchange mailbox item that was exported using the exportItems API."
44
author: "cparker-msft"
55
ms.date: 12/06/2024
66
ms.localizationpriority: medium
@@ -56,7 +56,7 @@ If successful, this action returns a `200 OK` response code and a [mailboxItemIm
5656

5757
### Request
5858

59-
The following example shows how to create an import session. The opaque URL, returned in the **importUrl** property of the response, is preauthenticated and contains the appropriate authorization token for subsequent POST queries in the https://outlook.office365.com domain. That token expires by **expirationDateTime**. Don't customize this URL for subsequent POST operations.
59+
The following example shows how to create an import session. The opaque URL, returned in the **importUrl** property of the response, is preauthenticated and contains the appropriate authorization token for subsequent POST queries in the `https://outlook.office365.com` domain. This token expires at the time specified in **expirationDateTime**. Don't customize this URL for subsequent POST operations.
6060

6161
# [HTTP](#tab/http)
6262
<!-- {

api-reference/beta/api/mailbox-exportitems.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "mailbox: exportItems"
3-
description: "Export Exchange mailboxItem objects in full-fidelity FastTransfer format for backup purposes."
3+
description: "Export Exchange mailboxItem objects in full fidelity."
44
author: "cparker-msft"
55
ms.date: 12/06/2024
66
ms.localizationpriority: medium
@@ -14,7 +14,7 @@ Namespace: microsoft.graph
1414

1515
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
1616

17-
Export Exchange [mailboxItem](../resources/mailboxitem.md) objects in full fidelity. This API exports each item as an opaque stream. The data stream isn't intended for parsing, but can be used to import an item back into an Exchange mailbox. For more information, see: [Overview of the mailbox import and export APIs in Microsoft Graph (preview)](/graph/mailbox-import-export-concept-overview)
17+
Export Exchange [mailboxItem](../resources/mailboxitem.md) objects in full fidelity. This API exports each item as an opaque stream. The data stream isn't intended for parsing, but can be used to import an item back into an Exchange mailbox. For more information, see [Overview of the mailbox import and export APIs in Microsoft Graph](/graph/mailbox-import-export-concept-overview).
1818

1919
You can export up to 20 items in a single export request.
2020

@@ -52,7 +52,7 @@ The following table lists the parameters that are required when you call this ac
5252

5353
|Parameter|Type|Description|
5454
|:---|:---|:---|
55-
|itemIds|String collection|A collection of identifiers of [mailboxItem](../resources/mailboxitem.md) objects to export. All identifiers in the collection _must_ be for items in the same mailbox. Maximum size of this collection is 20 strings.|
55+
|itemIds|String collection|A collection of identifiers of [mailboxItem](../resources/mailboxitem.md) objects to export. All identifiers in the collection _must_ be for items in the same mailbox. The maximum size of this collection is 20 strings.|
5656

5757
## Response
5858

api-reference/beta/api/mailbox-list-folders.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ GET /admin/exchange/mailboxes/{mailboxId}/folders
3737

3838
## Optional query parameters
3939

40-
This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
40+
This method supports the `$select`, `$filter`, `$top`, `$skip`, `$orderby`, `$count`, and `$expand` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
4141

4242
## Request headers
4343

api-reference/beta/api/mailboxfolder-delta.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "mailboxFolder: delta"
3-
description: "Get a set of mailboxFolder objects that have been added, deleted, or removed from the user's mailbox."
3+
description: "Get a set of mailboxFolder objects that were added, deleted, or removed from the user's mailbox."
44
author: "cparker-msft"
55
ms.date: 12/06/2024
66
ms.localizationpriority: medium
@@ -14,7 +14,7 @@ Namespace: microsoft.graph
1414

1515
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
1616

17-
Get a set of [mailboxFolder](../resources/mailboxfolder.md) objects that have been added, deleted, or removed from the user's mailbox.
17+
Get a set of [mailboxFolder](../resources/mailboxfolder.md) objects that were added, deleted, or removed from the user's mailbox.
1818

1919
A **delta** function call for folders in a mailbox is similar to a GET request, except that by appropriately applying [state tokens](/graph/delta-query-overview) in one or more of these calls, you can query for incremental changes in the folders. This approach allows you to maintain and synchronize a local store of a user's mail folders without having to fetch all the folders of that mailbox from the server every time.
2020

@@ -56,7 +56,7 @@ You can use the `$select` query parameter to specify only the properties you nee
5656
|Name|Description|
5757
|:---|:---|
5858
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
59-
|Prefer|odata.maxpagesize={x}. Optional.|
59+
|Prefer|odata.maxpagesize={x}. Optional. Controls page size.|
6060

6161
## Request body
6262

api-reference/beta/api/mailboxfolder-get.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ GET /admin/exchange/mailboxes/{mailboxId}/folders/{mailboxFolderId}/childFolders
3838

3939
## Optional query parameters
4040

41-
This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
41+
This method supports the `$select` and `$expand` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
4242

4343
## Request headers
4444

api-reference/beta/api/mailboxfolder-list-childfolders.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ GET /admin/exchange/mailboxes/{mailboxId}/folders/{mailboxFolderId}/childFolders
4141

4242
## Optional query parameters
4343

44-
This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
44+
This method supports the `$select`, `$filter`, `$top`, `$skip`, `$orderby`, `$count`, and `$expand` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
4545

4646
## Request headers
4747

api-reference/beta/api/mailboxfolder-list-items.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ GET /admin/exchange/mailboxes/{mailboxId}/folders/{mailboxFolderId}/items
3737

3838
## Optional query parameters
3939

40-
This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
40+
This method supports the `$select`, `$filter`, `$top`, `$skip`, `$orderby`, `$count`, and `$expand` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
4141

4242
## Request headers
4343

@@ -149,7 +149,7 @@ Content-length: 232
149149

150150
### Example 2: List items using query parameter
151151

152-
The following example uses the `$filter`, `$select`, and `$top` query parameters. The `$filter` parameter refines the results and returns only items with **createdDateTime** between `2021-08-21` and `2021-09-16`. The `$select` parameter specifies to return only a subset of the properties of each item in the response, and the `$top` parameter sets the page size of the result set to return only the top item in the mailbox under the specified folder.
152+
The following example uses the `$filter`, `$select`, and `$top` query parameters. The `$filter` parameter refines the results and returns only items with **createdDateTime** between `2021-08-21` and `2021-09-16`. The `$select` parameter specifies that only a subset of properties for each item should be returned in the response, and the `$top` parameter sets the page size of the result set to return only the top item in the mailbox under the specified folder.
153153

154154
#### Request
155155

api-reference/beta/api/mailboxitem-delta.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "mailboxItem: delta"
3-
description: "Get a set of mailboxItem objects that have been added, deleted, or updated in a specified folder."
3+
description: "Get a set of mailboxItem objects that were added, deleted, or updated in a specified folder."
44
author: "cparker-msft"
55
ms.date: 12/06/2024
66
ms.localizationpriority: medium
@@ -14,7 +14,7 @@ Namespace: microsoft.graph
1414

1515
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
1616

17-
Get a set of [mailboxItem](../resources/mailboxitem.md) objects that have been added, deleted, or updated in a specified [mailboxFolder](../resources/mailboxfolder.md).
17+
Get a set of [mailboxItem](../resources/mailboxitem.md) objects that were added, deleted, or updated in a specified [mailboxFolder](../resources/mailboxfolder.md).
1818

1919
A **delta** function call for items in a folder is similar to a GET request, except that by appropriately applying [state tokens](/graph/delta-query-overview) in one or more of these calls, you can [query for incremental changes in the items in that folder](/graph/delta-query-messages). This approach allows you to maintain and synchronize a local store of a user's mailbox items without having to fetch the entire set of items from the server every time.
2020

@@ -60,7 +60,7 @@ Tracking changes in items incurs a round of one or more **delta** function calls
6060
|Name|Description|
6161
|:---|:---|
6262
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
63-
|Prefer|odata.maxpagesize={x}. Optional.|
63+
|Prefer|odata.maxpagesize={x}. Optional. Controls page size.|
6464

6565
## Request body
6666

api-reference/beta/api/mailboxitem-get.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ GET /admin/exchange/mailboxes/{mailboxId}/folders/{mailboxFolderId}/items/{mailb
3737

3838
## Optional query parameters
3939

40-
This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
40+
This method supports the `$select` and `$expand` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
4141

4242
## Request headers
4343

api-reference/beta/api/multivaluelegacyextendedproperty-get.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ The following user resources are supported:
2828
- [contact](../resources/contact.md)
2929
- [contactFolder](../resources/contactfolder.md)
3030
- [event](../resources/event.md)
31+
- [mailboxFolder](../resources/mailboxfolder.md)
32+
- [mailboxItem](../resources/mailboxitem.md)
3133
- [mailFolder](../resources/mailfolder.md)
3234
- [message](../resources/message.md)
3335
- [note](../resources/note.md)
@@ -57,6 +59,8 @@ Depending on the resource you're getting the extended property from and the perm
5759
| group [calendar](../resources/calendar.md) | Group.Read.All | Not supported | Not supported |
5860
| group [event](../resources/event.md) | Group.Read.All | Not supported | Not supported |
5961
| group [post](../resources/post.md) | Group.Read.All | Not supported | Group.Read.All |
62+
| [mailboxFolder](../resources/mailboxfolder.md) | MailboxFolder.Read | Not supported. | MailboxFolder.Read.All |
63+
| [mailboxItem](../resources/mailboxitem.md) | MailboxItem.Read | Not supported. | MailboxItem.Read.All |
6064
| [mailFolder](../resources/mailfolder.md) | Mail.Read | Mail.Read | Mail.Read |
6165
| [message](../resources/message.md) | Mail.Read | Mail.Read | Mail.Read |
6266
| [note](../resources/note.md) | ShortNotes.Read | ShortNotes.Read | ShortNotes.Read |
@@ -122,6 +126,24 @@ GET /users/{id|userPrincipalName}/contactFolders/{id}?$expand=multiValueExtended
122126

123127
[!INCLUDE [me-apis-sign-in-note](../includes/me-apis-sign-in-note.md)]
124128

129+
Get a **mailboxItem** instance:
130+
<!-- { "blockType": "ignored" } -->
131+
```http
132+
GET /admin/exchange/mailboxes/{mailboxId}/folders/{mailboxFolderId}/items?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
133+
GET /admin/exchange/mailboxes/{mailboxId}/folders/{mailboxFolderId}/items/{mailboxItemId}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
134+
```
135+
136+
[!INCLUDE [me-apis-sign-in-note](../includes/me-apis-sign-in-note.md)]
137+
138+
Get a **mailboxFolder** instance:
139+
<!-- { "blockType": "ignored" } -->
140+
```http
141+
GET /admin/exchange/mailboxes/{mailboxId}/folders?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
142+
GET /admin/exchange/mailboxes/{mailboxId}/folders/{mailboxFolderId}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
143+
```
144+
145+
[!INCLUDE [me-apis-sign-in-note](../includes/me-apis-sign-in-note.md)]
146+
125147
Get a **note** instance:
126148
<!-- { "blockType": "ignored" } -->
127149
```http

0 commit comments

Comments
 (0)