Skip to content

Commit 19f950d

Browse files
DanielabomDanielabom
authored
Merge pull request #25951 from microsoftgraph/cparker/createExoImportExportDocs
Cparker/create exo import export docs
2 parents 5439add + c16e790 commit 19f950d

Some content is hidden

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

47 files changed

+2638
-7
lines changed

‎.vscode/settings.json

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,12 @@
1717
"cloud.exclusions.json"
1818
],
1919
"url": "https://raw.githubusercontent.com/microsoftgraph/msgraph-cloud-support/main/schema/cloud.exclusions.schema.json"
20-
}
20+
},
21+
{
22+
"fileMatch": [
23+
"toc.mapping.json"
24+
],
25+
"url": "https://raw.githubusercontent.com/microsoftgraph/msgraph-toc-gen/main/schema/toc.mapping.schema.json"
26+
}
2127
]
2228
}

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

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
---
2+
title: "mailbox: createImportSession"
3+
description: "Create a session to import an Exchange mailbox item using its FastTransfer stream (FTS) format."
4+
author: "cparker-msft"
5+
ms.date: 12/06/2024
6+
ms.localizationpriority: medium
7+
ms.subservice: "outlook"
8+
doc_type: apiPageType
9+
---
10+
11+
# mailbox: createImportSession
12+
13+
Namespace: microsoft.graph
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
Create a session to [import an Exchange mailbox item](/graph/import-exchange-mailbox-item) using its [FastTransfer stream](/openspecs/exchange_server_protocols/ms-oxcfxics/a2648823-0a98-43ee-98e8-590e4f7bcbbe) (FTS) format.
18+
19+
## Permissions
20+
21+
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
22+
23+
<!-- {
24+
"blockType": "permissions",
25+
"name": "mailbox-createimportsession-permissions"
26+
}
27+
-->
28+
[!INCLUDE [permissions-table](../includes/permissions/mailbox-createimportsession-permissions.md)]
29+
30+
## HTTP request
31+
32+
<!-- {
33+
"blockType": "ignored"
34+
}
35+
-->
36+
``` http
37+
POST /admin/exchange/mailboxes/{mailboxId}/createImportSession
38+
```
39+
40+
## Request headers
41+
42+
|Name|Description|
43+
|:---|:---|
44+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
45+
46+
## Request body
47+
48+
Don't supply a request body for this method.
49+
50+
## Response
51+
52+
If successful, this action returns a `200 OK` response code and a [mailboxItemImportSession](../resources/mailboxitemimportsession.md) in the response body.
53+
54+
## Examples
55+
56+
### Request
57+
58+
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+
60+
<!-- {
61+
"blockType": "request",
62+
"name": "mailboxthis.createimportsession",
63+
"sampleKeys": ["MBX:e0643f21@a7809c93"]
64+
}
65+
-->
66+
``` http
67+
POST https://graph.microsoft.com/beta/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/createImportSession
68+
```
69+
70+
### Response
71+
72+
The following example shows the response.
73+
>**Note:** The response object shown here might be shortened for readability.
74+
<!-- {
75+
"blockType": "response",
76+
"truncated": true,
77+
"@odata.type": "microsoft.graph.mailboxItemImportSession"
78+
}
79+
-->
80+
``` http
81+
HTTP/1.1 200 OK
82+
Content-type: application/json
83+
Content-length: 232
84+
85+
{
86+
"@odata.context": "https://graph.microsoft.com/beta/$metadata#microsoft.graph.mailboxItemImportSession",
87+
"importUrl": "https://outlook.office365.com/api/gbeta/Mailboxes('MBX:e0643f21@a7809c93')/importItem?authtoken=eyJhbGciOiJSUzI1NiIsImtpZCI6IjFTeXQ1b",
88+
"expirationDateTime": "2024-10-17T19:00:48.1052906Z"
89+
}
90+
```

