Method: users.drafts.list

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

Abfrageparameter

Parameter
maxResults

integer (uint32 format)

Die maximale Anzahl der zurückzugebenden Entwürfe. 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 als Entwurf 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".

includeSpamTrash

boolean

Entwürfe aus SPAM und TRASH in die Ergebnisse einbeziehen

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. Beachten Sie, dass die Property Message in jeder Draft-Ressource nur eine id und eine threadId enthält. Mit der Methode messages.get können zusätzliche Nachrichtendetails abgerufen werden.

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.compose
  • https://www.googleapis.com/auth/gmail.readonly

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.