Gmail API

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

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

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

Документ открытия

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

Конечная точка службы

Конечная точка службы — это базовый 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
Создает пользовательский псевдоним «Отправить как».
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
Удаляет указанную тему из корзины.