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

如需了解详情，请参阅授权指南。