Method: users.messages.batchDelete
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
根据消息 ID 删除多封邮件。无法保证消息尚未被删除,甚至无法保证消息是否存在。
HTTP 请求
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/batchDelete
网址采用 gRPC 转码语法。
路径参数
参数 |
userId |
string
用户的电子邮件地址。特殊值 me 可用于指示经过身份验证的用户。
|
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
{
"ids": [
string
]
} |
字段 |
ids[] |
string
要删除的消息的 ID。
|
授权范围
需要以下 OAuth 范围:
如需了解详情,请参阅授权指南。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-07-25。
[null,null,["最后更新时间 (UTC):2025-07-25。"],[],[],null,["# Method: users.messages.batchDelete\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nDeletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all.\n\n### HTTP request\n\n`POST https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/batchDelete`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-----------------------------------------------------------------------------------------------------------|\n| `userId` | `string` The user's email address. The special value `me` can be used to indicate the authenticated user. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------|\n| ``` { \"ids\": [ string ] } ``` |\n\n| Fields ||\n|---------|---------------------------------------------|\n| `ids[]` | `string` The IDs of the messages to delete. |\n\n### Response body\n\nIf successful, the response body is empty.\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://mail.google.com/`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]