Gmail API

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

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

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

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

Discovery Document — это машиночитаемая спецификация для описания и использования 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
Удаляет указанный поток из корзины.