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. Der spezielle Wert me kann verwendet werden, um den authentifizierten Nutzer anzugeben.

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 beträgt 500.
pageToken

string

Seitentoken zum Abrufen einer bestimmten Ergebnisseite in der Liste.
q

string

Es werden nur Nachrichten zurückgegeben, die mit der angegebenen Abfrage übereinstimmen. Unterstützt dasselbe Abfrageformat wie das Gmail-Suchfeld. Beispiel: "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread". Der Parameter kann nicht verwendet werden, wenn der Zugriff auf die API über den Gültigkeitsbereich „gmail.metadata“ erfolgt.
labelIds[]

string

Es werden nur Nachrichten mit Labels zurückgegeben, die mit allen angegebenen Label-IDs übereinstimmen. Nachrichten in einem Thread können Labels haben, die andere Nachrichten im selben Thread nicht haben. Weitere Informationen finden Sie unter Labels für Nachrichten und Threads verwalten.
includeSpamTrash

boolean

Fügen Sie Nachrichten von SPAM und TRASH in die Ergebnisse ein.

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 eine id und eine threadId enthält. Mit der Methode messages.get können Sie zusätzliche Nachrichtendetails abrufen.
nextPageToken

string

Token zum Abrufen der nächsten Ergebnisseite 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.