Method: users.messages.list

Liste les messages dans la boîte aux lettres de l'utilisateur. Pour obtenir des exemples d'utilisation, consultez Lister les messages Gmail.

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 spécifique de résultats dans la liste.
q

string

N'affiche que les messages correspondant à la requête spécifiée. Il 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". Ce paramètre ne peut pas être utilisé pour accéder à l'API avec le champ d'application gmail.metadata.
labelIds[]

string

N'affiche que les messages dont les libellés correspondent à tous les ID de libellé spécifiés. Il est possible que certains messages d'un même fil de discussion soient associés à des libellés, contrairement à d'autres. 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 détails sur le message à 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)

Nombre total de résultats estimés.

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.