Gmail API

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

Dienst: gmail.googleapis.com

Zum Aufrufen dieses Dienstes empfehlen wir die Verwendung der von Google bereitgestellten Clientbibliotheken. Wenn Ihre Anwendung zum Aufrufen dieses Dienstes Ihre eigenen Bibliotheken benötigt, verwenden Sie die folgenden Informationen, wenn Sie die API-Anfragen stellen.

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. Der Dienst bietet das folgende Discovery-Dokument:

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
Sie erhalten keine Push-Benachrichtigungen für das Postfach des Nutzers mehr.
watch POST /gmail/v1/users/{userId}/watch
Richten Sie eine Push-Benachrichtigungsuhr für das jeweilige Postfach ein oder aktualisieren Sie sie.

REST-Ressource: v1.users.drafts

Methoden
create POST /gmail/v1/users/{userId}/drafts
POST /upload/gmail/v1/users/{userId}/drafts
Erstellt einen neuen Entwurf mit dem Label DRAFT.
delete DELETE /gmail/v1/users/{userId}/drafts/{id}
Der angegebene Entwurf wird sofort und endgültig gelöscht.
get GET /gmail/v1/users/{userId}/drafts/{id}
Ruft den angegebenen Entwurf ab.
list GET /gmail/v1/users/{userId}/drafts
Listet 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 am angegebenen Postfach auf.

REST-Ressource: v1.users.labels

Methoden
create POST /gmail/v1/users/{userId}/labels
Erstellt ein neues Label.
delete DELETE /gmail/v1/users/{userId}/labels/{id}
Das angegebene Label wird sofort und endgültig gelöscht und aus allen Nachrichten und Threads entfernt, 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}
Patchen Sie das angegebene Label.
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}
Die angegebene Nachricht wird sofort und endgültig gelöscht.
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 den Posteingang dieses Nutzers. Die E-Mail-Zustellung wird dann wie beim SMTP-Standard gescannt und klassifiziert.
insert POST /gmail/v1/users/{userId}/messages
POST /upload/gmail/v1/users/{userId}/messages
Fügt eine Nachricht nur in das Postfach dieses Nutzers ein, ähnlich wie IMAP APPEND, wodurch die meisten Scans und Klassifizierungen umgangen werden.
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 die IMAP-Einstellungen ab.
getLanguage GET /gmail/v1/users/{userId}/settings/language
Ruft die Spracheinstellungen ab.
getPop GET /gmail/v1/users/{userId}/settings/pop
Ruft die POP-Einstellungen ab.
getVacation GET /gmail/v1/users/{userId}/settings/vacation
Ruft die Einstellungen für die 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 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 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 zum Senden von E-Mails über das Nutzerkonto berechtigt ist.
delete DELETE /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
Löscht eine clientseitige Verschlüsselungsidentität.
get GET /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
Ruft eine clientseitige Identitätskonfiguration für die Verschlüsselung ab.
list GET /gmail/v1/users/{userId}/settings/cse/identities
Listet die clientseitigen 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 clientseitigen Verschlüsselungsidentität.

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

Methoden
create POST /gmail/v1/users/{userId}/settings/cse/keypairs
Erstellt und lädt für den authentifizierten Nutzer eine clientseitige Verschlüsselung des S/MIME-Verschlüsselungsschlüssels und private Schlüsselmetadaten hoch und lädt sie hoch.
disable POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable
Deaktiviert ein clientseitiges Verschlüsselungsschlüsselpaar.
enable POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enable
Aktiviert ein deaktiviertes clientseitiges Schlüsselpaar.
get GET /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}
Ruft ein vorhandenes clientseitiges Verschlüsselungsschlüsselpaar ab.
list GET /gmail/v1/users/{userId}/settings/cse/keypairs
Listet clientseitige Schlüsselpaare für einen authentifizierten Nutzer auf.
obliterate POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate
Löscht ein clientseitiges Verschlüsselungsschlüsselpaar 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 festgelegt ist, ohne dass eine Bestätigungs-E-Mail gesendet wird.
delete DELETE /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
Entfernt den angegebenen Bevollmächtigten (kann einen beliebigen Überprüfungsstatus haben) und widerrufen alle Bestätigungen, die möglicherweise für die Verwendung erforderlich waren.
get GET /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
Ruft den angegebenen Bevollmächtigten 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}
Der angegebene Filter wird sofort und endgültig gelöscht.
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.forwardingAddresss

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 widerrufen 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 ein benutzerdefiniertes „Von“-Alias.
delete DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Löscht den angegebenen Sendealias.
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Ruft den angegebenen Alias für Senden als ab.
list GET /gmail/v1/users/{userId}/settings/sendAs
Listet die „Senden als“-Aliasse für das angegebene Konto auf.
patch PATCH /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Patchen Sie den angegebenen Sendealias.
update PUT /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Aktualisiert einen „Senden als“-Alias.
verify POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify
Sendet eine Bestätigungs-E-Mail an die angegebene Alias-Adresse.

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 „Senden als“-Alias.
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
Ruft die angegebene S/MIME-Konfiguration für den angegebenen Sende-Alias ab.
insert POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
Fügen Sie die angegebene S/MIME-Konfiguration für den angegebenen Alias als „Senden als“ ein.
list GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
Listet S/MIME-Konfigurationen für den angegebenen Alias als „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}
Der angegebene Thread wird sofort und endgültig gelöscht.
get GET /gmail/v1/users/{userId}/threads/{id}
Ruft den angegebenen Thread ab.
list GET /gmail/v1/users/{userId}/threads
Listet die Threads im Postfach des Nutzers auf.
modify POST /gmail/v1/users/{userId}/threads/{id}/modify
Ändert die Labels, die auf den Thread angewendet werden.
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.