Method: users.drafts.list

Affiche la liste des brouillons dans la boîte aux lettres de l'utilisateur. Pour en savoir plus, consultez Créer et envoyer des brouillons d'e-mails.

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

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

string

Ne renvoie que les brouillons de messages correspondant à la requête spécifiée. Prend en charge le même format de requête que la zone de recherche Gmail. Par exemple : "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread".
includeSpamTrash

boolean

Inclut les brouillons de SPAM et de 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 des brouillons. Notez que la propriété Message de chaque ressource Draft ne contient qu'un id et un threadId. La méthode messages.get peut récupérer des informations supplémentaires sur le message.
nextPageToken

string

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

integer (uint32 format)

Nombre total de résultats estimés.

Niveaux d'accès 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 sur l'autorisation.