Esta página foi traduzida pela API Cloud Translation.

Class GmailLabel

Um marcador criado pelo usuário na conta do Gmail.

Métodos

Método	Tipo de retorno	Breve descrição
`addToThread(thread)`	`GmailLabel`	Adiciona esse rótulo à linha de execução especificada e força a atualização da linha de execução (`GmailThread.refresh()`).
`addToThreads(threads)`	`GmailLabel`	Adiciona esse rótulo às linhas de execução especificadas e força a atualização delas.
`deleteLabel()`	`void`	Exclui este rótulo.
`getName()`	`String`	Extrai o nome desse marcador.
`getThreads()`	`GmailThread[]`	Recebe as linhas de execução marcadas com esse rótulo.
`getThreads(start, max)`	`GmailThread[]`	Recebe um intervalo de linhas de execução marcadas com esse rótulo.
`getUnreadCount()`	`Integer`	Recebe o número de linhas não lidas marcadas com esse rótulo.
`removeFromThread(thread)`	`GmailLabel`	Remove esse rótulo da linha de execução especificada e força a atualização dela.
`removeFromThreads(threads)`	`GmailLabel`	Remove esse rótulo das linhas de execução especificadas e força a atualização delas.

Documentação detalhada

`addToThread(thread)`

Adiciona esse rótulo à linha de execução especificada e força a atualização da linha de execução (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

Nome	Tipo	Descrição
`thread`	`GmailThread`	A linha de execução a ser rotulada.

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 adequados da API REST relacionada:

https://mail.google.com/

Consulte também

removeFromThread(thread)

`addToThreads(threads)`

Adiciona esse rótulo às linhas de execução especificadas e força a atualização delas. É possível adicionar rótulos para até 100 linhas 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

Nome	Tipo	Descrição
`threads`	`GmailThread[]`	Uma matriz de linhas a serem marcadas.

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 adequados da API REST relacionada:

https://mail.google.com/

Consulte também

removeFromThreads(threads)

`deleteLabel()`

Exclui este rótulo.

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

Gera

Error: se não for possível excluir o rótulo.

Autorização

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

https://mail.google.com/

Consulte também

getName()

`getName()`

Extrai o nome desse 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 adequados da API REST relacionada:

https://mail.google.com/

`getThreads()`

Recebe as linhas de execução marcadas com esse rótulo.

Essa chamada falha quando o tamanho de todas as linhas é muito grande para o sistema processar. Quando o tamanho da linha for desconhecido e potencialmente muito grande, use getThreads(start, max) e especifique os intervalos das linhas 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 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 adequados da API REST relacionada:

https://mail.google.com/

`getThreads(start, max)`

Recebe um intervalo de linhas de execução 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

Nome	Tipo	Descrição
`start`	`Integer`	O índice da linha de execução inicial.
`max`	`Integer`	O número máximo de linhas de execução a serem retornadas.

Retornar

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 adequados da API REST relacionada:

https://mail.google.com/

`getUnreadCount()`

Recebe o número de linhas 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 adequados da API REST relacionada:

https://mail.google.com/

`removeFromThread(thread)`

Remove esse rótulo da linha de execução 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

Nome	Tipo	Descrição
`thread`	`GmailThread`	A linha de execução não tem rótulo.

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 adequados da API REST relacionada:

https://mail.google.com/

Consulte também

addToThread(thread)

`removeFromThreads(threads)`

Remove esse rótulo das linhas de execução especificadas e força a atualização delas. É possível remover rótulos de até 100 linhas 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

Nome	Tipo	Descrição
`threads`	`GmailThread[]`	Uma matriz de linhas a serem rotuladas.

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 adequados da API REST relacionada:

https://mail.google.com/

Consulte também

addToThreads(threads)