命名空间:microsoft.graph
重要
Microsoft Graph /beta
版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
更新 mailFolder 对象中所有邮件的读取状态。
此 API 可用于以下国家级云部署。
全局服务 |
美国政府 L4 |
美国政府 L5 (DOD) |
由世纪互联运营的中国 |
✅ |
❌ |
❌ |
❌ |
权限
为此 API 选择标记为最低特权的权限。
只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
权限类型 |
最低特权权限 |
更高特权权限 |
委派(工作或学校帐户) |
Mail.ReadWrite |
不可用。 |
委派(个人 Microsoft 帐户) |
Mail.ReadWrite |
不可用。 |
应用程序 |
Mail.ReadWrite |
不可用。 |
HTTP 请求
POST /me/mailFolders/{mailFolderId}/updateAllMessagesReadState
POST /users/{userId}/mailFolders/{mailFolderId}/updateAllMessagesReadState
名称 |
说明 |
Authorization |
持有者 {token}。 必填。 详细了解 身份验证和授权。 |
Content-Type |
application/json. 必需。 |
请求正文
在请求正文中,提供参数的 JSON 表示形式。
下表列出了调用此作时所需的参数。
参数 |
类型 |
说明 |
isRead |
Boolean |
指示是将邮件标记为已读还是未读。 |
suppressReadReceipts |
布尔值 |
指示是否取消接收端的邮件的已读回执。 |
响应
如果成功,此操作返回 204 No Content
响应代码。
示例
请求
以下示例显示了一个请求。
POST https://graph.microsoft.com/beta/me/mailFolders/AAMkAGVmMDEzM/updateAllMessagesReadState
Content-Type: application/json
{
"isRead": "true",
"suppressReadReceipts": "true"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Me.MailFolders.Item.UpdateAllMessagesReadState;
var requestBody = new UpdateAllMessagesReadStatePostRequestBody
{
IsRead = true,
SuppressReadReceipts = true,
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Me.MailFolders["{mailFolder-id}"].UpdateAllMessagesReadState.PostAsync(requestBody);
mgc-beta users mail-folders update-all-messages-read-state post --user-id {user-id} --mail-folder-id {mailFolder-id} --body '{\
"isRead": "true",\
"suppressReadReceipts": "true"\
}\
'
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphusers "github.com/microsoftgraph/msgraph-beta-sdk-go/users"
//other-imports
)
requestBody := graphusers.NewItemUpdateAllMessagesReadStatePostRequestBody()
isRead := true
requestBody.SetIsRead(&isRead)
suppressReadReceipts := true
requestBody.SetSuppressReadReceipts(&suppressReadReceipts)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Me().MailFolders().ByMailFolderId("mailFolder-id").UpdateAllMessagesReadState().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.users.item.mailfolders.item.updateallmessagesreadstate.UpdateAllMessagesReadStatePostRequestBody updateAllMessagesReadStatePostRequestBody = new com.microsoft.graph.beta.users.item.mailfolders.item.updateallmessagesreadstate.UpdateAllMessagesReadStatePostRequestBody();
updateAllMessagesReadStatePostRequestBody.setIsRead(true);
updateAllMessagesReadStatePostRequestBody.setSuppressReadReceipts(true);
graphClient.me().mailFolders().byMailFolderId("{mailFolder-id}").updateAllMessagesReadState().post(updateAllMessagesReadStatePostRequestBody);
const options = {
authProvider,
};
const client = Client.init(options);
const updateAllMessagesReadState = {
isRead: 'true',
suppressReadReceipts: 'true'
};
await client.api('/me/mailFolders/AAMkAGVmMDEzM/updateAllMessagesReadState')
.version('beta')
.post(updateAllMessagesReadState);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Users\Item\MailFolders\Item\UpdateAllMessagesReadState\UpdateAllMessagesReadStatePostRequestBody;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new UpdateAllMessagesReadStatePostRequestBody();
$requestBody->setIsRead(true);
$requestBody->setSuppressReadReceipts(true);
$graphServiceClient->me()->mailFolders()->byMailFolderId('mailFolder-id')->updateAllMessagesReadState()->post($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Mail
$params = @{
isRead = "true"
suppressReadReceipts = "true"
}
# A UPN can also be used as -UserId.
Update-MgBetaUserMailFolderMessageReadState -UserId $userId -MailFolderId $mailFolderId -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.users.item.mailfolders.item.update_all_messages_read_state.update_all_messages_read_state_post_request_body import UpdateAllMessagesReadStatePostRequestBody
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = UpdateAllMessagesReadStatePostRequestBody(
is_read = True,
suppress_read_receipts = True,
)
await graph_client.me.mail_folders.by_mail_folder_id('mailFolder-id').update_all_messages_read_state.post(request_body)
响应
以下示例显示了相应的响应。
HTTP/1.1 204 No Content