列出 childFolder

命名空间:microsoft.graph

获取指定文件夹下的文件夹集合。你可以使用 .../me/mailFolders 快捷方式获取顶级文件夹集合并导航到其他文件夹。

默认情况下,此操作不会返回隐藏文件夹。 使用查询参数 includeHiddenFolders,将它们包括在答复中。

权限

要调用此 API,需要以下权限之一。要了解详细信息,包括如何选择权限的信息,请参阅权限

权限类型 权限(从最低特权到最高特权)
委派(工作或学校帐户) Mail.ReadBasic、Mail.Read、Mail.ReadWrite
委派(个人 Microsoft 帐户) Mail.ReadBasic、Mail.Read、Mail.ReadWrite
应用程序 Mail.ReadBasic.All、Mail.Read、Mail.ReadWrite

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 Bearer {token}。必需。

请求正文

请勿提供此方法的请求正文。

响应

如果成功,此方法在响应正文中返回 200 OK 响应代码和 mailFolder 对象集合。

示例

示例 1:列出邮件文件夹

下面展示了示例请求。

请求

下面是一个请求示例。

GET https://graph.microsoft.com/v1.0/me/mailFolders/{id}/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/{id}/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
    }
  ]
}