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 esse rótulo à linha de execução fornecida e força a linha a ser atualizada (GmailThread.refresh() ). |
addToThreads(threads) | GmailLabel | Adiciona esse rótulo às linhas de execução fornecidas e força a atualização delas. |
deleteLabel() | void | Exclui este marcador. |
getName() | String | Extrai o nome desse rótulo. |
getThreads() | GmailThread[] | Extrai as conversas marcadas com esse rótulo. |
getThreads(start, max) | GmailThread[] | Recebe um intervalo de conversas marcadas com esse rótulo. |
getUnreadCount() | Integer | Recebe o número de conversas não lidas marcadas com este marcador. |
removeFromThread(thread) | GmailLabel | Remove esse rótulo da linha de execução fornecida e força a linha a ser atualizada. |
removeFromThreads(threads) | GmailLabel | Remove esse rótulo das linhas de execução fornecidas e força a atualização delas. |
Documentação detalhada
addToThread(thread)
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
Nome | Tipo | Descrição |
---|---|---|
thread | GmailThread | A conversa a ser rotulada. |
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)
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
Nome | Tipo | Descrição |
---|---|---|
threads | GmailThread[] | Uma matriz de linhas de execução a serem rotuladas. |
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
deleteLabel()
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/
getThreads()
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/
getThreads(start, max)
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
Nome | Tipo | Descrição |
---|---|---|
start | Integer | O índice da linha de execução inicial. |
max | Integer | O número máximo de threads a serem retornados. |
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/
getUnreadCount()
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/
removeFromThread(thread)
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
Nome | Tipo | Descrição |
---|---|---|
thread | GmailThread | A conversa não deve estar rotulada. |
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)
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
Nome | Tipo | Descrição |
---|---|---|
threads | GmailThread[] | Uma matriz de linhas de execução que não vão ser rotuladas. |
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/