Method: users.messages.list

Répertorie les messages de la boîte aux lettres de l'utilisateur.

Requête HTTP :

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

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 messages à afficher. 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 pour récupérer une page spécifique de résultats dans la liste.
q

string

Affiche uniquement les messages correspondant à la requête spécifiée. Prise en charge du 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

Affiche uniquement les messages dont les libellés correspondent à tous les ID de libellé spécifiés. Les messages d'un fil de discussion peuvent avoir des libellés qui ne sont pas associés aux autres messages d'un même fil de discussion. Pour en savoir plus, consultez Gérer les libellés sur les messages et les fils de discussion.
includeSpamTrash

boolean

Inclure les messages 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 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
Champs
messages[]

object (Message)

Liste de messages. Notez que chaque ressource de message ne contient qu'un id et un threadId. Vous pouvez récupérer des informations supplémentaires sur les messages à l'aide de la méthode messages.get.
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.readonly
  • https://www.googleapis.com/auth/gmail.metadata

Pour en savoir plus, consultez le guide sur les autorisations.