Method: users.threads.list

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

Requête HTTP

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

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 threads à 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 renvoie que les threads 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". Impossible d'utiliser ce paramètre lorsque vous accédez à l'API avec le champ d'application "gmail.metadata".
labelIds[]

string

N'affiche que les threads dont les libellés correspondent à tous les ID de libellés spécifiés.
includeSpamTrash

boolean

Inclure les fils de discussion 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 
{
  "threads": [
    {
      object (Thread)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
Champs
threads[]

object (Thread)

Liste des fils de discussion. Notez que chaque ressource de thread ne contient pas de liste de messages. La liste des messages pour un thread donné peut être récupérée à l'aide de la méthode threads.get.
nextPageToken

string

Jeton de page 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.readonly
  • https://www.googleapis.com/auth/gmail.metadata

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