Class GmailLabel

GmailLabel

Un'etichetta creata dall'utente nell'account Gmail dell'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 ne forza l'aggiornamento.
deleteLabel()voidElimina questa etichetta.
getId()StringRecupera l'ID di questa etichetta.
getName()StringRestituisce il nome di questa etichetta.
getThreads()GmailThread[]Recupera i thread contrassegnati con questa etichetta.
getThreads(start, max)GmailThread[]Recupera un intervallo di thread contrassegnati con questa etichetta.
getUnreadCount()IntegerRestituisce il numero di thread non letti taggati 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 forza l'aggiornamento dei thread.

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
const label = GmailApp.getUserLabelByName('MyLabel');
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
label.addToThread(firstThread);

Parametri

NomeTipoDescrizione
threadGmailThreadIl thread da etichettare.

Indietro

GmailLabel: questa etichetta per l'accodamento.

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/

Vedi anche

addToThreads(threads)

Aggiunge questa etichetta ai thread specificati e ne forza l'aggiornamento. Puoi aggiungere etichette per fino a 100 thread per batch. 

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

Parametri

NomeTipoDescrizione
threadsGmailThread[]Un array di thread da etichettare.

Indietro

GmailLabel: questa etichetta per l'accodamento.

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/

Vedi anche

deleteLabel()

Elimina questa etichetta. 

const label = GmailApp.getUserLabelByName('MyLabel');
label.deleteLabel();

Lanci

Error: se non è possibile eliminare l'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/

Vedi anche

getId()

Recupera l'ID di questa etichetta. 

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

Indietro

String: l'ID 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/

getName()

Restituisce il nome di questa etichetta. 

const label = GmailApp.getUserLabelByName('MyLabel');
Logger.log(label.getName());  // logs MyLabel

Indietro

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

Recupera i thread contrassegnati con questa etichetta.

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

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

Indietro

GmailThread[]: un array di thread contrassegnati da 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)

Recupera un intervallo di thread contrassegnati con questa etichetta. 

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

Parametri

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

Indietro

GmailThread[]: un array di thread contrassegnati da 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()

Restituisce il numero di thread non letti taggati con questa etichetta. 

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

Indietro

Integer: il numero di thread etichettati non letti.

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
const label = GmailApp.getUserLabelByName('MyLabel');
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
label.removeFromThread(firstThread);

Parametri

NomeTipoDescrizione
threadGmailThreadIl thread non è etichettato.

Indietro

GmailLabel: questa etichetta per l'accodamento.

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/

Vedi anche

removeFromThreads(threads)

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

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

Parametri

NomeTipoDescrizione
threadsGmailThread[]Un array di thread da non etichettare.

Indietro

GmailLabel: questa etichetta per l'accodamento.

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/

Vedi anche