List childFolders
Namespace: microsoft.graph
Important
APIs under the /beta
version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Get the folder collection under the specified folder. You can use the .../me/mailFolders
shortcut to get the top-level
folder collection and navigate to another folder.
By default, this operation does not return hidden folders. Use a query parameter includeHiddenFolders to include them in the response.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissions
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. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | Mail.ReadBasic | Mail.ReadWrite, Mail.Read |
Delegated (personal Microsoft account) | Mail.ReadBasic | Mail.ReadWrite, Mail.Read |
Application | Mail.ReadBasic.All | Mail.ReadWrite, Mail.Read |
HTTP request
To get all the child folders under the specified folder, excluding those that are hidden:
GET /me/mailFolders/{id}/childFolders
GET /users/{id | userPrincipalName}/mailFolders/{id}/childFolders
To include hidden child folders in the response:
GET /me/mailFolders/{id}/childFolders?includeHiddenFolders=true
GET /users/{id | userPrincipalName}/mailFolders/{id}/childFolders?includeHiddenFolders=true
Optional query parameters
To return a list of all childFolders including those that are hidden (their isHidden property is true), in the request URL, specify the includeHiddenFolders
query parameter as true
, as shown in the HTTP request section.
This method supports the OData Query Parameters to help customize the response.
Request headers
Name | Type | Description |
---|---|---|
Authorization | string | Bearer {token}. Required. Learn more about authentication and authorization. |
Request body
Don't supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and collection of mailFolder objects in the response body.
Examples
Example 1: List mail folders
Request
The following example shows a request.
GET https://graph.microsoft.com/beta/me/mailFolders/AAMkAGVmMDEzM/childFolders
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"id": "AAMkAGVmMDEzA",
"displayName": "Internal Screens",
"parentFolderId": "AAMkAGVmMDEzM",
"childFolderCount": 0,
"unreadItemCount": 2,
"totalItemCount": 2,
"wellKnownName": null,
"isHidden": false
},
{
"id": "AAMkAGVmMDEzB",
"displayName": "Project Falcon",
"parentFolderId": "AAMkAGVmMDEzM",
"childFolderCount": 0,
"unreadItemCount": 5,
"totalItemCount": 5,
"wellKnownName": null,
"isHidden": false
},
{
"id": "AAMkAGVmMDEzMA",
"displayName": "Finder",
"parentFolderId": "AAMkAGVmMDEzM",
"childFolderCount": 4,
"unreadItemCount": 0,
"totalItemCount": 0,
"wellKnownName": "searchfolders",
"isHidden": false
}
]
}
Example 2: List mail search folders
Request
The following example shows a request.
GET https://graph.microsoft.com/beta/me/mailFolders/searchfolders/childFolders
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"@odata.type": "#microsoft.graph.mailSearchFolder",
"id": "AAMkAGE1NWMz",
"displayName": "Get MyAnalytics",
"parentFolderId": "AAMkAGE1NWMx",
"childFolderCount": 0,
"unreadItemCount": 6,
"totalItemCount": 6,
"isHidden": false,
"wellKnownName": null,
"isSupported": true,
"filterQuery": "contains(subject, 'MyAnalytics')"
},
{
"@odata.type": "#microsoft.graph.mailSearchFolder",
"id": "AAMkAGE1NWMy",
"displayName": "Action Required",
"parentFolderId": "AAMkAGE1NWMx",
"childFolderCount": 0,
"unreadItemCount": 2,
"totalItemCount": 4,
"isHidden": false,
"wellKnownName": null,
"isSupported": true,
"filterQuery": "contains(subject, 'ACTION REQUIRED')"
}
]
}
Example 3: Include hidden child folders under a specified mail folder
The next example uses the includeHiddenFolders
query parameter to get a list of child folders under a specified mail folder including hidden mail folders. The response includes the "Clutters" folder that has the isHidden set to true.
Request
The following example shows a request.
GET https://graph.microsoft.com/beta/me/mailFolders/AAMkAGVmMDEzM/childFolders?includeHiddenFolders=true
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"id": "AAMkAGVmMDEzA",
"displayName": "Internal Screens",
"parentFolderId": "AAMkAGVmMDEzM",
"childFolderCount": 0,
"unreadItemCount": 2,
"totalItemCount": 2,
"wellKnownName": null,
"isHidden": false
},
{
"id": "AAMkAGVmMDEzB",
"displayName": "Clutters",
"parentFolderId": "AAMkAGVmMDEzM",
"childFolderCount": 0,
"unreadItemCount": 5,
"totalItemCount": 5,
"wellKnownName": null,
"isHidden": true
},
{
"id": "AAMkAGVmMDEzMA",
"displayName": "Finder",
"parentFolderId": "AAMkAGVmMDEzM",
"childFolderCount": 4,
"unreadItemCount": 0,
"totalItemCount": 0,
"wellKnownName": "searchfolders",
"isHidden": false
}
]
}
Váš názor
https://aka.ms/ContentUserFeedback.
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu:Odeslat a zobrazit názory pro