Gmail API

Interfejs Gmail API umożliwia wyświetlanie danych skrzynki pocztowej Gmaila, takich jak wątki, wiadomości i etykiety, oraz zarządzanie nimi.

Usługa: gmail.googleapis.com

Aby wywołać tę usługę, zalecamy użycie dostarczonych przez Google bibliotek klienta. Jeśli do wywoływania tej usługi aplikacja musi używać własnych bibliotek, podczas tworzenia żądań do interfejsu API użyj podanych niżej informacji.

Dokument opisujący

Dokument opisujący to czytelna dla komputera specyfikacja opisująca interfejsy API REST i korzystanie z nich. Służy do tworzenia bibliotek klienta, wtyczek IDE i innych narzędzi, które współdziałają z interfejsami API Google. Jedna usługa może udostępniać wiele dokumentów opisujących. Ta usługa dostarcza następujący dokument opisujący interfejs API:

Punkt końcowy usługi

Punkt końcowy usługi to podstawowy adres URL, który określa adres sieciowy usługi interfejsu API. Jedna usługa może mieć wiele punktów końcowych. Ta usługa ma następujący punkt końcowy i wszystkie poniższe identyfikatory URI odnoszą się do tego punktu końcowego:

  • https://gmail.googleapis.com

Zasób REST: v1.users

Metody
getProfile GET /gmail/v1/users/{userId}/profile
Pobiera profil Gmail bieżącego użytkownika.
stop POST /gmail/v1/users/{userId}/stop
Wyłącz otrzymywanie powiadomień push o danej skrzynce pocztowej użytkownika.
watch POST /gmail/v1/users/{userId}/watch
Skonfiguruj lub zaktualizuj zegarek z powiadomieniami push w danej skrzynce pocztowej użytkownika.

Zasób REST: v1.users.drafts

Metody
create POST /gmail/v1/users/{userId}/drafts
POST /upload/gmail/v1/users/{userId}/drafts
Tworzy nową wersję roboczą z etykietą DRAFT.
delete DELETE /gmail/v1/users/{userId}/drafts/{id}
Natychmiast i trwale usuwa określoną wersję roboczą.
get GET /gmail/v1/users/{userId}/drafts/{id}
Pobiera określoną wersję roboczą.
list GET /gmail/v1/users/{userId}/drafts
Wyświetla wersje robocze w skrzynce pocztowej użytkownika.
send POST /gmail/v1/users/{userId}/drafts/send
POST /upload/gmail/v1/users/{userId}/drafts/send
Wysyła określoną, istniejącą wersję roboczą do adresatów w nagłówkach To, Cc i Bcc.
update PUT /gmail/v1/users/{userId}/drafts/{id}
PUT /upload/gmail/v1/users/{userId}/drafts/{id}
Zastępuje treść wersji roboczej.

Zasób REST: v1.users.history

Metody
list GET /gmail/v1/users/{userId}/history
Wyświetla historię wszystkich zmian w danej skrzynce pocztowej.

Zasób REST: v1.users.labels

Metody
create POST /gmail/v1/users/{userId}/labels
Tworzy nową etykietę.
delete DELETE /gmail/v1/users/{userId}/labels/{id}
Natychmiast i trwale usuwa określoną etykietę oraz usuwa ją ze wszystkich wiadomości i wątków, do których została zastosowana.
get GET /gmail/v1/users/{userId}/labels/{id}
Pobiera określoną etykietę.
list GET /gmail/v1/users/{userId}/labels
Wyświetla wszystkie etykiety w skrzynce pocztowej użytkownika.
patch PATCH /gmail/v1/users/{userId}/labels/{id}
Popraw podaną etykietę.
update PUT /gmail/v1/users/{userId}/labels/{id}
Aktualizuje określoną etykietę.

Zasób REST: v1.users.messages

