Class GmailLabel

LibelléGmail

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

Méthodes

MéthodeType renvoyéBrève description
addToThread(thread)GmailLabelAjoute ce libellé au thread donné et force l'actualisation du thread (GmailThread.refresh()).
addToThreads(threads)GmailLabelAjoute ce libellé aux threads spécifiés et force l'actualisation des threads.
deleteLabel()voidSupprime ce libellé.
getId()StringRécupère l'ID de ce libellé.
getName()StringRé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 fils de discussion marqués avec ce libellé.
getUnreadCount()IntegerObtient le nombre de fils de discussion non lus associés à ce libellé.
removeFromThread(thread)GmailLabelSupprime ce libellé du fil de discussion donné et force l'actualisation du fil.
removeFromThreads(threads)GmailLabelSupprime ce libellé des fils de discussion indiqué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

NomTypeDescription
threadGmailThreadFil 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 scopes suivants ou les scopes appropriés de l'API REST associée :

  • https://mail.google.com/

Voir aussi


addToThreads(threads)

Ajoute ce libellé aux threads spécifiés et force l'actualisation des threads. Vous pouvez ajouter des libellés pour 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

NomTypeDescription
threadsGmailThread[]Tableau de threads à étiqueter.

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 scopes suivants ou les scopes appropriés de l'API REST associée :

  • https://mail.google.com/

Voir aussi


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 scopes suivants ou les scopes appropriés de l'API REST associée :

  • https://mail.google.com/

Voir aussi


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 scopes suivants ou les scopes 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 scopes suivants ou les scopes 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 la gérer. Lorsque la taille du thread est inconnue et potentiellement très grande, 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 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 scopes suivants ou les scopes 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

NomTypeDescription
startIntegerIndex du thread de départ.
maxIntegerNombre maximal de threads à 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 scopes suivants ou les scopes appropriés de l'API REST associée :

  • https://mail.google.com/

getUnreadCount()

Obtient le nombre de fils de discussion non lus associés à 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 non lus et libellés.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants ou les scopes 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

NomTypeDescription
threadGmailThreadLe fil de discussion ne sera pas libellé.

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 scopes suivants ou les scopes appropriés de l'API REST associée :

  • https://mail.google.com/

Voir aussi


removeFromThreads(threads)

Supprime ce libellé des fils de discussion indiqués et force leur actualisation. Vous pouvez supprimer des libellés pour 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

NomTypeDescription
threadsGmailThread[]Tableau de fils de discussion à supprimer.

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 scopes suivants ou les scopes appropriés de l'API REST associée :

  • https://mail.google.com/

Voir aussi