Method: users.drafts.list

Liste les brouillons dans la boîte aux lettres de l'utilisateur.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
userId

string

Adresse e-mail de l'utilisateur. La valeur spéciale me peut être utilisée pour indiquer l'utilisateur authentifié.

Paramètres de requête

Paramètres
maxResults

integer (uint32 format)

Nombre maximal de brouillons à renvoyer. La valeur par défaut de ce champ est 100. La valeur maximale autorisée pour ce champ est 500.
pageToken

string

Jeton de page permettant de récupérer une page spécifique de résultats dans la liste.
q

string

Ne renvoyer que les brouillons correspondant à la requête spécifiée. Ce paramètre est compatible avec le même format de requête que le champ de recherche Gmail. Par exemple, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread".
includeSpamTrash

boolean

Inclure les brouillons de SPAM et TRASH dans les résultats.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient des données présentant la structure suivante :

Représentation JSON 
{
  "drafts": [
    {
      object (Draft)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
Champs
drafts[]

object (Draft)

Liste de brouillons. Notez que la propriété Message de chaque ressource Draft ne contient qu'un élément id et un élément threadId. La méthode messages.get permet de récupérer des détails supplémentaires sur les messages.
nextPageToken

string

Jeton permettant de récupérer la page de résultats suivante dans la liste.
resultSizeEstimate

integer (uint32 format)

Estimation du nombre total de résultats.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • 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

Pour en savoir plus, consultez le guide relatif aux autorisations.