Class GmailLabel

Adiciona esse rótulo à conversa especificada e força a atualização dela (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);

Parâmetros

Retornar

GmailLabel: este 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/

Consulte também

• removeFromThread(thread)

Adiciona esse rótulo às conversas especificadas e força a atualização delas. É possível adicionar rótulos para até 100 conversas por lote.

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

Parâmetros

Retornar

GmailLabel: este 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/

Consulte também

• removeFromThreads(threads)

Exclui o marcador.

const 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/

Consulte também

• getName()

Recebe o ID deste rótulo.

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

Retornar

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

Recebe o nome deste marcador.

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

Retornar

String: o nome do marcador.

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 as linhas de execução marcadas com esse rótulo.

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

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

Retornar

GmailThread[]: uma matriz de conversas 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
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = label.getThreads(0, 30);
for (let i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

Parâmetros

Retornar

GmailThread[]: uma matriz de conversas 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 esse rótulo.

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

Retornar

Integer: o número de conversas marcadas como 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 o marcador da conversa especificada e força a atualização dela.

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

Parâmetros

Retornar

GmailLabel: este 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/

Consulte também

• addToThread(thread)

Remove o rótulo das conversas especificadas e força a atualização delas. É possível remover rótulos de até 100 conversas por lote.

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

Parâmetros

Retornar

GmailLabel: este 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/

Consulte também

• addToThreads(threads)