Class GmailLabel

Etichetta Gmail

Un'etichetta creata dall'utente nell'account Gmail di un utente.

Metodi

MetodoTipo restituitoBreve descrizione
addToThread(thread)GmailLabelAggiunge questa etichetta al thread specificato e forza l'aggiornamento del thread (GmailThread.refresh()).
addToThreads(threads)GmailLabelAggiunge questa etichetta ai thread specificati e forza l'aggiornamento dei thread.
deleteLabel()voidElimina questa etichetta.
getName()StringRecupera il nome di questa etichetta.
getThreads()GmailThread[]Visualizza i thread contrassegnati con questa etichetta.
getThreads(start, max)GmailThread[]Visualizza un intervallo di thread contrassegnati con questa etichetta.
getUnreadCount()IntegerRecupera il numero di thread da leggere contrassegnati con questa etichetta.
removeFromThread(thread)GmailLabelRimuove questa etichetta dal thread specificato e forza l'aggiornamento del thread.
removeFromThreads(threads)GmailLabelRimuove questa etichetta dai thread specificati e ne forza l'aggiornamento.

Documentazione dettagliata

addToThread(thread)

Aggiunge questa etichetta al thread specificato e forza l'aggiornamento del 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);

Parametri

NomeTipoDescrizione
threadGmailThreadIl thread da etichettare.

Andata e ritorno

GmailLabel: questa etichetta, per il concatenamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o con gli ambiti appropriati dell'API REST correlata:

  • https://mail.google.com/

Consulta anche


addToThreads(threads)

Aggiunge questa etichetta ai thread specificati e forza l'aggiornamento dei thread. Puoi aggiungere etichette per un massimo di 100 thread per gruppo.

// 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);

Parametri

NomeTipoDescrizione
threadsGmailThread[]Un array di thread da etichettare.

Andata e ritorno

GmailLabel: questa etichetta, per il concatenamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o con gli ambiti appropriati dell'API REST correlata:

  • https://mail.google.com/

Consulta anche


deleteLabel()

Elimina questa etichetta.

var label = GmailApp.getUserLabelByName("MyLabel");
label.deleteLabel();

Genera

Error - se l'etichetta non può essere eliminata

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o con gli ambiti appropriati dell'API REST correlata:

  • https://mail.google.com/

Consulta anche


getName()

Recupera il nome di questa etichetta.

var label = GmailApp.getUserLabelByName("MyLabel");
Logger.log(label.getName()); //logs MyLabel

Andata e ritorno

String: il nome dell'etichetta.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o con gli ambiti appropriati dell'API REST correlata:

  • https://mail.google.com/

getThreads()

Visualizza i thread contrassegnati con questa etichetta.

Questa chiamata non riesce quando le dimensioni di tutti i thread sono troppo grandi per poter essere gestite dal sistema. Se la dimensione del thread è sconosciuta e potenzialmente molto grande, utilizza getThreads(start, max) e specifica intervalli di thread da recuperare in ogni chiamata.

// 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());
}

Andata e ritorno

GmailThread[]: un array di thread contrassegnati con questa etichetta.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o con gli ambiti appropriati dell'API REST correlata:

  • https://mail.google.com/

getThreads(start, max)

Visualizza un intervallo di thread contrassegnati con questa etichetta.

// 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());
}

Parametri

NomeTipoDescrizione
startIntegerL'indice del thread iniziale.
maxIntegerIl numero massimo di thread da restituire.

Andata e ritorno

GmailThread[]: un array di thread contrassegnati con questa etichetta.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o con gli ambiti appropriati dell'API REST correlata:

  • https://mail.google.com/

getUnreadCount()

Recupera il numero di thread da leggere contrassegnati con questa etichetta.

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

Andata e ritorno

Integer: il numero di thread etichettati da leggere.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o con gli ambiti appropriati dell'API REST correlata:

  • https://mail.google.com/

removeFromThread(thread)

Rimuove questa etichetta dal thread specificato e forza l'aggiornamento del 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);

Parametri

NomeTipoDescrizione
threadGmailThreadSenza etichetta del thread.

Andata e ritorno

GmailLabel: questa etichetta, per il concatenamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o con gli ambiti appropriati dell'API REST correlata:

  • https://mail.google.com/

Consulta anche


removeFromThreads(threads)

Rimuove questa etichetta dai thread specificati e ne forza l'aggiornamento. Puoi rimuovere le etichette per un massimo di 100 thread per gruppo.

// 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);

Parametri

NomeTipoDescrizione
threadsGmailThread[]Un array di thread senza etichetta.

Andata e ritorno

GmailLabel: questa etichetta, per il concatenamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o con gli ambiti appropriati dell'API REST correlata:

  • https://mail.google.com/

Consulta anche