Ressource: Libellé
Les libellés permettent de classer les messages et les fils de discussion dans la boîte aux lettres de l'utilisateur. La boîte aux lettres d'un utilisateur peut contenir jusqu'à 10 000 libellés.
Représentation JSON |
---|
{ "id": string, "name": string, "messageListVisibility": enum ( |
Champs | |
---|---|
id |
ID immuable du libellé. |
name |
Nom à afficher pour le libellé. |
messageListVisibility |
la visibilité des messages portant ce libellé dans la liste des messages de l'interface Web de Gmail ; |
labelListVisibility |
la visibilité du libellé dans la liste des libellés de l'interface Web de Gmail ; |
type |
Type de propriétaire du libellé. Les libellés utilisateur sont créés par l'utilisateur. Il peut les modifier et les supprimer, et les appliquer à n'importe quel message ou fil de discussion. Les libellés système sont créés en interne et ne peuvent pas être ajoutés, modifiés ni supprimés. Dans certaines circonstances, il est possible d'appliquer ou de supprimer des libellés système aux messages et aux fils de discussion, mais cela n'est pas garanti. Par exemple, les utilisateurs peuvent appliquer et supprimer les libellés |
messagesTotal |
Nombre total de messages associés au libellé. |
messagesUnread |
Nombre de messages non lus associés au libellé. |
threadsTotal |
Nombre total de threads portant le libellé. |
threadsUnread |
Nombre de fils de discussion non lus portant ce libellé. |
color |
Couleur à attribuer au libellé. La couleur n'est disponible que pour les libellés dont le champ |
MessageListVisibility
Enums | |
---|---|
show |
Afficher le libellé dans la liste des messages |
hide |
Ne pas afficher le libellé dans la liste des messages |
LabelListVisibility
Enums | |
---|---|
labelShow |
Afficher le libellé dans la liste des libellés. |
labelShowIfUnread |
Afficher le libellé s'il existe des messages non lus avec ce libellé |
labelHide |
Ne pas afficher le libellé dans la liste des libellés |
Type
Enums | |
---|---|
system |
Libellés créés par Gmail. |
user |
Étiquettes personnalisées créées par l'utilisateur ou l'application |
Couleur
Représentation JSON |
---|
{ "textColor": string, "backgroundColor": string } |
Champs | |
---|---|
textColor |
Couleur du texte du libellé, représentée par une chaîne hexadécimale. Ce champ est obligatoire pour définir la couleur d'un libellé. |
backgroundColor |
Couleur d'arrière-plan représentée par une chaîne hexadécimale #RRGGBB (par exemple, #000000). Ce champ est obligatoire pour définir la couleur d'un libellé. |
Méthodes |
|
---|---|
|
Crée un libellé. |
|
Supprime immédiatement et définitivement le libellé spécifié, et le supprime de tous les messages et fils de discussion auxquels il est appliqué. |
|
Récupère le libellé spécifié. |
|
Liste tous les libellés de la boîte aux lettres de l'utilisateur. |
|
Appliquer un correctif au libellé spécifié. |
|
Met à jour le libellé spécifié. |