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
詳情請參閱授權指南。
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2025-07-25 (世界標準時間)。
[null,null,["上次更新時間:2025-07-25 (世界標準時間)。"],[],[],null,["# Method: users.messages.modify\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\nModifies the labels on the specified message.\n\n### HTTP request\n\n`POST https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/{id}/modify`\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| `id` | `string` The ID of the message to modify. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------|\n| ``` { \"addLabelIds\": [ string ], \"removeLabelIds\": [ string ] } ``` |\n\n| Fields ||\n|--------------------|--------------------------------------------------------------------------------------------------------------|\n| `addLabelIds[]` | `string` A list of IDs of labels to add to this message. You can add up to 100 labels with each update. |\n| `removeLabelIds[]` | `string` A list IDs of labels to remove from this message. You can remove up to 100 labels with each update. |\n\n### Response body\n\nIf successful, the response body contains an instance of [Message](/workspace/gmail/api/reference/rest/v1/users.messages#Message).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://mail.google.com/`\n- `\n https://www.googleapis.com/auth/gmail.modify`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]