Class GmailLabel

GmailÉtiquette

Libellé créé par l'utilisateur dans son compte Gmail.

Méthodes

Méthode	Type renvoyé	Brève description
addToThread(thread)	GmailLabel	Ajoute ce libellé au thread donné et force l'actualisation du thread (GmailThread.refresh()).
addToThreads(threads)	GmailLabel	Ajoute ce libellé aux threads donnés et force leur actualisation.
deleteLabel()	void	Supprime ce libellé.
getName()	String	Récupère le nom de ce libellé.
getThreads()	GmailThread[]	Récupère les threads marqués avec ce libellé.
getThreads(start, max)	GmailThread[]	Récupère une plage de threads marqués avec ce libellé.
getUnreadCount()	Integer	Récupère le nombre de fils de discussion non lus tagués avec ce libellé.
removeFromThread(thread)	GmailLabel	Supprime ce libellé du fil de discussion donné et force l'actualisation du fil.
removeFromThreads(threads)	GmailLabel	Supprime ce libellé des threads donnés et force leur actualisation.

Documentation détaillée

addToThread(thread)

Ajoute ce libellé au thread donné et force l'actualisation du thread (GmailThread.refresh()).

// label the first thread in the inbox with the label MyLabel
const label = GmailApp.getUserLabelByName('MyLabel');
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
label.addToThread(firstThread);

Paramètres

Nom	Type	Description
thread	GmailThread	Fil de discussion à libeller.

Renvois

GmailLabel : libellé pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Voir aussi

• removeFromThread(thread)

---

addToThreads(threads)

Ajoute ce libellé aux threads donnés et force leur actualisation. Vous pouvez ajouter des libellés pour jusqu'à 100 threads par lot.

// label the first three threads in the inbox with the label MyLabel
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = GmailApp.getInboxThreads(0, 3);
label.addToThreads(threads);

Paramètres

Nom	Type	Description
threads	GmailThread[]	Tableau de threads à libeller.

Renvois

GmailLabel : libellé pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Voir aussi

• removeFromThreads(threads)

---

deleteLabel()

Supprime ce libellé.

const label = GmailApp.getUserLabelByName('MyLabel');
label.deleteLabel();

Génère

Error : si le libellé ne peut pas être supprimé

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Voir aussi

• getName()

---

getName()

Récupère le nom de ce libellé.

const label = GmailApp.getUserLabelByName('MyLabel');
Logger.log(label.getName());  // logs MyLabel

Renvois

String : nom du libellé.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

---

getThreads()

Récupère les threads marqués avec ce libellé.

Ces appels échouent lorsque la taille de tous les threads est trop importante pour que le système puisse les gérer. Lorsque la taille de thread est inconnue et potentiellement très importante, veuillez utiliser getThreads(start, max) et spécifier les plages de threads à récupérer dans chaque appel.

// Log the subject lines of the threads labeled with MyLabel
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = label.getThreads();
for (let i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

Renvois

GmailThread[] : tableau de threads marqués de cette étiquette.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

---

getThreads(start, max)

Récupère une plage de threads marqués avec ce libellé.

// log the subject lines of up to the first 30 threads with the label MyLabel
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = label.getThreads(0, 30);
for (let i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

Paramètres

Nom	Type	Description
start	Integer	Index du thread de départ.
max	Integer	Nombre maximal de threads à renvoyer.

Renvois

GmailThread[] : tableau de threads marqués de cette étiquette.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

---

getUnreadCount()

Récupère le nombre de fils de discussion non lus tagués avec ce libellé.

// log the number of unread threads labeled with MyLabel
const label = GmailApp.getUserLabelByName('MyLabel');
Logger.log(label.getUnreadCount());

Renvois

Integer : nombre de fils de discussion libellés non lus.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

---

removeFromThread(thread)

Supprime ce libellé du fil de discussion donné et force l'actualisation du fil.

// remove the label MyLabel from the first thread in the inbox
const label = GmailApp.getUserLabelByName('MyLabel');
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
label.removeFromThread(firstThread);

Paramètres

Nom	Type	Description
thread	GmailThread	Le fil de discussion ne doit pas être associé à un libellé.

Renvois

GmailLabel : libellé pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Voir aussi

• addToThread(thread)

---

removeFromThreads(threads)

Supprime ce libellé des threads donnés et force leur actualisation. Vous pouvez supprimer des libellés pour jusqu'à 100 threads par lot.

// remove the label MyLabel from the first three threads in the inbox
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = GmailApp.getInboxThreads(0, 3);
label.removeFromThreads(threads);

Paramètres

Nom	Type	Description
threads	GmailThread[]	Tableau de threads à ne pas libeller.

Renvois

GmailLabel : libellé pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Voir aussi

• addToThreads(threads)