Method: users.drafts.list

Listet die Entwürfe im Postfach des Nutzers auf.

HTTP-Anfrage

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

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 Entwürfe, die zurückgegeben werden sollen. 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 Entwürfe zurück, 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".

includeSpamTrash

boolean

Entwürfe von SPAM und TRASH in die Ergebnisse einschließen.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

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

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

object (Draft)

Liste der Entwürfe. Das Attribut Message in jeder Draft-Ressource enthält nur einen id und einen threadId. Mit der Methode messages.get können zusätzliche Nachrichtendetails 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.compose
  • https://www.googleapis.com/auth/gmail.readonly

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.