Method: users.messages.modify
Изменяет метки указанного сообщения.
HTTP-запрос
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/{id}/modify
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры |
---|
userId | string Адрес электронной почты пользователя. Специальное значение me можно использовать для указания аутентифицированного пользователя. |
id | string Идентификатор сообщения, которое необходимо изменить. |
Тело запроса
Тело запроса содержит данные следующей структуры:
JSON-представление |
---|
{
"addLabelIds": [
string
],
"removeLabelIds": [
string
]
} |
Поля |
---|
addLabelIds[] | string Список идентификаторов ярлыков, которые можно добавить к этому сообщению. При каждом обновлении вы можете добавить до 100 ярлыков. |
removeLabelIds[] | string Список идентификаторов ярлыков, которые нужно удалить из этого сообщения. При каждом обновлении вы можете удалить до 100 ярлыков. |
Тело ответа
В случае успеха тело ответа содержит экземпляр Message
.
Области авторизации
Требуется одна из следующих областей OAuth:
-
https://mail.google.com/
-
https://www.googleapis.com/auth/gmail.modify
Дополнительную информацию см. в руководстве по авторизации .
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2024-11-14 UTC.
[null,null,["Последнее обновление: 2024-11-14 UTC."],[[["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"]]