Method: users.labels.list

Liste tous les libellés de la boîte aux lettres de l'utilisateur.

Requête HTTP

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

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é.

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
{
  "labels": [
    {
      object (Label)
    }
  ]
}
Champs
labels[]

object (Label)

Liste des libellés. Notez que chaque ressource de libellé ne contient que les éléments id, name, messageListVisibility, labelListVisibility et type. La méthode labels.get permet de récupérer des détails supplémentaires sur les libellé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.labels
  • https://www.googleapis.com/auth/gmail.metadata

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