Method: users.messages.batchModify

修改指定郵件的標籤和分類標籤值。如果管理員要為機構中的使用者修改郵件，必須使用具有全網域委派授權的服務帳戶，透過 https://www.googleapis.com/auth/gmail.modify.restricted 範圍模擬使用者，才能提出要求。

HTTP 要求

POST https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/batchModify

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
userId

string

使用者的電子郵件地址。特殊值 me 可用於表示已驗證的使用者。

要求主體

要求主體會包含結構如下的資料：

JSON 表示法 
{
  "ids": [
    string
  ],
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "addClassificationLabels": [
    {
      object (ClassificationLabelValue)
    }
  ],
  "removeClassificationLabelIds": [
    string
  ]
}
欄位
ids[]

string

要修改的訊息 ID。每個要求最多只能有 1000 個 ID。
addLabelIds[]

string

要新增至郵件的標籤 ID 清單。
removeLabelIds[]

string

要從郵件中移除的標籤 ID 清單。
addClassificationLabels[]

object (ClassificationLabelValue)

要新增的分類標籤值清單。如果郵件已套用相同標籤 ID 的分類標籤，系統會更新現有欄位 ID 的欄位，並新增具有新欄位 ID 的欄位。每項要求最多只能有 20 個分類標籤值。如果郵件已分類，且最終的分類標籤值總數超過每封郵件允許的分類標籤值數量上限，修改就會失敗。
removeClassificationLabelIds[]

string

要從郵件中移除的分類標籤值清單。

回應主體

如果成功，回應主體會留白。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.modify.restricted

詳情請參閱授權指南。