Gmail API

API Gmail позволяет просматривать и управлять данными почтового ящика Gmail, такими как цепочки сообщений, сами сообщения и метки.

Сервис: gmail.googleapis.com

Для вызова этой службы мы рекомендуем использовать клиентские библиотеки, предоставляемые Google. Если вашему приложению необходимо использовать собственные библиотеки для вызова этой службы, используйте следующую информацию при отправке запросов к API.

Документ об обнаружении

Документ Discovery — это машиночитаемая спецификация для описания и использования REST API. Он используется для создания клиентских библиотек, плагинов для IDE и других инструментов, взаимодействующих с API Google. Один сервис может предоставлять несколько документов Discovery. Данный сервис предоставляет следующий документ Discovery:

конечная точка сервиса

Конечная точка сервиса — это базовый URL-адрес, указывающий сетевой адрес API-сервиса. Один сервис может иметь несколько конечных точек. Данный сервис имеет следующую конечную точку, и все приведенные ниже URI являются относительными к этой конечной точке:

  • https://gmail.googleapis.com

REST-ресурс: v1.users

Методы
getProfile GET /gmail/v1/users/{userId}/profile
Получает профиль Gmail текущего пользователя.
stop POST /gmail/v1/users/{userId}/stop
Отключите доставку push-уведомлений для почтового ящика указанного пользователя.
watch POST /gmail/v1/users/{userId}/watch
Настройте или обновите отслеживание push-уведомлений в почтовом ящике указанного пользователя.

REST-ресурс: v1.users.drafts

Методы
create POST /gmail/v1/users/{userId}/drafts
POST /upload/gmail/v1/users/{userId}/drafts
Создает черновик с меткой DRAFT .
delete DELETE /gmail/v1/users/{userId}/drafts/{id}
Немедленно и безвозвратно удаляет указанный черновик.
get GET /gmail/v1/users/{userId}/drafts/{id}
Получает указанный черновик.
list GET /gmail/v1/users/{userId}/drafts
Отображает список черновиков в почтовом ящике пользователя.
send POST /gmail/v1/users/{userId}/drafts/send
POST /upload/gmail/v1/users/{userId}/drafts/send
Отправляет указанный, существующий черновик получателям, указанным в заголовках To , Cc и Bcc .
update PUT /gmail/v1/users/{userId}/drafts/{id}
PUT /upload/gmail/v1/users/{userId}/drafts/{id}
Заменяет содержимое черновика.

REST-ресурс: v1.users.history

Методы
list GET /gmail/v1/users/{userId}/history
Отображает историю всех изменений, внесенных в данный почтовый ящик.

REST-ресурс: v1.users.labels

Методы
create POST /gmail/v1/users/{userId}/labels
Создаёт метку.
delete DELETE /gmail/v1/users/{userId}/labels/{id}
Немедленно и безвозвратно удаляет указанную метку и исключает её из всех сообщений и веток обсуждений, к которым она была применена.
get GET /gmail/v1/users/{userId}/labels/{id}
Получает указанную метку.
list GET /gmail/v1/users/{userId}/labels
Отображает список всех меток в почтовом ящике пользователя.
patch PATCH /gmail/v1/users/{userId}/labels/{id}
Прикрепите указанную метку.
update PUT /gmail/v1/users/{userId}/labels/{id}
Обновляет указанную метку.

REST-ресурс: v1.users.messages

