- Requête HTTP
- Paramètres de chemin d'accès
- Paramètres de requête
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- Essayer
Liste les messages dans 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 |
Adresse e-mail de l'utilisateur. La valeur spéciale |
Paramètres de requête
Paramètres | |
---|---|
maxResults |
Nombre maximal de messages à renvoyer. La valeur par défaut de ce champ est 100. La valeur maximale autorisée pour ce champ est 500. |
pageToken |
Jeton de page permettant de récupérer une page spécifique de résultats dans la liste. |
q |
Affiche uniquement les messages correspondant à la requête spécifiée. Prend en charge le même format de requête que le champ de recherche de Gmail. Par exemple, |
labelIds[] |
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 être associés à des libellés que les autres messages du même fil de discussion n'ont pas. Pour en savoir plus, consultez Gérer les libellés des messages et des fils de discussion. |
includeSpamTrash |
Inclure les messages de |
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 ( |
Champs | |
---|---|
messages[] |
Liste des messages. Notez que chaque ressource de message ne contient qu'un |
nextPageToken |
Jeton permettant de récupérer la page suivante des résultats dans la liste. |
resultSizeEstimate |
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.