Skip to content

Commit ca23f9c

Browse files
authored
Merge branch 'main' into sfiImages
2 parents 5fcf60e + 236b420 commit ca23f9c

File tree

66 files changed

+2662
-281
lines changed

Some content is hidden

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

66 files changed

+2662
-281
lines changed

.vscode/settings.json

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
"main",
44
"main",
55
"main",
6+
"main",
67
"main"
78
],
89
"json.schemas": [
@@ -17,6 +18,12 @@
1718
"cloud.exclusions.json"
1819
],
1920
"url": "https://raw.githubusercontent.com/microsoftgraph/msgraph-cloud-support/main/schema/cloud.exclusions.schema.json"
20-
}
21+
},
22+
{
23+
"fileMatch": [
24+
"toc.mapping.json"
25+
],
26+
"url": "https://raw.githubusercontent.com/microsoftgraph/msgraph-toc-gen/main/schema/toc.mapping.schema.json"
27+
}
2128
]
2229
}

README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ Thank you for your interest in Microsoft Graph documentation! For the best exper
44

55
## Give us your feedback
66

7-
**Coming soon:** In March 2024, we will be phasing out the current feedback mechanism for content (GitHub issues) described below and replacing it with a new feedback system. For more information, see https://aka.ms/ContentUserFeedback.
8-
97
Your feedback is important to us.
108