Методы
batchDelete POST /gmail/v1/users/{userId}/messages/batchDelete
Удаляет множество сообщений по идентификатору сообщения.
batchModify POST /gmail/v1/users/{userId}/messages/batchModify
Изменяет метки в указанных сообщениях.
delete DELETE /gmail/v1/users/{userId}/messages/{id}
Немедленно и навсегда удаляет указанное сообщение.
get GET /gmail/v1/users/{userId}/messages/{id}
Получает указанное сообщение.
import POST /gmail/v1/users/{userId}/messages/import
POST /upload/gmail/v1/users/{userId}/messages/import
Импортирует сообщение только в почтовый ящик этого пользователя, выполняя стандартное сканирование и классификацию доставки электронной почты, аналогичное получению через SMTP.
insert POST /gmail/v1/users/{userId}/messages
POST /upload/gmail/v1/users/{userId}/messages
Эта команда напрямую вставляет сообщение только в почтовый ящик этого пользователя, аналогично IMAP APPEND , минуя большинство проверок и классификации.
list GET /gmail/v1/users/{userId}/messages
Отображает список сообщений в почтовом ящике пользователя.
modify POST /gmail/v1/users/{userId}/messages/{id}/modify
Изменяет надписи в указанном сообщении.
send POST /gmail/v1/users/{userId}/messages/send
POST /upload/gmail/v1/users/{userId}/messages/send
Отправляет указанное сообщение получателям, указанным в заголовках To , Cc и Bcc .
trash POST /gmail/v1/users/{userId}/messages/{id}/trash
Перемещает указанное сообщение в корзину.
untrash POST /gmail/v1/users/{userId}/messages/{id}/untrash
Удаляет указанное сообщение из корзины.

REST-ресурс: v1.users.messages.attachments

Методы
get GET /gmail/v1/users/{userId}/messages/{messageId}/attachments/{id}
Получает указанное вложение к сообщению.

REST-ресурс: v1.users.settings

Методы
getAutoForwarding GET /gmail/v1/users/{userId}/settings/autoForwarding
Получает настройки автоматической переадресации для указанной учетной записи.
getImap GET /gmail/v1/users/{userId}/settings/imap
Получает настройки IMAP.
getLanguage GET /gmail/v1/users/{userId}/settings/language
Получает языковые настройки.
getPop GET /gmail/v1/users/{userId}/settings/pop
Получает настройки POP.
getVacation GET /gmail/v1/users/{userId}/settings/vacation
Получает настройки автоматического ответа во время отпуска.
updateAutoForwarding PUT /gmail/v1/users/{userId}/settings/autoForwarding
Обновляет настройку автоматической пересылки для указанной учетной записи.
updateImap PUT /gmail/v1/users/{userId}/settings/imap
Обновляет настройки IMAP.
updateLanguage PUT /gmail/v1/users/{userId}/settings/language
Обновляет языковые настройки.
updatePop PUT /gmail/v1/users/{userId}/settings/pop
Обновляет настройки POP.
updateVacation PUT /gmail/v1/users/{userId}/settings/vacation
Обновляет настройки автоматического ответа во время отпуска.

REST-ресурс: v1.users.settings.cse.identities

Методы
create POST /gmail/v1/users/{userId}/settings/cse/identities
Создает и настраивает идентификатор шифрования на стороне клиента, которому разрешено отправлять почту с учетной записи пользователя.
delete DELETE /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
Удаляет идентификатор шифрования на стороне клиента.
get GET /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
Получает конфигурацию идентификации шифрования на стороне клиента.
list GET /gmail/v1/users/{userId}/settings/cse/identities
Отображает список зашифрованных на стороне клиента идентификаторов для аутентифицированного пользователя.
patch PATCH /gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}
Связывает другую пару ключей с существующим идентификатором шифрования на стороне клиента.

REST-ресурс: v1.users.settings.cse.keypairs

Методы
create POST /gmail/v1/users/{userId}/settings/cse/keypairs
Создает и загружает цепочку сертификатов открытого ключа S/MIME для шифрования на стороне клиента, а также метаданные закрытого ключа для аутентифицированного пользователя.
disable POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable
Отключает пару ключей шифрования на стороне клиента.
enable POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enable
Включает пару ключей шифрования на стороне клиента, которая ранее была отключена.
get GET /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}
Получает существующую пару ключей шифрования на стороне клиента.
list GET /gmail/v1/users/{userId}/settings/cse/keypairs
Отображает список пар ключей шифрования на стороне клиента для аутентифицированного пользователя.
obliterate POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate
Удаляет пару ключей шифрования на стороне клиента безвозвратно и немедленно.

