Gmail API

Mit der Gmail API können Sie Gmail-Postfachdaten wie Unterhaltungen, Nachrichten und Labels aufrufen und verwalten.

Dienst: gmail.googleapis.com

Wir empfehlen, diesen Dienst mit den von Google bereitgestellten Clientbibliotheken aufzurufen. Wenn Ihre Anwendung diesen Dienst mit Ihren eigenen Bibliotheken aufrufen muss, sollten Sie die folgenden Informationen verwenden, wenn Sie die API-Anfragen senden.

Discovery-Dokument

Ein Discovery-Dokument ist eine maschinenlesbare Spezifikation zum Beschreiben und Nutzen von REST APIs. Sie wird verwendet, um Clientbibliotheken, IDE-Plug-ins und andere Tools zu erstellen, die mit Google APIs interagieren. Ein Dienst kann mehrere Discovery-Dokumente haben. Dieser Dienst stellt folgendes Discovery-Dokument bereit:

Dienstendpunkt

Ein Dienstendpunkt ist eine Basis-URL, die die Netzwerkadresse eines API-Dienstes angibt. Ein Dienst kann mehrere Dienstendpunkte haben. Dieser Dienst hat den folgenden Dienstendpunkt und alle nachstehenden URIs beziehen sich auf ihn:

  • https://gmail.googleapis.com

REST-Ressource: v1.users

Methoden
getProfile GET /gmail/v1/users/{userId}/profile
Ruft das Gmail-Profil des aktuellen Nutzers ab.
stop POST /gmail/v1/users/{userId}/stop
Deaktiviert die Zustellung von Push-Benachrichtigungen für das angegebene Nutzerpostfach.
watch POST /gmail/v1/users/{userId}/watch
Richtet eine Push-Benachrichtigung für das angegebene Nutzerpostfach ein oder aktualisiert sie.

REST-Ressource: v1.users.drafts

Methoden
create POST /gmail/v1/users/{userId}/drafts
POST /upload/gmail/v1/users/{userId}/drafts
Erstellt einen Entwurf mit dem Label DRAFT.
delete DELETE /gmail/v1/users/{userId}/drafts/{id}
Löscht den angegebenen Entwurf sofort und endgültig.
get GET /gmail/v1/users/{userId}/drafts/{id}
Ruft den angegebenen Entwurf ab.
list GET /gmail/v1/users/{userId}/drafts
Führt die Entwürfe im Postfach des Nutzers auf.
send POST /gmail/v1/users/{userId}/drafts/send
POST /upload/gmail/v1/users/{userId}/drafts/send
Sendet den angegebenen, vorhandenen Entwurf an die Empfänger in den Headern To, Cc und Bcc.
update PUT /gmail/v1/users/{userId}/drafts/{id}
PUT /upload/gmail/v1/users/{userId}/drafts/{id}
Ersetzt den Inhalt eines Entwurfs.

REST-Ressource: v1.users.history

Methoden
list GET /gmail/v1/users/{userId}/history
Listet den Verlauf aller Änderungen an der angegebenen E-Mail-Adresse auf.

REST-Ressource: v1.users.labels

Methoden
create POST /gmail/v1/users/{userId}/labels
Erstellt ein Label.
delete DELETE /gmail/v1/users/{userId}/labels/{id}
Löscht das angegebene Label sofort und endgültig und entfernt es aus allen Nachrichten und Unterhaltungen, auf die es angewendet wurde.
get GET /gmail/v1/users/{userId}/labels/{id}
Ruft das angegebene Label ab.
list GET /gmail/v1/users/{userId}/labels
Listet alle Labels im Postfach des Nutzers auf.
patch PATCH /gmail/v1/users/{userId}/labels/{id}
Das angegebene Label patchen.
update PUT /gmail/v1/users/{userId}/labels/{id}
Aktualisiert das angegebene Label.

REST-Ressource: v1.users.messages

