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 especificada e força a linha de execução a ser atualizada (GmailThread.refresh() ). |
addToThreads(threads) | GmailLabel | Adiciona esse rótulo às linhas de execução especificadas e força a atualização das linhas de execução. |
deleteLabel() | void | Exclui este marcador. |
getName() | String | Recebe o nome desse rótulo. |
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 conversas não lidas marcadas com esse marcador. |
removeFromThread(thread) | GmailLabel | Remove esse rótulo da linha de execução especificada e força a linha de execução a ser atualizada. |
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 linha de execução 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 marcada. |
Retornar
GmailLabel
: este rótulo, para encadeamento.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://mail.google.com/
Consulte também
addToThreads(threads)
Adiciona esse rótulo às linhas de execução especificadas e força a atualização das linhas de execução. É possível adicionar rótulos com 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 rótulo, para encadeamento.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://mail.google.com/
Consulte 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 precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://mail.google.com/
Consulte também
getName()
Recebe o nome desse 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 precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://mail.google.com/
getThreads()
Recebe as linhas de execução marcadas com esse rótulo.
Essas chamadas falham quando o tamanho de todas as linhas de execução é muito grande para o sistema processar. Onde
o tamanho da linha de execução é desconhecido e pode ser muito grande. Use getThreads(start, max)
e especifique os intervalos das linhas de execução que serão 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 esse rótulo.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados 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 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 esse rótulo.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir 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 conversas marcadas e não lidas.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://mail.google.com/
removeFromThread(thread)
Remove esse rótulo 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 linha de execução não está rotulada. |
Retornar
GmailLabel
: este rótulo, para encadeamento.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://mail.google.com/
Consulte também
removeFromThreads(threads)
Remove esse rótulo das linhas de execução especificadas 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 serão identificadas. |
Retornar
GmailLabel
: este rótulo, para encadeamento.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://mail.google.com/