Method: users.messages.list

Liste 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 à renvoyer. La valeur par défaut de ce champ est 100. La valeur maximale autorisée pour ce champ est de 500.
pageToken

string

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

string

Ne renvoie que les messages correspondant à la requête spécifiée. Compatible avec le même format de requête que le champ de recherche de Gmail. Par exemple, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread". Le paramètre ne peut pas être utilisé lorsque vous accédez à l'API à l'aide du champ d'application gmail.metadata.
labelIds[]

string

Renvoie uniquement les messages associés à des libellés correspondant à tous les ID de libellé spécifiés. Les messages d'un fil de discussion peuvent être associés à des libellés différents des autres messages du même fil. Pour en savoir plus, consultez Gérer les libellés sur les messages et les fils de discussion.
includeSpamTrash

boolean

Incluez 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 des messages. Notez que chaque ressource de message ne contient qu'un id et un threadId. Vous pouvez récupérer d'autres informations sur le message à l'aide de la méthode messages.get.
nextPageToken

string

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

integer (uint32 format)

Nombre total estimé 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 d'autorisation.