Method: users.messages.list

Listet die Nachrichten im Postfach des Nutzers auf.

HTTP-Anfrage

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/messages

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
userId

string

Die E-Mail-Adresse des Nutzers. Mit dem speziellen Wert me kann der authentifizierte Nutzer angegeben werden.

Abfrageparameter

Parameter
maxResults

integer (uint32 format)

Maximale Anzahl der zurückzugebenden Nachrichten. Der Standardwert für dieses Feld ist 100. Der maximal zulässige Wert für dieses Feld ist 500.
pageToken

string

Seitentoken zum Abrufen einer bestimmten Ergebnisseite in der Liste.
q

string

Gibt nur Nachrichten zurück, die der angegebenen Abfrage entsprechen. Unterstützt dasselbe Abfrageformat wie das Gmail-Suchfeld. Beispiel: "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread". Der Parameter kann beim Zugriff auf die API über den Bereich „gmail.metadata“ nicht verwendet werden.
labelIds[]

string

Es werden nur Nachrichten mit Labels zurückgegeben, die mit allen angegebenen Label-IDs übereinstimmen. Nachrichten in einer Konversation haben möglicherweise Labels, die andere Nachrichten in derselben Konversation nicht haben. Weitere Informationen finden Sie im Hilfeartikel Labels in Nachrichten und Threads verwalten.
includeSpamTrash

boolean

Nachrichten von SPAM und TRASH in die Ergebnisse aufnehmen.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender Struktur:

JSON-Darstellung 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
Felder
messages[]

object (Message)

Liste der Nachrichten. Beachten Sie, dass jede Nachrichtenressource nur einen id und einen threadId enthält. Zusätzliche Nachrichtendetails können mit der Methode messages.get abgerufen werden.
nextPageToken

string

Token zum Abrufen der nächsten Seite mit Ergebnissen in der Liste.
resultSizeEstimate

integer (uint32 format)

Geschätzte Gesamtzahl der Ergebnisse.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.metadata

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.