创建 MailFolder

命名空间:microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

使用此 API 在用户邮箱的根文件夹中新建邮件文件夹。

如果想要隐藏新文件夹,则必须在创建时将 isHidden 属性设置为 true

此 API 可用于以下国家级云部署

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国

权限

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

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

HTTP 请求

POST /me/mailFolders
POST /users/{id | userPrincipalName}/mailFolders

请求标头

标头
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权
Content-Type application/json

请求正文

在请求正文中,提供具有以下参数的 JSON 对象。 displayNameisHiddenmailFolder 对象的唯一可写属性。

参数 类型 说明
displayName String 新文件夹的显示名称。
IsHidden 布尔值 指示是否隐藏新文件夹。 默认值为 false。 设置 属性是可选的。 设置后,无法更新此属性。 有关详细信息,请参阅 隐藏邮件文件夹

响应

如果成功,此方法在 201 Created 响应正文中返回响应代码和 mailFolder 对象。

示例

请求

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

POST https://graph.microsoft.com/beta/me/mailFolders
Content-type: application/json

{
  "displayName": "Clutter",
  "isHidden": true
}

响应

以下示例显示了相应的响应。

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

HTTP/1.1 201 Created
Content-type: application/json

{
  "id": "hN2Y5OGRhNGYwODEALgAAA0DAKbvJvFhJgcT3lZpkhNQBAA1",
  "displayName": "Clutter",
  "parentFolderId": "AQMkADlmOGQwZmU3LWVjOWMtNDhiYgAtODcxNy1",
  "childFolderCount": 99,
  "unreadItemCount": 99,
  "totalItemCount": 99,
  "wellKnownName": null,
  "isHidden": true
}