命名空间：microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。
获取指定文件夹下的文件夹集合。 你可以使用 .../me/mailFolders 快捷方式获取顶级文件夹集合并导航到其他文件夹。
默认情况下，此操作不会返回隐藏文件夹。 使用查询参数 includeHiddenFolders，将它们包括在答复中。
此 API 可用于以下国家级云部署。
| 全局服务 |
美国政府 L4 |
美国政府 L5 (DOD) |
由世纪互联运营的中国 |
| ✅ |
✅ |
✅ |
✅ |
权限
为此 API 选择标记为最低特权的权限。
只有在应用需要它时，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型。 要了解有关这些权限的详细信息，请参阅 权限参考。
| 权限类型 |
最低特权权限 |
更高特权权限 |
| 委派（工作或学校帐户） |
Mail.ReadBasic |
Mail.ReadWrite、Mail.Read |
| 委派（个人 Microsoft 帐户） |
Mail.ReadBasic |
Mail.ReadWrite、Mail.Read |
| 应用程序 |
Mail.ReadBasic.All |
Mail.ReadWrite、Mail.Read |
HTTP 请求
若要获取指定文件夹的所有子文件夹（隐藏文件夹除外），请执行以下操作：
GET /me/mailFolders/{id}/childFolders
GET /users/{id | userPrincipalName}/mailFolders/{id}/childFolders
若要在答复中包括隐藏的子文件夹，请执行以下操作：
GET /me/mailFolders/{id}/childFolders?includeHiddenFolders=true
GET /users/{id | userPrincipalName}/mailFolders/{id}/childFolders?includeHiddenFolders=true
可选的查询参数
若要返回所有 childFolder 的列表（包括隐藏的项目，其 isHidden 属性为 true），则如 HTTP 请求 部分所示，在请求 URL 中，将 includeHiddenFolders 查询参数指定为 true。
此方法支持 OData 查询参数 来帮助自定义响应。
| 名称 |
类型 |
说明 |
| Authorization |
string |
持有者 {token}。 必填。 详细了解 身份验证和授权。 |
请求正文
请勿提供此方法的请求正文。
响应
如果成功，此方法在响应正文中返回 200 OK 响应代码和 mailFolder 对象集合。
示例
示例 1：列出邮件文件夹
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/beta/me/mailFolders/AAMkAGVmMDEzM/childFolders
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.MailFolders["{mailFolder-id}"].ChildFolders.GetAsync();
mgc-beta users mail-folders child-folders list --user-id {user-id} --mail-folder-id {mailFolder-id}
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
//other-imports
)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
childFolders, err := graphClient.Me().MailFolders().ByMailFolderId("mailFolder-id").ChildFolders().Get(context.Background(), nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
MailFolderCollectionResponse result = graphClient.me().mailFolders().byMailFolderId("{mailFolder-id}").childFolders().get();
const options = {
authProvider,
};
const client = Client.init(options);
let childFolders = await client.api('/me/mailFolders/AAMkAGVmMDEzM/childFolders')
.version('beta')
.get();
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$result = $graphServiceClient->me()->mailFolders()->byMailFolderId('mailFolder-id')->childFolders()->get()->wait();
Import-Module Microsoft.Graph.Beta.Mail
# A UPN can also be used as -UserId.
Get-MgBetaUserMailFolderChildFolder -UserId $userId -MailFolderId $mailFolderId
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
result = await graph_client.me.mail_folders.by_mail_folder_id('mailFolder-id').child_folders.get()
响应
以下示例显示了相应的响应。
注意：为了提高可读性，可能缩短了此处显示的响应对象。
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
}
]
}
示例 2：列出邮件搜索文件夹
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/beta/me/mailFolders/searchfolders/childFolders
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.MailFolders["{mailFolder-id}"].ChildFolders.GetAsync();
mgc-beta users mail-folders child-folders list --user-id {user-id} --mail-folder-id {mailFolder-id}
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
//other-imports
)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
childFolders, err := graphClient.Me().MailFolders().ByMailFolderId("mailFolder-id").ChildFolders().Get(context.Background(), nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
MailFolderCollectionResponse result = graphClient.me().mailFolders().byMailFolderId("{mailFolder-id}").childFolders().get();
const options = {
authProvider,
};
const client = Client.init(options);
let childFolders = await client.api('/me/mailFolders/searchfolders/childFolders')
.version('beta')
.get();
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$result = $graphServiceClient->me()->mailFolders()->byMailFolderId('mailFolder-id')->childFolders()->get()->wait();
Import-Module Microsoft.Graph.Beta.Mail
# A UPN can also be used as -UserId.
Get-MgBetaUserMailFolderChildFolder -UserId $userId -MailFolderId $mailFolderId
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
result = await graph_client.me.mail_folders.by_mail_folder_id('mailFolder-id').child_folders.get()
响应
以下示例显示了相应的响应。
注意：为了提高可读性，可能缩短了此处显示的响应对象。
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')"
}
]
}
示例 3：在指定的邮件文件夹下包括隐藏的子文件夹
下一个示例使用 includeHiddenFolders 查询参数获取特定邮件文件夹中的子文件夹列表（包括隐藏的邮件文件夹）。 答复包含isHidden 设置为 true 的“待筛选邮件”文件夹。
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/beta/me/mailFolders/AAMkAGVmMDEzM/childFolders?includeHiddenFolders=true
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.MailFolders["{mailFolder-id}"].ChildFolders.GetAsync((requestConfiguration) =>
{
requestConfiguration.QueryParameters.IncludeHiddenFolders = "true";
});
mgc-beta users mail-folders child-folders list --user-id {user-id} --mail-folder-id {mailFolder-id} --include-hidden-folders "true"
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphusers "github.com/microsoftgraph/msgraph-beta-sdk-go/users"
//other-imports
)
requestIncludeHiddenFolders := "true"
requestParameters := &graphusers.MailFoldersItemChildFoldersRequestBuilderGetQueryParameters{
IncludeHiddenFolders: &requestIncludeHiddenFolders,
}
configuration := &graphusers.MailFoldersItemChildFoldersRequestBuilderGetRequestConfiguration{
QueryParameters: requestParameters,
}
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
childFolders, err := graphClient.Me().MailFolders().ByMailFolderId("mailFolder-id").ChildFolders().Get(context.Background(), configuration)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
MailFolderCollectionResponse result = graphClient.me().mailFolders().byMailFolderId("{mailFolder-id}").childFolders().get(requestConfiguration -> {
requestConfiguration.queryParameters.includeHiddenFolders = "true";
});
const options = {
authProvider,
};
const client = Client.init(options);
let childFolders = await client.api('/me/mailFolders/AAMkAGVmMDEzM/childFolders?includeHiddenFolders=true')
.version('beta')
.get();
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Users\Item\MailFolders\Item\ChildFolders\ChildFoldersRequestBuilderGetRequestConfiguration;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestConfiguration = new ChildFoldersRequestBuilderGetRequestConfiguration();
$queryParameters = ChildFoldersRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->includeHiddenFolders = "true";
$requestConfiguration->queryParameters = $queryParameters;
$result = $graphServiceClient->me()->mailFolders()->byMailFolderId('mailFolder-id')->childFolders()->get($requestConfiguration)->wait();
Import-Module Microsoft.Graph.Beta.Mail
# A UPN can also be used as -UserId.
Get-MgBetaUserMailFolderChildFolder -UserId $userId -MailFolderId $mailFolderId -Includehiddenfolders true
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.users.item.mail_folders.item.child_folders.child_folders_request_builder import ChildFoldersRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
query_params = ChildFoldersRequestBuilder.ChildFoldersRequestBuilderGetQueryParameters(
include_hidden_folders = "true",
)
request_configuration = RequestConfiguration(
query_parameters = query_params,
)
result = await graph_client.me.mail_folders.by_mail_folder_id('mailFolder-id').child_folders.get(request_configuration = request_configuration)
响应
以下示例显示了相应的响应。
注意：为了提高可读性，可能缩短了此处显示的响应对象。
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
}
]
}