命名空间:microsoft.graph
使用此 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 对象。
displayName 和 isHidden 是 mailFolder 对象的唯一可写属性。
参数 |
类型 |
说明 |
displayName |
String |
新文件夹的显示名称。 |
IsHidden |
布尔值 |
指示是否隐藏新文件夹。 默认值为 false 。 设置 属性是可选的。 设置后,无法更新此属性。 有关详细信息,请参阅 隐藏邮件文件夹 |
响应
如果成功,此方法在 201 Created
响应正文中返回响应代码和 mailFolder 对象。
示例
请求
以下示例显示了一个请求。
POST https://graph.microsoft.com/v1.0/me/mailFolders
Content-type: application/json
{
"displayName": "Clutter",
"isHidden": true
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models;
var requestBody = new MailFolder
{
DisplayName = "Clutter",
IsHidden = true,
};
// 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.PostAsync(requestBody);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
mgc users mail-folders create --user-id {user-id} --body '{\
"displayName": "Clutter",\
"isHidden": true\
}\
'
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewMailFolder()
displayName := "Clutter"
requestBody.SetDisplayName(&displayName)
isHidden := true
requestBody.SetIsHidden(&isHidden)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
mailFolders, err := graphClient.Me().MailFolders().Post(context.Background(), requestBody, nil)
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
MailFolder mailFolder = new MailFolder();
mailFolder.setDisplayName("Clutter");
mailFolder.setIsHidden(true);
MailFolder result = graphClient.me().mailFolders().post(mailFolder);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
const options = {
authProvider,
};
const client = Client.init(options);
const mailFolder = {
displayName: 'Clutter',
isHidden: true
};
await client.api('/me/mailFolders')
.post(mailFolder);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\MailFolder;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new MailFolder();
$requestBody->setDisplayName('Clutter');
$requestBody->setIsHidden(true);
$result = $graphServiceClient->me()->mailFolders()->post($requestBody)->wait();
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
Import-Module Microsoft.Graph.Mail
$params = @{
displayName = "Clutter"
isHidden = $true
}
# A UPN can also be used as -UserId.
New-MgUserMailFolder -UserId $userId -BodyParameter $params
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.mail_folder import MailFolder
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = MailFolder(
display_name = "Clutter",
is_hidden = True,
)
result = await graph_client.me.mail_folders.post(request_body)
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 201 Created
Content-type: application/json
{
"displayName": "Clutter",
"parentFolderId": "AQMkADlmOGQwZmU3LWVjOWMtNDhiYgAtODcxNy1",
"childFolderCount": 99,
"unreadItemCount": 99,
"totalItemCount": 99,
"id": "hN2Y5OGRhNGYwODEALgAAA0DAKbvJvFhJgcT3lZpkhNQBAA1",
"isHidden": true
}