mailFolder: updateAllMessagesReadState

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

mailFolder オブジェクト内のすべてのメッセージの既読状態を更新します。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国

アクセス許可

この 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 ブール型 受信側からのメッセージの開封確認を抑制するかどうかを示します。

応答

成功した場合、このアクションは 202 Accepted 応答コードを返します。 応答には、メッセージの更新読み取り状態を処理するために作成された mailFolderOperation の場所を指定する Location ヘッダーが含まれています。 この場所に GET 要求を送信して、更新操作の状態を確認します。

要求

次の例では、メール フォルダー内のメッセージを既読としてマークします。

POST https://graph.microsoft.com/beta/me/mailFolders/AAMkAGVmMDEzM/updateAllMessagesReadState
Content-Type: application/json

{
  "isRead": true,
  "suppressReadReceipts": true
}

応答

次の例は応答を示しています。

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')