Metody
batchDelete POST /gmail/v1/users/{userId}/messages/batchDelete
Usuwa wiele wiadomości według identyfikatora wiadomości.
batchModify POST /gmail/v1/users/{userId}/messages/batchModify
Modyfikuje etykiety określonych wiadomości.
delete DELETE /gmail/v1/users/{userId}/messages/{id}
Natychmiast i trwale usuwa określoną wiadomość.
get GET /gmail/v1/users/{userId}/messages/{id}
Pobiera określony komunikat.
import POST /gmail/v1/users/{userId}/messages/import
POST /upload/gmail/v1/users/{userId}/messages/import
Importuje wiadomość tylko do skrzynki pocztowej danego użytkownika przy użyciu standardowego skanowania dostarczania e-maili i klasyfikacji podobnych do odbierania przez SMTP.
insert POST /gmail/v1/users/{userId}/messages
POST /upload/gmail/v1/users/{userId}/messages
Powoduje bezpośrednie wstawienie wiadomości tylko do skrzynki pocztowej tego użytkownika (podobne do IMAP APPEND), z pominięciem większości skanowania i klasyfikacji.
list GET /gmail/v1/users/{userId}/messages
Wyświetla listę wiadomości w skrzynce pocztowej użytkownika.
modify POST /gmail/v1/users/{userId}/messages/{id}/modify
Modyfikuje etykiety określonej wiadomości.
send POST /gmail/v1/users/{userId}/messages/send
POST /upload/gmail/v1/users/{userId}/messages/send
Wysyła określoną wiadomość do adresatów w nagłówkach To, Cc i Bcc.
trash POST /gmail/v1/users/{userId}/messages/{id}/trash
Przenosi określoną wiadomość do kosza.
untrash POST /gmail/v1/users/{userId}/messages/{id}/untrash
Usuwa określoną wiadomość z kosza.

Zasób REST: v1.users.messages.attachments

Metody
get GET /gmail/v1/users/{userId}/messages/{messageId}/attachments/{id}
Pobiera określony załącznik do wiadomości.

Zasób REST: v1.users.settings

Metody
getAutoForwarding GET /gmail/v1/users/{userId}/settings/autoForwarding
Pobiera ustawienie automatycznego przekazywania dalej z określonego konta.
getImap GET /gmail/v1/users/{userId}/settings/imap
Pobiera ustawienia IMAP.
getLanguage GET /gmail/v1/users/{userId}/settings/language
Pobiera ustawienia języka.
getPop GET /gmail/v1/users/{userId}/settings/pop
Uzyskuje ustawienia POP.
getVacation GET /gmail/v1/users/{userId}/settings/vacation
Pobiera ustawienia wiadomości o nieobecności.
updateAutoForwarding PUT /gmail/v1/users/{userId}/settings/autoForwarding
Aktualizuje ustawienie automatycznego przekazywania dalej na wybranym koncie.
updateImap PUT /gmail/v1/users/{userId}/settings/imap
Aktualizuje ustawienia IMAP.
updateLanguage PUT /gmail/v1/users/{userId}/settings/language
Aktualizuje ustawienia języka.
updatePop PUT /gmail/v1/users/{userId}/settings/pop
Aktualizuje ustawienia POP.
updateVacation PUT /gmail/v1/users/{userId}/settings/vacation
Aktualizuje ustawienia wiadomości o nieobecności.

Zasób REST: v1.users.settings.cse.identities

Metody
create POST /gmail/v1/users/{userId}/settings/cse/identities
Tworzy i konfiguruje tożsamość szyfrowania po stronie klienta, która jest upoważniona do wysyłania poczty z konta użytkownika.
delete DELETE /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
Usuwa tożsamość szyfrowania po stronie klienta.
get GET /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
Pobiera konfigurację tożsamości szyfrowania po stronie klienta.
list GET /gmail/v1/users/{userId}/settings/cse/identities
Wyświetla listę tożsamości zaszyfrowanych po stronie klienta dla uwierzytelnionego użytkownika.
patch PATCH /gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}
Wiąże inną parę kluczy z istniejącą tożsamością szyfrowania po stronie klienta.

Zasób REST: v1.users.settings.cse.keypairs

