Method: users.threads.list

Listet die Threads im Postfach des Nutzers auf.

HTTP-Anfrage

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

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 Threads. 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 Threads zurück, die der angegebenen Abfrage entsprechen. Unterstützt dasselbe Anfrageformat 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

Nur Threads mit Labels zurückgeben, die mit allen angegebenen Label-IDs übereinstimmen.
includeSpamTrash

boolean

Threads 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 
{
  "threads": [
    {
      object (Thread)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
Felder
threads[]

object (Thread)

Liste der Threads. Beachten Sie, dass keine Thread-Ressource eine Liste von messages enthält. Die messages-Liste für einen bestimmten Thread kann mit der Methode threads.get abgerufen werden.
nextPageToken

string

Seitentoken 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.