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

Zalecamy wywołanie tej usługi przy użyciu dostarczonych przez Google bibliotek klienta. Jeśli aplikacja musi wywoływać tę usługę przy użyciu własnych bibliotek, podczas tworzenia żądań interfejsu API należy używać poniższych informacji.

Dokument opisujący

Dokument opisujący to czytelna dla komputera specyfikacja opisująca interfejsy API REST i sposób ich używania. 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 niego:

  • https://gmail.googleapis.com

Zasób REST: v1.users

Metody
getProfile GET /gmail/v1/users/{userId}/profile
Pobiera profil Gmaila bieżącego użytkownika.
stop POST /gmail/v1/users/{userId}/stop
Wyłącz dostarczanie powiadomień push do podanej skrzynki pocztowej użytkownika.
watch POST /gmail/v1/users/{userId}/watch
Skonfiguruj lub zaktualizuj zegarek z powiadomieniami push w skrzynce pocztowej danego użytkownika.

Zasób REST: v1.users.drafts

Metody
create POST /gmail/v1/users/{userId}/drafts
POST /upload/gmail/v1/users/{userId}/drafts
Tworzy wersję roboczą z etykietą DRAFT.
delete DELETE /gmail/v1/users/{userId}/drafts/{id}
Natychmiastowe i trwałe usunięcie określonej wersji roboczej.
get GET /gmail/v1/users/{userId}/drafts/{id}
Pobiera określoną wersję roboczą.
list GET /gmail/v1/users/{userId}/drafts
Wyświetla listę wersji roboczych 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 odbiorcó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 wprowadzonych w danej skrzynce pocztowej.

Zasób REST: v1.users.labels

Metody
create POST /gmail/v1/users/{userId}/labels
Tworzy etykietę.
delete DELETE /gmail/v1/users/{userId}/labels/{id}
Natychmiastowe i trwałe usunięcie określonej etykiety oraz usunięcie jej z 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 listę wszystkich etykiet w skrzynce pocztowej użytkownika.
patch PATCH /gmail/v1/users/{userId}/labels/{id}
Zastosuj poprawkę do określonej etykiety.
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 w określonych wiadomościach.
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śloną wiadomość.
import POST /gmail/v1/users/{userId}/messages/import
POST /upload/gmail/v1/users/{userId}/messages/import
Importuje wiadomość tylko do skrzynki pocztowej tego użytkownika, ze standardowym skanowaniem i klasyfikacją dostarczania e-maili podobną do odbierania przez SMTP.
insert POST /gmail/v1/users/{userId}/messages
POST /upload/gmail/v1/users/{userId}/messages
Wstawia wiadomość bezpośrednio do skrzynki pocztowej tylko tego użytkownika, podobnie jak 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 w 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 odbiorcó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 wiadomości.

Zasób REST: v1.users.settings

Metody
getAutoForwarding GET /gmail/v1/users/{userId}/settings/autoForwarding
Pobiera ustawienie automatycznego przekazywania dla 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
Pobiera 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 dla określonego konta.
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 ma uprawnienia 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}
Powiązuje 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 kluczy publicznych S/MIME szyfrowania po stronie klienta oraz metadane kluczy prywatnych 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 wyłączoną parę kluczy szyfrowania po stronie klienta.
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 delegata, którego stan weryfikacji jest ustawiony bezpośrednio na accepted, bez wysyłania e-maila weryfikacyjnego.
delete DELETE /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
Usuwa określonego delegata (który może mieć dowolny stan weryfikacji) i cofa wszelkie weryfikacje, które mogły być wymagane do korzystania z niego.
get GET /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
Pobiera określonego przedstawiciela.
list GET /gmail/v1/users/{userId}/settings/delegates
Wyświetla listę przedstawicieli określonego 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
Wyświetla 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 cofa wszelkie weryfikacje, które mogły być wymagane.
get GET /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
Pobiera określony adres do przekazywania dalej.
list GET /gmail/v1/users/{userId}/settings/forwardingAddresses
Wyświetla listę adresów przekazywania dla określonego konta.

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

Metody
create POST /gmail/v1/users/{userId}/settings/sendAs
Tworzy niestandardowy alias „od” do wysyłania e-maili.
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 listę aliasów „Wyślij jako” dla określonego konta.
patch PATCH /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Zastosuj poprawkę do określonego aliasu „Wyślij 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 adres aliasu „Wyślij jako”.

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 wysyłania jako.
insert POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
Wstaw (prześlij) podaną konfigurację S/MIME dla określonego aliasu „Wyślij jako”.
list GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
Wyświetla konfiguracje 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.