119
- To let us know about any questions or issues you find in the documentation, [leave feedback using the standard experience](https://learn.microsoft.com/en-us/contribute/content/provide-feedback#use-the-standard-experience).
Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
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+
<!-- { "blockType": "permissions", "name": "mailbox_createimportsession" } -->
24+
[!INCLUDE [permissions-table](../includes/permissions/mailbox-createimportsession-permissions.md)]
25+
26+
## HTTP request
27+
28+
<!-- {
29+
"blockType": "ignored"
30+
}
31+
-->
32+
``` http
33+
POST /admin/exchange/mailboxes/{mailboxId}/createImportSession
34+
```
35+
36+
## Request headers
37+
38+
|Name|Description|
39+
|:---|:---|
40+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
41+
42+
## Request body
43+
44+
Don't supply a request body for this method.
45+
46+
## Response
47+
48+
If successful, this action returns a `200 OK` response code and a [mailboxItemImportSession](../resources/mailboxitemimportsession.md) in the response body.
49+
50+
## Examples
51+
52+
### Request
53+
54+
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.
55+
56+
<!-- {
57+
"blockType": "request",
58+
"name": "mailboxthis.createimportsession",
59+
"sampleKeys": ["MBX:e0643f21@a7809c93"]
60+
}
61+
-->
62+
``` http
63+
POST https://graph.microsoft.com/beta/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/createImportSession
64+
```
65+
66+
### Response
67+
68+
The following example shows the response.
69+
>**Note:** The response object shown here might be shortened for readability.
70+
<!-- {
71+
"blockType": "response",
72+
"truncated": true,
73+
"@odata.type": "microsoft.graph.mailboxItemImportSession"
74+
}
75+
-->
76+
``` http
77+
HTTP/1.1 200 OK
78+
Content-type: application/json
79+
Content-length: 232
80+
81+
{
82+
"@odata.context": "https://graph.microsoft.com/beta/$metadata#microsoft.graph.mailboxItemImportSession",
83+
"importUrl": "https://outlook.office365.com/api/gbeta/Mailboxes('MBX:e0643f21@a7809c93')/importItem?authtoken=eyJhbGciOiJSUzI1NiIsImtpZCI6IjFTeXQ1b",
84+
"expirationDateTime": "2024-10-17T19:00:48.1052906Z"
85+
}
86+
```
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
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+
<!-- { "blockType": "permissions", "name": "mailbox_delete_folders" } -->
24+
[!INCLUDE [permissions-table](../includes/permissions/mailbox-delete-folders-permissions.md)]
25+
26+
## HTTP request
27+
28+
<!-- {
29+
"blockType": "ignored"
30+
}
31+
-->
32+
``` http
33+
DELETE /admin/exchange/mailboxes/{mailboxId}/folders/{mailboxFolderId}/$ref
34+
DELETE /admin/exchange/mailboxes/{mailboxId}/folders/{mailboxFolderId}/childFolders/{mailboxFolderId}/$ref
35+
```
36+
37+
## Request headers
38+
39+
|Name|Description|
40+
|:---|:---|
41+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
42+
43+
## Request body
44+
45+
Don't supply a request body for this method.
46+
47+
## Response
48+
49+
If successful, this method returns a `204 No Content` response code.
50+
51+
## Examples
52+
53+
### Request
54+
55+
The following example shows how to delete a mailbox folder.
56+
<!-- {
57+
"blockType": "request",
58+
"name": "delete_mailboxfolder",
59+
"sampleKeys": ["MBX:e0648f21@aab09c93", "AAMkAGVmMDEzM"]
60+
}
61+
-->
62+
``` http
63+
DELETE https://graph.microsoft.com/beta/admin/exchange/mailboxes/MBX:e0648f21@aab09c93/folders/AAMkAGVmMDEzM/$ref
64+
```
65+
66+
### Response
67+
68+
The following example shows the response.
69+
70+
<!-- {
71+
"blockType": "response",
72+
"truncated": true
73+
}
74+
-->
75+
``` http
76+
HTTP/1.1 204 No Content
77+
```
Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
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+
<!-- { "blockType": "permissions", "name": "mailbox_exportitems" } -->
26+
[!INCLUDE [permissions-table](../includes/permissions/mailbox-exportitems-permissions.md)]
27+
28+
## HTTP request
29+
30+
<!-- {
31+
"blockType": "ignored"
32+
}
33+
-->
34+
``` http
35+
POST /admin/exchange/mailboxes/{mailboxId}/exportItems
36+
```
37+
38+
## Request headers
39+
40+
|Name|Description|
41+
|:---|:---|
42+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
43+
|Content-Type|application/json. Required.|
44+
45+
## Request body
46+
47+
In the request body, supply a JSON representation of the parameters.
48+
49+
The following table lists the parameters that are required when you call this action.
50+
51+
|Parameter|Type|Description|
52+
|:---|:---|:---|
53+
|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.|
54+
55+
## Response
56+
57+
If successful, this action returns a `200 OK` response code and a collection of [exportItemResponse](../resources/exportitemresponse.md) objects in the response body.
58+
59+
## Examples
60+
61+
### Request
62+
63+
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.
64+
<!-- {
65+
"blockType": "request",
66+
"name": "mailboxthis.exportitems",
67+
"sampleKeys": ["MBX:e0643f21@a7809c93"]
68+
}
69+
-->
70+
``` http
71+
POST https://graph.microsoft.com/beta/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/exportItems
72+
Content-type: application/json
73+
74+
{
75+
"itemIds": [
76+
"EDSVrdi3lRAADmpnf1AAA=",
77+
"EDSVrdi3lRAAD45b7RAAA="
78+
]
79+
}
80+
```
81+
82+
### Response
83+
84+
The following example shows the response.
85+
>**Note:** The response object shown here might be shortened for readability.
86+
<!-- {
87+
"blockType": "response",
88+
"truncated": true,
89+
"@odata.type": "Collection(microsoft.graph.exportItemResponse)"
90+
}
91+
-->
92+
``` http
93+
HTTP/1.1 200 OK
94+
Content-type: application/json
95+
Content-length: 232
96+
97+
{
98+
"@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.exportItemResponse)",
99+
"value": [
100+
{
101+
"itemId": "EDSVrdi3lRAADmpnf1AAA=",
102+
"changeKey": "CQAAABYAAACQ2fKdhq8oSKEDSVrdi3lRAAEu4C+G"
103+
},
104+
{
105+
"itemId": "EDSVrdi3lRAAD45b7RAAA=",
106+
"changeKey": "CQAAABYAAACQ2fKdhq8oSKEDSVrdi3lRAAD4pUax"
107+
}
108+
]
109+
}
110+
```

0 commit comments

Comments
 (0)