Libellé créé par un utilisateur dans son compte Gmail.
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
add | Gmail | Ajoute ce libellé au thread donné et force l'actualisation du thread (Gmail ). |
add | Gmail | Ajoute ce libellé aux threads spécifiés et force l'actualisation des threads. |
delete | void | Supprime ce libellé. |
get | String | Récupère l'ID de ce libellé. |
get | String | Récupère le nom de ce libellé. |
get | Gmail | Récupère les threads marqués avec ce libellé. |
get | Gmail | Récupère une plage de fils de discussion marqués avec ce libellé. |
get | Integer | Obtient le nombre de fils de discussion non lus associés à ce libellé. |
remove | Gmail | Supprime ce libellé du fil de discussion donné et force l'actualisation du fil. |
remove | Gmail | Supprime ce libellé des fils de discussion indiqués et force leur actualisation. |
Documentation détaillée
add To Thread(thread)
Ajoute ce libellé au thread donné et force l'actualisation du thread (Gmail
).
// 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 | Gmail | Fil de discussion à libeller. |
Renvois
Gmail
: 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
add To Threads(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
Nom | Type | Description |
---|---|---|
threads | Gmail | Tableau de threads à étiqueter. |
Renvois
Gmail
: 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
delete Label()
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
get Id()
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/
get Name()
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/
get Threads()
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 get
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
Gmail
: 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/
get Threads(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 thread de départ. |
max | Integer | Nombre maximal de threads à renvoyer. |
Renvois
Gmail
: 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/
get Unread Count()
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/
remove From Thread(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 | Gmail | Le fil de discussion ne sera pas libellé. |
Renvois
Gmail
: 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
remove From Threads(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
Nom | Type | Description |
---|---|---|
threads | Gmail | Tableau de fils de discussion à supprimer. |
Renvois
Gmail
: 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/