Method: users.threads.list

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

Abfrageparameter

Parameter
maxResults

integer (uint32 format)

Die maximale Anzahl der zurückzugebenden Threads. 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 Threads zurückgegeben, die mit der angegebenen Suchanfrage ü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 Threads mit Labels zurückgegeben, die mit allen angegebenen Label-IDs übereinstimmen.
includeSpamTrash

boolean

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

object (Thread)

Liste der Threads. Beachten Sie, dass nicht jede Threadressource eine Liste von messages enthält. Die Liste der messages 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.