Metody
create POST /gmail/v1/users/{userId}/settings/cse/keypairs
Tworzy i przesyła łańcuch certyfikatów publicznego klucza S/MIME szyfrowania po stronie klienta oraz metadane klucza prywatnego dla uwierzytelnionego użytkownika.
disable POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable
Wyłącza parę kluczy szyfrowania po stronie klienta.
enable POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enable
Włącza parę kluczy szyfrowania po stronie klienta, która została wyłączona.
get GET /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}
Pobiera istniejącą parę kluczy szyfrowania po stronie klienta.
list GET /gmail/v1/users/{userId}/settings/cse/keypairs
Wyświetla pary kluczy szyfrowania po stronie klienta dla uwierzytelnionego użytkownika.
obliterate POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate
Trwale i natychmiast usuwa parę kluczy szyfrowania po stronie klienta.

Zasób REST: v1.users.settings.delegates

Metody
create POST /gmail/v1/users/{userId}/settings/delegates
Dodaje przedstawiciela ze stanem weryfikacji ustawionym bezpośrednio na accepted bez wysyłania żadnego e-maila weryfikacyjnego.
delete DELETE /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
Usuwa określonego przedstawiciela (który może mieć dowolny stan weryfikacji) i cofa weryfikację, która była wymagana do korzystania z niego.
get GET /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
Pobiera określony delegata.
list GET /gmail/v1/users/{userId}/settings/delegates
Zawiera listę przedstawicieli danego konta.

Zasób REST: v1.users.settings.filters

Metody
create POST /gmail/v1/users/{userId}/settings/filters
Tworzy filtr.
delete DELETE /gmail/v1/users/{userId}/settings/filters/{id}
Natychmiast i trwale usuwa określony filtr.
get GET /gmail/v1/users/{userId}/settings/filters/{id}
Pobiera filtr.
list GET /gmail/v1/users/{userId}/settings/filters
Zawiera listę filtrów wiadomości użytkownika Gmaila.

Zasób REST: v1.users.settings.forwardingAddresses

Metody
create POST /gmail/v1/users/{userId}/settings/forwardingAddresses
Tworzy adres do przekazywania dalej.
delete DELETE /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
Usuwa określony adres do przekazywania dalej i anuluje wszelkie wymagane procesy weryfikacji.
get GET /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
Pobiera określony adres do przekazywania dalej.
list GET /gmail/v1/users/{userId}/settings/forwardingAddresses
Zawiera listę adresów do przekazywania dalej dla określonego konta.

Zasób REST: v1.users.settings.sendAs

Metody
create POST /gmail/v1/users/{userId}/settings/sendAs
Tworzy niestandardowy alias „Od” nadawcy.
delete DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Usuwa określony alias „wyślij jako”.
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Pobiera określony alias „wyślij jako”.
list GET /gmail/v1/users/{userId}/settings/sendAs
Wyświetla aliasy „wyślij jako” dla określonego konta.
patch PATCH /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Popraw podany alias wysyłania jako.
update PUT /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Aktualizuje alias „wyślij jako”.
verify POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify
Wysyła e-maila weryfikacyjnego na podany alias adresu.

Zasób REST: v1.users.settings.sendAs.smimeInfo

Metody
delete DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
Usuwa określoną konfigurację S/MIME dla określonego aliasu „wyślij jako”.
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
Pobiera określoną konfigurację S/MIME dla określonego aliasu „wyślij jako”.
insert POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
Wstawić (przesłać) podaną konfigurację S/MIME dla określonego aliasu „wyślij jako”.
list GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
Zawiera listę konfiguracji S/MIME dla określonego aliasu „wyślij jako”.
setDefault POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault
Ustawia domyślną konfigurację S/MIME dla określonego aliasu „wyślij jako”.

Zasób REST: v1.users.threads

Metody
delete DELETE /gmail/v1/users/{userId}/threads/{id}
Natychmiast i trwale usuwa określony wątek.
get GET /gmail/v1/users/{userId}/threads/{id}
Pobiera określony wątek.
list GET /gmail/v1/users/{userId}/threads
Wyświetla listę wątków w skrzynce pocztowej użytkownika.
modify POST /gmail/v1/users/{userId}/threads/{id}/modify
Modyfikuje etykiety zastosowane do wątku.
trash POST /gmail/v1/users/{userId}/threads/{id}/trash
Przenosi określony wątek do kosza.
untrash POST /gmail/v1/users/{userId}/threads/{id}/untrash
Usuwa określony wątek z kosza.