命名空间:microsoft.graph
更新 mailSearchFolder 对象的可写属性。
此 API 可用于以下国家级云部署。
全局服务 |
美国政府 L4 |
美国政府 L5 (DOD) |
由世纪互联运营的中国 |
✅ |
✅ |
✅ |
✅ |
权限
要调用此 API,需要以下权限之一。 若要了解详细信息,包括如何选择权限的信息,请参阅权限。
权限类型 |
权限(从最低特权到最高特权) |
委派(工作或学校帐户) |
Mail.ReadWrite |
委派(个人 Microsoft 帐户) |
Mail.ReadWrite |
应用程序 |
Mail.ReadWrite |
HTTP 请求
PATCH /me/mailFolders/{id}
PATCH /users/{id | userPrincipalName}/mailFolders/{id}
标头 |
值 |
Authorization |
持有者 {token}。 必填。 详细了解 身份验证和授权。 |
Content-Type |
application/json. 必需。 |
请求正文
在请求正文中,提供应更新的相关字段的值。 请求正文中未包含的现有属性会保留其以前的值,或者根据对其他属性值的更改重新计算。 为了获得最佳性能,请勿加入尚未更改的现有值。
属性 |
类型 |
说明 |
displayName |
String |
mailFolder 的显示名称。 |
includeNestedFolders |
布尔值 |
应如何遍历邮箱文件夹层次结构。
true 表示应执行深度搜索,而 false 表示应改为执行浅表搜索。 |
sourceFolderIds |
字符串集合 |
应挖掘的邮箱文件夹。 |
filterQuery |
String |
用于筛选消息的 OData 查询。 |
响应
如果成功,此方法在 200 OK
响应正文中返回响应代码和更新的 mailFolder 对象。
示例
请求
下面是更新搜索文件夹的 filterQuery 属性的示例请求。
PATCH https://graph.microsoft.com/v1.0/me/mailFolders/AAMkAGVmMDEzM
Content-type: application/json
{
"@odata.type": "microsoft.graph.mailSearchFolder",
"filterQuery": "contains(subject, 'Analytics')"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models;
var requestBody = new MailSearchFolder
{
OdataType = "microsoft.graph.mailSearchFolder",
FilterQuery = "contains(subject, 'Analytics')",
};
// 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}"].PatchAsync(requestBody);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
mgc users mail-folders patch --user-id {user-id} --mail-folder-id {mailFolder-id} --body '{\
"@odata.type": "microsoft.graph.mailSearchFolder",\
"filterQuery": "contains(subject, 'Analytics')"\
}\
'
有关如何将 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()
filterQuery := "contains(subject, 'Analytics')"
requestBody.SetFilterQuery(&filterQuery)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
mailFolders, err := graphClient.Me().MailFolders().ByMailFolderId("mailFolder-id").Patch(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);
MailSearchFolder mailFolder = new MailSearchFolder();
mailFolder.setOdataType("microsoft.graph.mailSearchFolder");
mailFolder.setFilterQuery("contains(subject, 'Analytics')");
MailFolder result = graphClient.me().mailFolders().byMailFolderId("{mailFolder-id}").patch(mailFolder);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
const options = {
authProvider,
};
const client = Client.init(options);
const mailFolder = {
'@odata.type': 'microsoft.graph.mailSearchFolder',
filterQuery: 'contains(subject, \'Analytics\')'
};
await client.api('/me/mailFolders/AAMkAGVmMDEzM')
.update(mailFolder);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\MailSearchFolder;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new MailSearchFolder();
$requestBody->setOdataType('microsoft.graph.mailSearchFolder');
$requestBody->setFilterQuery('contains(subject, \'Analytics\')');
$result = $graphServiceClient->me()->mailFolders()->byMailFolderId('mailFolder-id')->patch($requestBody)->wait();
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
Import-Module Microsoft.Graph.Mail
$params = @{
"@odata.type" = "microsoft.graph.mailSearchFolder"
filterQuery = "contains(subject, 'Analytics')"
}
# A UPN can also be used as -UserId.
Update-MgUserMailFolder -UserId $userId -MailFolderId $mailFolderId -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_search_folder import MailSearchFolder
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = MailSearchFolder(
odata_type = "microsoft.graph.mailSearchFolder",
filter_query = "contains(subject, 'Analytics')",
)
result = await graph_client.me.mail_folders.by_mail_folder_id('mailFolder-id').patch(request_body)
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.type": "#microsoft.graph.mailSearchFolder",
"id": "AAMkAGVmMDEzMx",
"displayName": "Get MyAnalytics",
"parentFolderId": "AAMkAGVmMDEzMy",
"childFolderCount": 0,
"unreadItemCount": 0,
"totalItemCount": 0,
"isSupported": true,
"includeNestedFolders": true,
"sourceFolderIds": [
"AAMkAGVmMDEzMi"
],
"filterQuery": "contains(subject, 'Analytics')"
}