Methoden
batchDelete POST /gmail/v1/users/{userId}/messages/batchDelete
Löscht viele Nachrichten anhand der Nachrichten-ID.
batchModify POST /gmail/v1/users/{userId}/messages/batchModify
Ändert die Labels der angegebenen Nachrichten.
delete DELETE /gmail/v1/users/{userId}/messages/{id}
Löscht die angegebene Nachricht sofort und endgültig.
get GET /gmail/v1/users/{userId}/messages/{id}
Ruft die angegebene Nachricht ab.
import POST /gmail/v1/users/{userId}/messages/import
POST /upload/gmail/v1/users/{userId}/messages/import
Importiert eine Nachricht nur in das Postfach dieses Nutzers. Dabei werden die Nachrichten wie bei einem Empfang über SMTP gescannt und klassifiziert.
insert POST /gmail/v1/users/{userId}/messages
POST /upload/gmail/v1/users/{userId}/messages
Fügt eine Nachricht direkt in das Postfach dieses Nutzers ein, ähnlich wie IMAP APPEND. Dabei werden die meisten Scans und Klassifizierungen umgangen.
list GET /gmail/v1/users/{userId}/messages
Listet die Nachrichten im Postfach des Nutzers auf.
modify POST /gmail/v1/users/{userId}/messages/{id}/modify
Ändert die Labels der angegebenen Nachricht.
send POST /gmail/v1/users/{userId}/messages/send
POST /upload/gmail/v1/users/{userId}/messages/send
Sendet die angegebene Nachricht an die Empfänger in den Headern To, Cc und Bcc.
trash POST /gmail/v1/users/{userId}/messages/{id}/trash
Verschiebt die angegebene Nachricht in den Papierkorb.
untrash POST /gmail/v1/users/{userId}/messages/{id}/untrash
Entfernt die angegebene Nachricht aus dem Papierkorb.

REST-Ressource: v1.users.messages.attachments

Methoden
get GET /gmail/v1/users/{userId}/messages/{messageId}/attachments/{id}
Ruft den angegebenen Nachrichtenanhang ab.

REST-Ressource: v1.users.settings

Methoden
getAutoForwarding GET /gmail/v1/users/{userId}/settings/autoForwarding
Ruft die Einstellung für die automatische Weiterleitung für das angegebene Konto ab.
getImap GET /gmail/v1/users/{userId}/settings/imap
Ruft IMAP-Einstellungen ab.
getLanguage GET /gmail/v1/users/{userId}/settings/language
Ruft Spracheinstellungen ab.
getPop GET /gmail/v1/users/{userId}/settings/pop
Ruft POP-Einstellungen ab.
getVacation GET /gmail/v1/users/{userId}/settings/vacation
Ruft die Einstellungen für die automatische Abwesenheitsnotiz ab.
updateAutoForwarding PUT /gmail/v1/users/{userId}/settings/autoForwarding
Aktualisiert die Einstellung für die automatische Weiterleitung für das angegebene Konto.
updateImap PUT /gmail/v1/users/{userId}/settings/imap
Aktualisiert die IMAP-Einstellungen.
updateLanguage PUT /gmail/v1/users/{userId}/settings/language
Aktualisiert die Spracheinstellungen.
updatePop PUT /gmail/v1/users/{userId}/settings/pop
Aktualisiert die POP-Einstellungen.
updateVacation PUT /gmail/v1/users/{userId}/settings/vacation
Aktualisiert die Einstellungen für die automatische Abwesenheitsnotiz.

REST-Ressource: v1.users.settings.cse.identities

Methoden
create POST /gmail/v1/users/{userId}/settings/cse/identities
Erstellt und konfiguriert eine clientseitige Verschlüsselungsidentität, die berechtigt ist, E-Mails über das Nutzerkonto zu senden.
delete DELETE /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
Löscht eine Identität für die clientseitige Verschlüsselung.
get GET /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
Ruft eine Identitätskonfiguration für die clientseitige Verschlüsselung ab.
list GET /gmail/v1/users/{userId}/settings/cse/identities
Listet die clientseitig verschlüsselten Identitäten für einen authentifizierten Nutzer auf.
patch PATCH /gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}
Verknüpft ein anderes Schlüsselpaar mit einer vorhandenen Identität für die clientseitige Verschlüsselung.

REST-Ressource: v1.users.settings.cse.keypairs

Methoden
create POST /gmail/v1/users/{userId}/settings/cse/keypairs
Erstellt und lädt eine clientseitige Verschlüsselungs-S/MIME-Zertifikatskette für den öffentlichen Schlüssel und Metadaten des privaten Schlüssels für den authentifizierten Nutzer hoch.
disable POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable
Deaktiviert ein Schlüsselpaar für die clientseitige Verschlüsselung.
enable POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enable
Aktiviert ein deaktiviertes Schlüsselpaar für die clientseitige Verschlüsselung.
get GET /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}
Ruft ein vorhandenes Schlüsselpaar für die clientseitige Verschlüsselung ab.
list GET /gmail/v1/users/{userId}/settings/cse/keypairs
Listet Schlüsselpaare für die clientseitige Verschlüsselung für einen authentifizierten Nutzer auf.
obliterate POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate
Löscht ein Schlüsselpaar für die clientseitige Verschlüsselung dauerhaft und sofort.

