Um marcador criado pelo usuário na conta do Gmail de um usuário.
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addToThread(thread) | GmailLabel | Adiciona este marcador à linha de execução especificada e força a atualização (GmailThread.refresh() ). |
addToThreads(threads) | GmailLabel | Adiciona esse marcador às linhas de execução fornecidas e força as linhas de execução a serem atualizadas. |
deleteLabel() | void | Exclui o marcador. |
getName() | String | Recebe o nome do rótulo. |
getThreads() | GmailThread[] | Recebe as conversas marcadas com esse rótulo. |
getThreads(start, max) | GmailThread[] | Recebe um intervalo de linhas de execução marcadas com este rótulo. |
getUnreadCount() | Integer | Recebe o número de conversas não lidas marcadas com esse marcador. |
removeFromThread(thread) | GmailLabel | Remove este marcador da linha de execução especificada e força a linha de execução a ser atualizada. |
removeFromThreads(threads) | GmailLabel | Remove este marcador das linhas de execução fornecidas e força as linhas de execução a serem atualizadas. |
Documentação detalhada
addToThread(thread)
Adiciona este marcador à linha de execução especificada e força a atualização (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
Nome | Tipo | Descrição |
---|---|---|
thread | GmailThread | Thread a ser rotulado. |
Retornar
GmailLabel
: este marcador, 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)
Adiciona esse marcador às linhas de execução fornecidas e força as linhas de execução a serem atualizadas. É possível 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
Nome | Tipo | Descrição |
---|---|---|
threads | GmailThread[] | Uma matriz de linhas de execução a serem rotuladas. |
Retornar
GmailLabel
: este marcador, 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
deleteLabel()
Exclui o 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()
Recebe o nome do rótulo.
var label = GmailApp.getUserLabelByName("MyLabel"); Logger.log(label.getName()); //logs MyLabel
Retornar
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/
getThreads()
Recebe 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 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()); }
Retornar
GmailThread[]
: uma matriz de linhas de execução marcadas com este 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/
getThreads(start, max)
Recebe um intervalo de linhas de execução marcadas com este 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
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 este 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/
getUnreadCount()
Recebe o número de conversas não lidas marcadas com esse marcador.
// log the number of unread threads labeled with MyLabel var label = GmailApp.getUserLabelByName("MyLabel"); Logger.log(label.getUnreadCount());
Retornar
Integer
: o número de linhas de execução 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/
removeFromThread(thread)
Remove este marcador da linha de execução especificada e força a linha de execução 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
Nome | Tipo | Descrição |
---|---|---|
thread | GmailThread | A conversa não tem rótulo. |
Retornar
GmailLabel
: este marcador, 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)
Remove este marcador das linhas de execução fornecidas e força as linhas de execução a serem atualizadas. É possível remover rótulos de 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
Nome | Tipo | Descrição |
---|---|---|
threads | GmailThread[] | Uma matriz de threads a ser sem rótulo. |
Retornar
GmailLabel
: este marcador, 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/