Class GmailLabel

Adiciona esse rótulo à linha de execução fornecida e força a linha a ser atualizada (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);

Parâmetros

Retorno

GmailLabel: esse rótulo para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Veja também

• removeFromThread(thread)

Adiciona esse rótulo às linhas de execução fornecidas e força a atualização delas. Você pode adicionar rótulos para até 100 linhas de execução por lote.

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

Parâmetros

Retorno

GmailLabel: esse rótulo para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Veja também

• removeFromThreads(threads)

Exclui este marcador.

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

Gera

Error: se o marcador não puder ser excluído.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Veja também

• getName()

Extrai o nome desse rótulo.

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

Retorno

String: o nome do rótulo.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Extrai as conversas marcadas com esse rótulo.

Essas chamadas falham quando o tamanho de todas as linhas de execução é muito grande para o sistema processar. Quando o tamanho da linha de execução for desconhecido e possivelmente muito grande, use getThreads(start, max) e especifique os intervalos das linhas de execução a serem recuperadas em cada chamada.

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

Retorno

GmailThread[]: uma matriz de linhas de execução marcadas com esse rótulo.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Recebe um intervalo de conversas marcadas com esse rótulo.

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

Parâmetros

Retorno

GmailThread[]: uma matriz de linhas de execução marcadas com esse rótulo.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Recebe o número de conversas não lidas marcadas com este marcador.

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

Retorno

Integer: o número de conversas marcadas não lidas.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Remove esse rótulo da linha de execução fornecida e força a linha a ser atualizada.

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

Parâmetros

Retorno

GmailLabel: esse rótulo para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Veja também

• addToThread(thread)

Remove esse rótulo das linhas de execução fornecidas e força a atualização delas. Você pode remover rótulos para até 100 linhas de execução por lote.

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

Parâmetros

Retorno

GmailLabel: esse rótulo para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Veja também

• addToThreads(threads)