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 範圍:
詳情請參閱授權指南。
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2025-07-25 (世界標準時間)。
[null,null,["上次更新時間: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)."]]