Class GmailLabel

GmailLabel

Libellé créé par un utilisateur dans son compte Gmail.

Méthodes

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

Documentation détaillée

addToThread(thread)

Ajoute ce libellé au fil de discussion donné et force l'actualisation du fil de discussion (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 : ce libellé, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 fils de discussion donnés et force leur actualisation. Vous pouvez ajouter des libellés à un maximum de 100 fils de discussion 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 fils de discussion à libeller.

Renvois

GmailLabel : ce libellé, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 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()

---

getId()

Récupère l'ID de ce libellé.

const label = GmailApp.getUserLabelByName('MyLabel');
console.log(label.getId());

Renvois

String : ID du libellé.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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/

---

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 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 fils de discussion marqués avec ce libellé.

Ces appels échouent lorsque la taille de tous les fils de discussion est trop importante pour que le système puisse la gérer. Lorsque la taille du fil de discussion est inconnue et potentiellement très importante, veuillez utiliser getThreads(start, max) et spécifier les plages de fils de discussion à 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 fils de discussion marqués avec ce libellé.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 fils de discussion 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 fil de discussion de départ.
max	Integer	Nombre maximal de fils de discussion à renvoyer.

Renvois

GmailThread[] : tableau de fils de discussion marqués avec ce libellé.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 marqué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 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 de discussion.

// 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	Fil de discussion à ne plus libeller.

Renvois

GmailLabel : ce libellé, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 fils de discussion donnés et force leur actualisation. Vous pouvez supprimer des libellés d'un maximum de 100 fils de discussion 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 fils de discussion à ne plus libeller.

Renvois

GmailLabel : ce libellé, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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)