Cette page a été traduite par l'API Cloud Translation.

Class GmailLabel

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 de ce 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 portant ce libellé.
`getUnreadCount()`	`Integer`	Récupère le nombre de fils de discussion non lus associés à ce libellé.
`removeFromThread(thread)`	`GmailLabel`	Supprime ce libellé du thread donné et force l'actualisation du thread.
`removeFromThreads(threads)`	`GmailLabel`	Supprime ce libellé des threads donnés et force l'actualisation de ces derniers.

Documentation détaillée

`addToThread(thread)`

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

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

Paramètres

Nom	Type	Description
`thread`	`GmailThread`	Fil de discussion auquel ajouter un libellé.

Renvois

GmailLabel : libellé utilisé 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 threads donnés et force leur actualisation. Vous pouvez ajouter des étiquettes jusqu'à 100 threads par lot.

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

Paramètres

Nom	Type	Description
`threads`	`GmailThread[]`	Tableau des threads à étiqueter.

Renvois

GmailLabel : libellé utilisé 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é.

var 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()

`getName()`

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

var 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 threads marqués avec ce libellé.

Cet appel échoue lorsque la taille de tous les threads est trop importante pour que le système puisse la gérer. Où la taille du thread est inconnue et peut être 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
var label = GmailApp.getUserLabelByName("MyLabel");
var threads = label.getThreads();
for (var i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

Renvois

GmailThread[] : tableau de threads portant 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 threads portant ce libellé.

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

Paramètres

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

Renvois

GmailThread[] : tableau de threads portant 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 associés à ce libellé.

// log the number of unread threads labeled with MyLabel
var 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 thread donné et force l'actualisation du thread.

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

Paramètres

Nom	Type	Description
`thread`	`GmailThread`	Le thread ne sera pas étiqueté.

Renvois

GmailLabel : libellé utilisé 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 threads donnés et force l'actualisation de ces derniers. Vous pouvez supprimer des étiquettes pour un maximum de 100 threads par lot.

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

Paramètres

Nom	Type	Description
`threads`	`GmailThread[]`	Tableau des threads à retirer d'une étiquette.

Renvois

GmailLabel : libellé utilisé 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)