Gmail API

Interfejs Gmail API umożliwia wyświetlanie danych skrzynki pocztowej Gmail i zarządzanie nimi, np. wątkami, wiadomościami i etykietami.

Usługa: gmail.googleapis.com

Do wywołania tej usługi zalecamy użycie 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
Zatrzymaj otrzymywanie powiadomień push w przypadku danej skrzynki pocztowej użytkownika.
watch POST /gmail/v1/users/{userId}/watch
Skonfiguruj lub zaktualizuj monitorowanie powiadomień 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 nowy projekt z etykietą DRAFT.
delete DELETE /gmail/v1/users/{userId}/drafts/{id}
Natychmiast i trwało usuwa wskazaną wersję roboczą.
get GET /gmail/v1/users/{userId}/drafts/{id}
Pobiera określoną wersję roboczą.
list GET /gmail/v1/users/{userId}/drafts
Wyświetla listę szkiców 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 zawartość wersji roboczej.

Zasób REST: v1.users.history

Metody
list GET /gmail/v1/users/{userId}/history
Wyświetla listę 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 na stałe 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 listę wszystkich etykiet w skrzynce pocztowej użytkownika.
patch PATCH /gmail/v1/users/{userId}/labels/{id}
Wprowadź poprawki w wybranej etykiecie.
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
Usuwanie wielu wiadomości według identyfikatora wiadomości.
batchModify POST /gmail/v1/users/{userId}/messages/batchModify
Zmienia etykiety wybranych wiadomości.
delete DELETE /gmail/v1/users/{userId}/messages/{id}
Natychmiast i trwało usuwa wybraną 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 odbiorczej tego użytkownika, ze standardowym skanowaniem i klasyfikacją dostarczania e-maili, podobnie jak w przypadku odbierania za pomocą SMTP.
insert POST /gmail/v1/users/{userId}/messages
POST /upload/gmail/v1/users/{userId}/messages
Wstawia wiadomość bezpośrednio do skrzynki pocztowej tego użytkownika, podobnie jak w przypadku IMAP APPEND, pomijając większość 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
Zmienia etykiety wybranej 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 wybraną wiadomość do kosza.
untrash POST /gmail/v1/users/{userId}/messages/{id}/untrash
Usuwanie określonej wiadomości z kosza.

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

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

Zasób REST: v1.users.settings

Metody
getAutoForwarding GET /gmail/v1/users/{userId}/settings/autoForwarding
Pobiera ustawienie automatycznego przekierowywania dla podanego 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
Zmienia ustawienie automatycznego przekierowywania na wskazanym koncie.
updateImap PUT /gmail/v1/users/{userId}/settings/imap
Aktualizuje ustawienia IMAP.
updateLanguage PUT /gmail/v1/users/{userId}/settings/language
Zmienia ustawienia języka.
updatePop PUT /gmail/v1/users/{userId}/settings/pop
Zmienia ustawienia POP.
updateVacation PUT /gmail/v1/users/{userId}/settings/vacation
Zmienia 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}
Usuwanie tożsamości 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 tożsamości zaszyfrowane po stronie klienta dla uwierzytelnionego użytkownika.
patch PATCH /gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}
Powiązanie innej pary 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 S/MIME kluczy publicznych i metadane kluczy prywatnych na potrzeby szyfrowania po stronie klienta 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 był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
Natychmiast i trwało usuwa parę kluczy szyfrowania po stronie klienta.

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

Metody
create POST /gmail/v1/users/{userId}/settings/delegates
Dodaje użytkownika z przypisanym stanem weryfikacji accepted, bez wysyłania e-maila weryfikacyjnego.
delete DELETE /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
Usuwanie określonego użytkownika (który może mieć dowolny stan weryfikacji) i odwoływanie wszelkich weryfikacji, które mogły być wymagane do jego korzystania.
get GET /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
Pobiera wskazanego przedstawiciela.
list GET /gmail/v1/users/{userId}/settings/delegates
Wyświetla listę przedstawicieli na określonym koncie.

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 trwało 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 przekierowania.
delete DELETE /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
Usuń wskazany adres przekierowujący i cofnij ewentualną weryfikację.
get GET /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
Pobiera podany adres do przekazywania dalej.
list GET /gmail/v1/users/{userId}/settings/forwardingAddresses
Wyświetla listę adresów przekierowania dla określonego konta.

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

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

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

Metody
delete DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
Usuwanie określonej konfiguracji S/MIME dla określonego aliasu send-as.
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
Pobiera określoną konfigurację S/MIME dla podanego aliasu wysyłania.
insert POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
Wstaw (prześlij) określoną konfigurację S/MIME dla określonego aliasu wysyłania.
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 podanego aliasu wysyłania.

Zasób REST: v1.users.threads

Metody
delete DELETE /gmail/v1/users/{userId}/threads/{id}
Natychmiast i trwało usuwa wskazany wątek.
get GET /gmail/v1/users/{userId}/threads/{id}
Pobiera podany wątek.
list GET /gmail/v1/users/{userId}/threads
Wyświetla wątki w skrzynce pocztowej użytkownika.
modify POST /gmail/v1/users/{userId}/threads/{id}/modify
Zmienia etykiety zastosowane do wątku.
trash POST /gmail/v1/users/{userId}/threads/{id}/trash
Przenosi wskazany wątek do kosza.
untrash POST /gmail/v1/users/{userId}/threads/{id}/untrash
Usuwanie wskazanego wątku z kosza.