Method: users.threads.list

Führt 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 Wert me kann der authentifizierte Nutzer angegeben werden.

Abfrageparameter

Parameter
maxResults

integer (uint32 format)

Maximale Anzahl von Threads, die zurückgegeben werden sollen. Der Standardwert in diesem Feld ist 100. Der maximal zulässige Wert für dieses Feld beträgt 500.
pageToken

string

Seitentoken zum Abrufen einer bestimmten Seite mit Ergebnissen in der Liste.
q

string

Es werden nur Threads zurückgegeben, die mit der angegebenen Abfrage übereinstimmen. Unterstützt dasselbe Format wie das Gmail-Suchfeld. Beispiel: "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread". Der Parameter kann beim Zugriff auf die API mit dem Bereich „gmail.metadata“ nicht verwendet werden.
labelIds[]

string

Es werden nur Threads mit Labels zurückgegeben, die mit allen angegebenen Label-IDs übereinstimmen.
includeSpamTrash

boolean

Unterhaltungen aus 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 jede Thread-Ressource keine 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.