‎api-reference/beta/api/mailbox-delete-folders.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
title: "Delete mailboxFolder"
3+
description: "Delete a mailboxFolder or a child mailboxFolder within a mailbox."
4+
author: "cparker-msft"
5+
ms.date: 12/06/2024
6+
ms.localizationpriority: medium
7+
ms.subservice: "outlook"
8+
doc_type: apiPageType
9+
---
10+
11+
# Delete mailboxFolder
12+
13+
Namespace: microsoft.graph
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
Delete a [mailboxFolder](../resources/mailboxfolder.md) or a child **mailboxFolder** within a mailbox.
18+
19+
## Permissions
20+
21+
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
22+
23+
<!-- {
24+
"blockType": "permissions",
25+
"name": "mailbox-delete-folders-permissions"
26+
}
27+
-->
28+
[!INCLUDE [permissions-table](../includes/permissions/mailbox-delete-folders-permissions.md)]
29+
30+
## HTTP request
31+
32+
<!-- {
33+
"blockType": "ignored"
34+
}
35+
-->
36+
``` http
37+
DELETE /admin/exchange/mailboxes/{mailboxId}/folders/{mailboxFolderId}/$ref
38+
DELETE /admin/exchange/mailboxes/{mailboxId}/folders/{mailboxFolderId}/childFolders/{mailboxFolderId}/$ref
39+
```
40+
41+
## Request headers
42+
43+
|Name|Description|
44+
|:---|:---|
45+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
46+
47+
## Request body
48+
49+
Don't supply a request body for this method.
50+
51+
## Response
52+
53+
If successful, this method returns a `204 No Content` response code.
54+
55+
## Examples
56+
57+
### Request
58+
59+
The following example shows how to delete a mailbox folder.
60+
<!-- {
61+
"blockType": "request",
62+
"name": "delete_mailboxfolder",
63+
"sampleKeys": ["MBX:e0648f21@aab09c93", "AAMkAGVmMDEzM"]
64+
}
65+
-->
66+
``` http
67+
DELETE https://graph.microsoft.com/beta/admin/exchange/mailboxes/MBX:e0648f21@aab09c93/folders/AAMkAGVmMDEzM/$ref
68+
```
69+
70+
### Response
71+
72+
The following example shows the response.
73+
74+
<!-- {
75+
"blockType": "response",
76+
"truncated": true
77+
}
78+
-->
79+
``` http
80+
HTTP/1.1 204 No Content
81+
```

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

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
---
2+
title: "mailbox: exportItems"
3+
description: "Export Exchange mailboxItem objects in full-fidelity FastTransfer format for backup purposes."
4+
author: "cparker-msft"
5+
ms.date: 12/06/2024
6+
ms.localizationpriority: medium
7+
ms.subservice: "outlook"
8+
doc_type: apiPageType
9+
---
10+
11+
# mailbox: exportItems
12+
13+
Namespace: microsoft.graph
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
Export Exchange [mailboxItem](../resources/mailboxitem.md) objects in full-fidelity [FastTransfer stream](/openspecs/exchange_server_protocols/ms-oxcfxics/ed7d3455-9bdf-40eb-90bd-8dfe6164a250#gt_12daff0e-4241-4498-a93f-212795ab2450) format for backup purposes. This item format can be restored to the same mailbox or a different one.
18+
19+
You can export up to 20 items in a single export request.
20+
21+
## Permissions
22+
23+
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
24+
25+
<!-- {
26+
"blockType": "permissions",
27+
"name": "mailbox-exportitems-permissions"
28+
}
29+
-->
30+
[!INCLUDE [permissions-table](../includes/permissions/mailbox-exportitems-permissions.md)]
31+
32+
## HTTP request
33+
34+
<!-- {
35+
"blockType": "ignored"
36+
}
37+
-->
38+
``` http
39+
POST /admin/exchange/mailboxes/{mailboxId}/exportItems
40+
```
41+
42+
## Request headers
43+
44+
|Name|Description|
45+
|:---|:---|
46+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
47+
|Content-Type|application/json. Required.|
48+
49+
## Request body
50+
51+
In the request body, supply a JSON representation of the parameters.
52+
53+
The following table lists the parameters that are required when you call this action.
54+
55+
|Parameter|Type|Description|
56+
|:---|:---|:---|
57+
|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.|
58+
59+
## Response
60+
61+
If successful, this action returns a `200 OK` response code and a collection of [exportItemResponse](../resources/exportitemresponse.md) objects in the response body.
62+
63+
## Examples
64+
65+
### Request
66+
67+
The following example exports two items present in the user's mailbox. The **itemIds** of the items to be exported are specified in the request body.
68+
<!-- {
69+
"blockType": "request",
70+
"name": "mailboxthis.exportitems",
71+
"sampleKeys": ["MBX:e0643f21@a7809c93"]
72+
}
73+
-->
74+
``` http
75+
POST https://graph.microsoft.com/beta/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/exportItems
76+
Content-type: application/json
77+
78+
{
79+
"itemIds": [
80+
"EDSVrdi3lRAADmpnf1AAA=",
81+
"EDSVrdi3lRAAD45b7RAAA="
82+
]
83+
}
84+
```
85+
86+
### Response
87+
88+
The following example shows the response.
89+
>**Note:** The response object shown here might be shortened for readability.
90+
<!-- {
91+
"blockType": "response",
92+
"truncated": true,
93+
"@odata.type": "Collection(microsoft.graph.exportItemResponse)"
94+
}
95+
-->
96+
``` http
97+
HTTP/1.1 200 OK
98+
Content-type: application/json
99+
Content-length: 232
100+
101+
{
102+
"@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.exportItemResponse)",
103+
"value": [
104+
{
105+
"itemId": "EDSVrdi3lRAADmpnf1AAA=",
106+
"changeKey": "CQAAABYAAACQ2fKdhq8oSKEDSVrdi3lRAAEu4C+G"
107+
},
108+
{
109+
"itemId": "EDSVrdi3lRAAD45b7RAAA=",
110+
"changeKey": "CQAAABYAAACQ2fKdhq8oSKEDSVrdi3lRAAD4pUax"
111+
}
112+
]
113+
}
114+
```

0 commit comments

Comments
 (0)