更新 mailSearchFolder

命名空间：microsoft.graph

更新 mailSearchFolder 对象的可写属性。

权限

调用此 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	Boolean	应如何遍历邮箱文件夹层次结构。 true 表示应执行深度搜索，而 false 表示应改为执行浅表搜索。
sourceFolderIds	字符串集合	应挖掘的邮箱文件夹。
filterQuery	String	用于筛选消息的 OData 查询。

响应

如果成功，此方法在 200 OK 响应正文中返回响应代码和更新的 mailFolder 对象。

示例

请求

下面是更新搜索文件夹的 filterQuery 属性的示例请求。

HTTP

PATCH https://graph.microsoft.com/v1.0/me/mailFolders/AAMkAGVmMDEzM
Content-type: application/json

{
  "@odata.type": "microsoft.graph.mailSearchFolder",
  "filterQuery": "contains(subject, 'Analytics')"
}

C#

var graphClient = new GraphServiceClient(requestAdapter);

var requestBody = new MailFolder
{
	OdataType = "microsoft.graph.mailSearchFolder",
	AdditionalData = new Dictionary<string, object>
	{
		{
			"filterQuery" , "contains(subject, 'Analytics')"
		},
	},
};
var result = await graphClient.Me.MailFolders["{mailFolder-id}"].PatchAsync(requestBody);

有关如何 将 SDK 添加到 项目并 创建 authProvider 实例的详细信息，请参阅 SDK 文档。

JavaScript

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 文档。

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

MailSearchFolder mailFolder = new MailSearchFolder();
mailFolder.filterQuery = "contains(subject, 'Analytics')";

graphClient.me().mailFolders("AAMkAGVmMDEzM")
	.buildRequest()
	.patch(mailFolder);

有关如何 将 SDK 添加到 项目并 创建 authProvider 实例的详细信息，请参阅 SDK 文档。

转到

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewMailFolder()
additionalData := map[string]interface{}{
	"filterQuery" : "contains(subject, 'Analytics')", 
}
requestBody.SetAdditionalData(additionalData)

result, err := graphClient.Me().MailFoldersById("mailFolder-id").Patch(context.Background(), requestBody, nil)

有关如何 将 SDK 添加到 项目并 创建 authProvider 实例的详细信息，请参阅 SDK 文档。

PowerShell

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 文档。

PHP

<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);

$requestBody = new MailFolder();
$requestBody->set@odatatype('microsoft.graph.mailSearchFolder');

$additionalData = [
'filterQuery' => 'contains(subject, \'Analytics\')', 
];
$requestBody->setAdditionalData($additionalData);




$requestResult = $graphServiceClient->me()->mailFoldersById('mailFolder-id')->patch($requestBody);

有关如何 将 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')"
}