Method: users.messages.modify
HTTP 请求
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/{id}/modify
网址采用 gRPC 转码语法。
路径参数
参数 |
userId |
string
用户的电子邮件地址。特殊值 me 可用于指示通过身份验证的用户。
|
id |
string
要修改的消息的 ID。
|
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
{
"addLabelIds": [
string
],
"removeLabelIds": [
string
]
} |
字段 |
addLabelIds[] |
string
要添加到此消息中的标签的 ID 列表。每次更新时,您最多可以添加 100 个标签。
|
removeLabelIds[] |
string
要从此消息中移除的标签的列表 ID。每次更新时,您最多可以移除 100 个标签。
|
响应正文
如果成功,则响应正文包含一个 Message
实例。
授权范围
需要以下 OAuth 范围之一:
https://mail.google.com/
https://www.googleapis.com/auth/gmail.modify
有关详情,请参阅授权指南。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2024-09-05。
[null,null,["最后更新时间 (UTC):2024-09-05。"],[[["This endpoint modifies labels on a specific message by adding or removing label IDs."],["The request requires the user's email address (`userId`), the message ID (`id`), and a JSON body specifying label IDs to add or remove."],["A successful response returns the updated message details."],["Authorization is required using specific OAuth scopes, such as `https://mail.google.com/` or `https://www.googleapis.com/auth/gmail.modify`."],["Users can leverage this functionality to programmatically manage email labels within their Gmail accounts."]]],["This API modifies labels on a specified Gmail message. It uses a `POST` request to the provided URL, with `userId` and `id` as path parameters, representing the user's email and the message's ID. The request body, in JSON format, includes `addLabelIds` and `removeLabelIds` arrays of label IDs, allowing up to 100 labels per array to be added or removed. Successful requests return a Message instance and require OAuth scopes `https://mail.google.com/` or `https://www.googleapis.com/auth/gmail.modify`.\n"]]