列出 childFolder

命名空间:microsoft.graph

获取指定文件夹下的文件夹集合。 你可以使用 .../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/v1.0/me/mailFolders/AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYmY4OAAuAAAAAAAiQ8W967B7TKBjgx9rVEURAQAiIsqMbYjsT5e-T7KzowPTAAAAAAFNAAA=/childFolders
响应

以下示例显示了相应的响应。 注意:为了提高可读性,可能缩短了此处显示的响应对象。

HTTP/1.1 200 OK
Content-type: application/json

{
  "value": [
    {
      "id": "id-value",
      "displayName": "displayName-value",
      "parentFolderId": "parentFolderId-value",
      "childFolderCount": 99,
      "unreadItemCount": 99,
      "totalItemCount": 99,
      "isHidden": false
    }
  ]
}

示例 2:在指定的邮件文件夹中包含隐藏的子文件夹

下一个示例使用 includeHiddenFolders 查询参数获取特定邮件文件夹中的子文件夹列表(包括隐藏的邮件文件夹)。 答复包含isHidden 设置为 true 的“待筛选邮件”文件夹。

请求

以下示例显示了一个请求。

GET https://graph.microsoft.com/v1.0/me/mailFolders/AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYmY4OAAuAAAAAAAiQ8W967B7TKBjgx9rVEURAQAiIsqMbYjsT5e-T7KzowPTAAAAAAFNAAA=/childFolders?includeHiddenFolders=true
响应

以下示例显示了相应的响应。 注意:为了提高可读性,可能缩短了此处显示的响应对象。

HTTP/1.1 200 OK
Content-type: application/json

{
  "value": [
    {
      "id": "AAMkAGVmMDEzA",
      "displayName": "Internal Screens",
      "parentFolderId": "AAMkAGVmMDEzM",
      "childFolderCount": 0,
      "unreadItemCount": 2,
      "totalItemCount": 2,
      "isHidden": false
    },
    {
      "id": "AAMkAGVmMDEzB",
      "displayName": "Clutters",
      "parentFolderId": "AAMkAGVmMDEzM",
      "childFolderCount": 0,
      "unreadItemCount": 5,
      "totalItemCount": 5,
      "isHidden": true
    }
  ]
}