REST-Ressource: v1.users.settings.delegates

Methoden
create POST /gmail/v1/users/{userId}/settings/delegates
Fügt einen Bevollmächtigten hinzu, dessen Bestätigungsstatus direkt auf accepted gesetzt wird, ohne dass eine Bestätigungs-E-Mail gesendet wird.
delete DELETE /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
Entfernt den angegebenen Bevollmächtigten (der einen beliebigen Bestätigungsstatus haben kann) und widerruft alle Bestätigungen, die für die Verwendung erforderlich waren.
get GET /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
Ruft den angegebenen Delegierten ab.
list GET /gmail/v1/users/{userId}/settings/delegates
Listet die Bevollmächtigten für das angegebene Konto auf.

REST-Ressource: v1.users.settings.filters

Methoden
create POST /gmail/v1/users/{userId}/settings/filters
Erstellt einen Filter.
delete DELETE /gmail/v1/users/{userId}/settings/filters/{id}
Löscht den angegebenen Filter sofort und endgültig.
get GET /gmail/v1/users/{userId}/settings/filters/{id}
Ruft einen Filter ab.
list GET /gmail/v1/users/{userId}/settings/filters
Listet die Nachrichtenfilter eines Gmail-Nutzers auf.

REST-Ressource: v1.users.settings.forwardingAddresses

Methoden
create POST /gmail/v1/users/{userId}/settings/forwardingAddresses
Erstellt eine Weiterleitungsadresse.
delete DELETE /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
Löscht die angegebene Weiterleitungsadresse und widerruft alle erforderlichen Bestätigungen.
get GET /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
Ruft die angegebene Weiterleitungsadresse ab.
list GET /gmail/v1/users/{userId}/settings/forwardingAddresses
Listet die Weiterleitungsadressen für das angegebene Konto auf.

REST-Ressource: v1.users.settings.sendAs

Methoden
create POST /gmail/v1/users/{userId}/settings/sendAs
Erstellt einen benutzerdefinierten „Von:“-Alias zum Senden von E-Mails.
delete DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Löscht den angegebenen Alias für „Senden als“.
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Ruft den angegebenen Alias „Senden als“ ab.
list GET /gmail/v1/users/{userId}/settings/sendAs
Listet die Aliasse für „Senden als“ für das angegebene Konto auf.
patch PATCH /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Aktualisiert den angegebenen Alias für „Senden als“.
update PUT /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Aktualisiert einen Alias für „Senden als“.
verify POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify
Sendet eine Bestätigungs-E-Mail an die angegebene Aliasadresse „Senden als“.

REST-Ressource: v1.users.settings.sendAs.smimeInfo

Methoden
delete DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
Löscht die angegebene S/MIME-Konfiguration für den angegebenen Alias „Senden als“.
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
Ruft die angegebene S/MIME-Konfiguration für den angegebenen „Senden als“-Alias ab.
insert POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
Fügen Sie die angegebene S/MIME-Konfiguration für den angegebenen „Senden als“-Alias ein (laden Sie sie hoch).
list GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
Listet S/MIME-Konfigurationen für den angegebenen Alias für das Senden als auf.
setDefault POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault
Legt die Standard-S/MIME-Konfiguration für den angegebenen „Senden als“-Alias fest.

REST-Ressource: v1.users.threads

Methoden
delete DELETE /gmail/v1/users/{userId}/threads/{id}
Löscht den angegebenen Thread sofort und endgültig.
get GET /gmail/v1/users/{userId}/threads/{id}
Ruft den angegebenen Thread ab.
list GET /gmail/v1/users/{userId}/threads
Führt die Threads im Postfach des Nutzers auf.
modify POST /gmail/v1/users/{userId}/threads/{id}/modify
Ändert die auf den Thread angewendeten Labels.
trash POST /gmail/v1/users/{userId}/threads/{id}/trash
Verschiebt den angegebenen Thread in den Papierkorb.
untrash POST /gmail/v1/users/{userId}/threads/{id}/untrash
Entfernt den angegebenen Thread aus dem Papierkorb.