REST-ресурс: v1.users.settings.delegates

Методы
create POST /gmail/v1/users/{userId}/settings/delegates
Добавляет делегата со статусом подтверждения непосредственно в поле accepted , без отправки подтверждающего электронного письма.
delete DELETE /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
Удаляет указанный делегат (который может иметь любой статус проверки) и отменяет любую проверку, которая могла потребоваться для его использования.
get GET /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
Получает указанного делегата.
list GET /gmail/v1/users/{userId}/settings/delegates
Отображает список делегатов для указанного аккаунта.

REST-ресурс: v1.users.settings.filters

Методы
create POST /gmail/v1/users/{userId}/settings/filters
Создает фильтр.
delete DELETE /gmail/v1/users/{userId}/settings/filters/{id}
Немедленно и навсегда удаляет указанный фильтр.
get GET /gmail/v1/users/{userId}/settings/filters/{id}
Получает фильтр.
list GET /gmail/v1/users/{userId}/settings/filters
Отображает список фильтров сообщений пользователя Gmail.

REST-ресурс: v1.users.settings.forwardingAddresses

Методы
create POST /gmail/v1/users/{userId}/settings/forwardingAddresses
Создает адрес переадресации.
delete DELETE /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
Удаляет указанный адрес переадресации и отменяет любую необходимую проверку.
get GET /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
Получает указанный адрес переадресации.
list GET /gmail/v1/users/{userId}/settings/forwardingAddresses
Отображает адреса переадресации для указанного аккаунта.

REST-ресурс: v1.users.settings.sendAs

Методы
create POST /gmail/v1/users/{userId}/settings/sendAs
Создает пользовательский псевдоним отправителя "from".
delete DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Удаляет указанный псевдоним для отправки.
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Получает указанный псевдоним для отправки.
list GET /gmail/v1/users/{userId}/settings/sendAs
Отображает список псевдонимов для отправки сообщений с указанного аккаунта.
patch PATCH /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Исправьте указанный псевдоним для отправки.
update PUT /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Обновляет псевдоним для отправки.
verify POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify
Отправляет письмо с подтверждением на указанный адрес электронной почты, используемый в качестве псевдонима для отправки.

REST-ресурс: v1.users.settings.sendAs.smimeInfo

Методы
delete DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
Удаляет указанную конфигурацию S/MIME для указанного псевдонима, под которым отправляется сообщение.
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
Получает указанную конфигурацию S/MIME для указанного псевдонима, под которым отправляется сообщение.
insert POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
Вставьте (загрузите) указанную конфигурацию S/MIME для указанного псевдонима, под которым отправляется сообщение.
list GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
Выводит список конфигураций S/MIME для указанного псевдонима, под которым отправляется сообщение.
setDefault POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault
Устанавливает конфигурацию S/MIME по умолчанию для указанного псевдонима, под которым отправляется сообщение.

REST-ресурс: v1.users.threads

Методы
delete DELETE /gmail/v1/users/{userId}/threads/{id}
Немедленно и навсегда удаляет указанную ветку обсуждения.
get GET /gmail/v1/users/{userId}/threads/{id}
Получает указанный поток.
list GET /gmail/v1/users/{userId}/threads
Отображает список веток обсуждений в почтовом ящике пользователя.
modify POST /gmail/v1/users/{userId}/threads/{id}/modify
Изменяет метки, применяемые к нити.
trash POST /gmail/v1/users/{userId}/threads/{id}/trash
Перемещает указанный поток в корзину.
untrash POST /gmail/v1/users/{userId}/threads/{id}/untrash
Удаляет указанную нить из корзины.