Пространство имен: microsoft.graph
Важно!
API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Обновление состояния чтения всех сообщений в объекте mailFolder .
Этот API доступен в следующих национальных облачных развертываниях.
| Глобальное обслуживание |
Правительство США L4 |
Правительство США L5 (DOD) |
Китай, обслуживаемый 21Vianet |
| ✅ |
❌ |
❌ |
❌ |
Разрешения
Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более высокий уровень привилегий или разрешений, только если это требуется вашему приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в статье Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.
| Тип разрешения |
Разрешения с наименьшим объемом привилегий |
Разрешения с более высоким уровнем привилегий |
| Делегированные (рабочая или учебная учетная запись) |
Mail.ReadWrite |
Недоступно. |
| Делегированные (личная учетная запись Майкрософт) |
Mail.ReadWrite |
Недоступно. |
| Для приложений |
Mail.ReadWrite |
Недоступно. |
HTTP-запрос
POST /me/mailFolders/{mailFolderId}/updateAllMessagesReadState
POST /users/{userId}/mailFolders/{mailFolderId}/updateAllMessagesReadState
| Имя |
Описание |
| Авторизация |
Bearer {token}. Обязательно. Дополнительные сведения об аутентификации и авторизации. |
| Content-Type |
application/json. Обязательно. |
Текст запроса
В тексте запроса укажите JSON-представление параметров.
В следующей таблице перечислены параметры, которые необходимы при вызове этого действия.
| Параметр |
Тип |
Описание |
| isRead |
Boolean |
Указывает, следует ли помечать сообщения как прочитанные или непрочтенные. |
| suppressReadReceipts |
Логический |
Указывает, следует ли отключить уведомления о прочтении для сообщений от получателя. |
Отклик
В случае успешного выполнения это действие возвращает код отклика 202 Accepted. Отклик содержит Location заголовок, в котором указывается расположение mailFolderOperation , созданного для обработки состояния обновления сообщений и состояния чтения. Проверьте состояние операции обновления, создав запрос GET по этому адресу.
Примеры
Запрос
В следующем примере сообщения в папке почты помечаются как прочитанные.
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);
// 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 202 Accepted
Location: https://graph.microsoft.com/beta/users('95de90d3-2e59-4c87-9303-8cbc24ec3985')/mailFolders('AAMkAGRkZTFiMD')/operations('5667fd27-dc59-4e78-9ad2-857dbb437841')