Class GmailApp

GmailApp

Dá acesso a conversas, mensagens e marcadores do Gmail.

Métodos

MétodoTipo de retornoBreve descrição
createDraft(recipient, subject, body)GmailDraftCria um rascunho de mensagem de e-mail.
createDraft(recipient, subject, body, options)GmailDraftCria um rascunho de mensagem de e-mail com argumentos opcionais.
createLabel(name)GmailLabelCria um novo rótulo de usuário com o nome informado.
deleteLabel(label)GmailAppExclui o rótulo especificado.
getAliases()String[]Extrai uma lista dos e-mails configurados como aliases dessa conta no Gmail.
getDraft(draftId)GmailDraftRecuperar um rascunho de mensagem de e-mail pelo ID.
getDraftMessages()GmailMessage[]Recupera todos os rascunhos.
getDrafts()GmailDraft[]Recebe todos os rascunhos de mensagens do Gmail.
getInboxThreads()GmailThread[]Recupera todas as conversas da Caixa de entrada, independentemente dos marcadores.
getInboxThreads(start, max)GmailThread[]Recupera vários tópicos da Caixa de entrada, independentemente dos marcadores.
getInboxUnreadCount()IntegerMostra o número de conversas não lidas na caixa de entrada.
getMessageById(id)GmailMessageRecebe uma mensagem pelo ID.
getMessagesForThread(thread)GmailMessage[]Recupera todas as mensagens na conversa especificada.
getMessagesForThreads(threads)GmailMessage[][]Recupera todas as mensagens nas conversas especificadas.
getPriorityInboxThreads()GmailThread[]Recupera todas as conversas da Caixa prioritária, independentemente dos marcadores.
getPriorityInboxThreads(start, max)GmailThread[]Recupera um intervalo de conversas da Caixa prioritária, independentemente dos marcadores.
getPriorityInboxUnreadCount()IntegerMostra o número de conversas não lidas na Caixa prioritária.
getSpamThreads()GmailThread[]Recupera todas as conversas de spam, independentemente dos marcadores.
getSpamThreads(start, max)GmailThread[]Recupera uma variedade de conversas de spam, independentemente dos marcadores.
getSpamUnreadCount()IntegerMostra o número de conversas não lidas que são spam.
getStarredThreads()GmailThread[]Recupera todas as conversas com estrela, independentemente dos rótulos.
getStarredThreads(start, max)GmailThread[]Recupera uma variedade de conversas com estrela, independentemente dos rótulos.
getStarredUnreadCount()IntegerExtrai o número de conversas não lidas marcadas com estrela.
getThreadById(id)GmailThreadRecebe uma linha de execução por ID.
getTrashThreads()GmailThread[]Recupera todas as conversas de lixeira, independentemente dos marcadores.
getTrashThreads(start, max)GmailThread[]Recupera um intervalo de threads de lixeira, independentemente dos rótulos.
getUserLabelByName(name)GmailLabelRecupera um rótulo de acordo com o nome dele.
getUserLabels()GmailLabel[]Recupera uma lista de rótulos criados pelo usuário.
markMessageRead(message)GmailAppMarca a mensagem como lida e força a atualização dela.
markMessageUnread(message)GmailAppMarca esta mensagem como não lida e força a atualização dela.
markMessagesRead(messages)GmailAppMarca essas mensagens como lidas e força a atualização delas.
markMessagesUnread(messages)GmailAppMarca essas mensagens como não lidas e força a atualização delas.
markThreadImportant(thread)GmailAppMarca a linha de execução como importante e força a atualização dela.
markThreadRead(thread)GmailAppMarca a linha de execução como lida e força a atualização dela.
markThreadUnimportant(thread)GmailAppMarca a conversa como não importante e força a atualização dela.
markThreadUnread(thread)GmailAppMarca esta conversa como não lida e força a conversa a ser atualizada.
markThreadsImportant(threads)GmailAppMarca essas linhas de execução como importantes e força a atualização delas.
markThreadsRead(threads)GmailAppMarca essas linhas de execução como lidas e força a atualização delas.
markThreadsUnimportant(threads)GmailAppMarca essas conversas como não importantes e força a atualização delas.
markThreadsUnread(threads)GmailAppMarca essas conversas como não lidas e força a atualização delas.
moveMessageToTrash(message)GmailAppMove a mensagem para a lixeira e força a atualização dela.
moveMessagesToTrash(messages)GmailAppMove as mensagens especificadas para a lixeira e força a atualização delas.
moveThreadToArchive(thread)GmailAppMove a linha de execução para o arquivo e força a atualização dela.
moveThreadToInbox(thread)GmailAppMove a conversa para a caixa de entrada e força a atualização dela.
moveThreadToSpam(thread)GmailAppMove esta conversa para "Spam" e força a atualização dela.
moveThreadToTrash(thread)GmailAppMove a linha de execução para a lixeira e força a atualização dela.
moveThreadsToArchive(threads)GmailAppMove essas linhas de execução para o arquivo e força a atualização delas.
moveThreadsToInbox(threads)GmailAppMove essas conversas para a caixa de entrada e força a atualização delas.
moveThreadsToSpam(threads)GmailAppMove essas conversas para "Spam" e força a atualização delas.
moveThreadsToTrash(threads)GmailAppMove essas linhas de execução para a lixeira e força a atualização delas.
refreshMessage(message)GmailAppRecarrega a mensagem e o estado associado do Gmail. Isso é útil caso os marcadores, o estado de leitura etc. tenham sido alterados.
refreshMessages(messages)GmailAppRecarrega as mensagens e o estado associado do Gmail (útil caso os marcadores, o estado de leitura etc. tenham sido alterados).
refreshThread(thread)GmailAppRecarrega a conversa e o estado associado do Gmail (útil caso os marcadores, o estado de leitura etc. tenham sido alterados).
refreshThreads(threads)GmailAppRecarrega as linhas de execução e o estado associado do Gmail. Isso é útil caso os marcadores, o estado de leitura etc. tenham sido alterados.
search(query)GmailThread[]Pesquisar no Gmail com a consulta em questão.
search(query, start, max)GmailThread[]Pesquisar no Gmail com a consulta em questão.
sendEmail(recipient, subject, body)GmailAppEnvia uma mensagem de e-mail.
sendEmail(recipient, subject, body, options)GmailAppEnvia uma mensagem de e-mail com argumentos opcionais.
setCurrentMessageAccessToken(accessToken)voidDefine o token de acesso da mensagem atual que permite ao script acessar as propriedades GmailMessage atuais.
starMessage(message)GmailAppMarca a mensagem com uma estrela e força a atualização dela.
starMessages(messages)GmailAppAdiciona estrelas a essas mensagens e força a atualização delas.
unstarMessage(message)GmailAppRemove uma estrela da mensagem e força a atualização dela.
unstarMessages(messages)GmailAppRemove as estrelas dessas mensagens e força a atualização delas.

Documentação detalhada

createDraft(recipient, subject, body)

Cria um rascunho de mensagem de e-mail. O tamanho do e-mail (incluindo os cabeçalhos) é limitado por cota.

// The code below creates a draft email with the current date and time.
var now = new Date();
GmailApp.createDraft("mike@example.com", "current time", "The time is: " + now.toString());

Parâmetros

NomeTipoDescrição
recipientStringlista de endereços de e-mail separados por vírgula
subjectStringassunto do e-mail
bodyStringcorpo do e-mail

Retorno

GmailDraft: o rascunho do Gmail recém-criado

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


createDraft(recipient, subject, body, options)

Cria um rascunho de mensagem de e-mail com argumentos opcionais. O e-mail pode conter texto simples ou um corpo HTML. O tamanho do e-mail (incluindo cabeçalhos, mas excluindo anexos) é limitado por cota.

// Create a draft email with a file from Google Drive attached as a PDF.
var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.createDraft('mike@example.com', 'Attachment example', 'Please see attached file.', {
    attachments: [file.getAs(MimeType.PDF)],
    name: 'Automatic Emailer Script'
});

Parâmetros

NomeTipoDescrição
recipientStringos endereços do destinatário
subjectStringlinha de assunto
bodyStringo corpo do e-mail
optionsObjectum objeto JavaScript que especifica parâmetros avançados, conforme listado abaixo

Parâmetros avançados

NomeTipoDescrição
attachmentsBlobSource[]uma matriz de arquivos para enviar com o e-mail
bccStringuma lista de endereços de e-mail separados por vírgula em Cco
ccStringuma lista de endereços de e-mail separados por vírgulas para colocar em cópia
fromStringo endereço de origem do e-mail, que precisa ser um dos valores retornados por getAliases();
htmlBodyStringSe definido, os dispositivos capazes de renderizar HTML o usarão em vez do argumento obrigatório do corpo. Você pode adicionar um campo inlineImages opcional no corpo do HTML se tiver imagens inline do seu e-mail
inlineImagesObjectUm objeto JavaScript que contém um mapeamento da chave de imagem (String) para dados de imagem (BlobSource). Isso pressupõe que o parâmetro htmlBody é usado e contém referências a essas imagens no formato <img src="cid:imageKey" />
nameStringo nome do remetente do e-mail (padrão: o nome do usuário)
replyToStringUm endereço de e-mail para ser usado como o endereço para resposta padrão (padrão: o endereço de e-mail do usuário).

Retorno

GmailDraft: o rascunho do Gmail recém-criado

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


createLabel(name)

Cria um novo rótulo de usuário com o nome informado.

// Creates the label @FOO and logs label: FOO
Logger.log("label: " + GmailApp.createLabel("FOO"));

Parâmetros

NomeTipoDescrição
nameStringo nome do novo rótulo

Retorno

GmailLabel: o rótulo recém-criado.

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(label)

Exclui o rótulo especificado.

// Have to get the label by name first
var label = GmailApp.getUserLabelByName("FOO");
GmailApp.deleteLabel(label);

Parâmetros

NomeTipoDescrição
labelGmailLabelo rótulo a ser excluído

Retorno

GmailApp: o serviço do Gmail, útil 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


getAliases()

Extrai uma lista dos e-mails configurados como aliases dessa conta no Gmail.

É possível enviar uma mensagem de qualquer um desses aliases usando o argumento opcional "from".

// Log the aliases for this Gmail account and send an email as the first one.
var me = Session.getActiveUser().getEmail();
var aliases = GmailApp.getAliases();
Logger.log(aliases);
if (aliases.length > 0) {
  GmailApp.sendEmail(me, 'From an alias', 'A message from an alias!', {'from': aliases[0]});
} else {
  GmailApp.sendEmail(me, 'No aliases found', 'You have no aliases.');
}

Retorno

String[]: uma matriz de aliases para a conta.

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


getDraft(draftId)

Recuperar um rascunho de mensagem de e-mail pelo ID.

Use isso em conjunto com getId() nos rascunhos do Gmail.

// Get the first draft message in your drafts folder
var draft = GmailApp.getDrafts()[0];
// Get its ID
var draftId = draft.getId();
// Now fetch the same draft using that ID.
var draftById = GmailApp.getDraft(draftId);
// Should always log true as they should be the same message
Logger.log(draft.getMessage().getSubject() == draftById.getMessage().getSubject());

Parâmetros

NomeTipoDescrição
draftIdStringo ID do rascunho a ser recuperado

Retorno

GmailDraft: o rascunho com o ID fornecido.

Gera

Error: se nenhum rascunho com o ID fornecido for encontrado.

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/

getDraftMessages()

Recupera todos os rascunhos.

// Logs the number of draft messages
var drafts = GmailApp.getDraftMessages();
Logger.log(drafts.length);

Retorno

GmailMessage[]: uma matriz de rascunhos de mensagens do Gmail.

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/

getDrafts()

Recebe todos os rascunhos de mensagens do Gmail.

var drafts = GmailApp.getDrafts();
for (var i = 0; i < drafts.length; i++) {
  Logger.log(drafts[i].getId());
}

Retorno

GmailDraft[]: uma matriz de mensagens de rascunho do Gmail.

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/

getInboxThreads()

Recupera todas as conversas da Caixa de entrada, independentemente dos marcadores.

Essa chamada vai falhar quando o tamanho de todas as linhas de execução for muito grande para o sistema processar. Quando o tamanho da linha de execução for desconhecido e possivelmente muito grande, use a chamada "paginada" e especifique os intervalos das linhas de execução a serem recuperadas em cada chamada.

// Log the subject lines of your Inbox
var threads = GmailApp.getInboxThreads();
for (var i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

Retorno

GmailThread[]: uma matriz de conversas do Gmail na Caixa de entrada.

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/

getInboxThreads(start, max)

Recupera vários tópicos da Caixa de entrada, independentemente dos marcadores.

// Log the subject lines of up to the first 50 emails in your Inbox
var threads = GmailApp.getInboxThreads(0, 50);
for (var i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

Parâmetros

NomeTipoDescrição
startIntegero índice da primeira linha de execução a ser recuperada
maxIntegero número máximo de threads a serem recuperados

Retorno

GmailThread[]: uma matriz de conversas do Gmail na Caixa de entrada.

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/

getInboxUnreadCount()

Mostra o número de conversas não lidas na caixa de entrada.

Logger.log("Messages unread in inbox: " + GmailApp.getInboxUnreadCount());

Retorno

Integer: o número de conversas na Caixa de entrada com mensagens 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/

getMessageById(id)

Recebe uma mensagem pelo ID.

Use-o em conjunto com getId() nas mensagens do Gmail.

// Get the first message in the first thread of your inbox
var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
// Get its ID
var messageId = message.getId();
// Now fetch the same message using that ID.
var messageById = GmailApp.getMessageById(messageId);
// Should always log true as they should be the same message
Logger.log(message.getSubject() == messageById.getSubject());

Parâmetros

NomeTipoDescrição
idStringo ID da mensagem a ser recuperada

Retorno

GmailMessage: a mensagem com o ID fornecido.

Gera

Error: se nenhuma mensagem com o ID fornecido for encontrada.

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


getMessagesForThread(thread)

Recupera todas as mensagens na conversa especificada.

// Log all the subject lines in the first thread of your inbox
var thread = GmailApp.getInboxThreads(0, 1)[0];
var messages = GmailApp.getMessagesForThread(thread);
for (var i = 0 ; i < messages.length; i++) {
  Logger.log("subject: " + messages[i].getSubject());
}

Parâmetros

NomeTipoDescrição
threadGmailThreada sequência de mensagens a serem recuperadas

Retorno

GmailMessage[]: matriz de mensagens correspondentes a essa linha de execução

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


getMessagesForThreads(threads)

Recupera todas as mensagens nas conversas especificadas.

// Log the subject lines of all messages in the first two threads of your inbox
var thread = GmailApp.getInboxThreads(0, 2);
var messages = GmailApp.getMessagesForThreads(thread);
for (var i = 0 ; i < messages.length; i++) {
  for (var j = 0; j < messages[i].length; j++) {
    Logger.log("subject: " + messages[i][j].getSubject());
  }
}

Parâmetros

NomeTipoDescrição
threadsGmailThread[]os tópicos de mensagens a serem recuperados

Retorno

GmailMessage[][]: uma matriz de matrizes de mensagens, em que cada item na matriz externa corresponde a uma linha de execução e a matriz interna contém as mensagens dessa linha de execução.

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


getPriorityInboxThreads()

Recupera todas as conversas da Caixa prioritária, independentemente dos marcadores.

Essa chamada vai falhar quando o tamanho de todas as linhas de execução for muito grande para o sistema processar. Quando o tamanho da linha de execução for desconhecido e possivelmente muito grande, use a chamada "paginada" e especifique os intervalos das linhas de execução a serem recuperadas em cada chamada.

Logger.log("# of messages in your Priority Inbox: " +
           GmailApp.getPriorityInboxThreads().length);

Retorno

GmailThread[]: uma matriz de conversas do Gmail na Caixa prioritária.

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/

getPriorityInboxThreads(start, max)

Recupera um intervalo de conversas da Caixa prioritária, independentemente dos marcadores.

// Will log some number 2 or less
Logger.log("# of messages in your Priority Inbox: " +
           GmailApp.getPriorityInboxThreads(0, 2).length);

Parâmetros

NomeTipoDescrição
startIntegero índice da primeira linha de execução a ser recuperada
maxIntegero número máximo de threads a serem recuperados

Retorno

GmailThread[]: uma matriz de conversas do Gmail na Caixa prioritária.

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/

getPriorityInboxUnreadCount()

Mostra o número de conversas não lidas na Caixa prioritária.

Logger.log("Number of unread emails in your Priority Inbox : " +
           GmailApp.getPriorityInboxUnreadCount());

Retorno

Integer: o número de conversas na Caixa prioritária com mensagens 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/

getSpamThreads()

Recupera todas as conversas de spam, independentemente dos marcadores.

Essa chamada vai falhar quando o tamanho de todas as linhas de execução for muito grande para o sistema processar. Quando o tamanho da linha de execução for desconhecido e possivelmente muito grande, use a chamada "paginada" e especifique os intervalos das linhas de execução a serem recuperadas em cada chamada.

Logger.log("# of total spam threads: " + GmailApp.getSpamThreads().length);

Retorno

GmailThread[]: uma matriz de conversas do Gmail na pasta de spam.

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/

getSpamThreads(start, max)

Recupera uma variedade de conversas de spam, independentemente dos marcadores.

// Will log a number at most 5
Logger.log("# of total spam threads: " + GmailApp.getSpamThreads(0, 5).length);

Parâmetros

NomeTipoDescrição
startIntegero índice da primeira linha de execução a ser recuperada
maxIntegero número máximo de threads a serem recuperados

Retorno

GmailThread[]: uma matriz de conversas do Gmail na pasta de spam.

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/

getSpamUnreadCount()

Mostra o número de conversas não lidas que são spam.

// Unless you actually read stuff in your spam folder, this should be the same as
// the number of messages in your spam folder.
Logger.log("# unread threads that are spam: " + GmailApp.getSpamUnreadCount());

Retorno

Integer: o número de conversas de spam com mensagens 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/

getStarredThreads()

Recupera todas as conversas com estrela, independentemente dos rótulos.

Essa chamada vai falhar quando o tamanho de todas as linhas de execução for muito grande para o sistema processar. Quando o tamanho da linha de execução for desconhecido e possivelmente muito grande, use a chamada "paginada" e especifique os intervalos das linhas de execução a serem recuperadas em cada chamada.

// Logs the number of starred threads
Logger.log("# Starred threads: " + GmailApp.getStarredThreads().length);

Retorno

GmailThread[]: uma matriz de conversas do Gmail com estrela.

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/

getStarredThreads(start, max)

Recupera uma variedade de conversas com estrela, independentemente dos rótulos.

// Logs the number of starred threads to a maximum of 5
Logger.log("# Starred threads: " + GmailApp.getStarredThreads(0, 5).length);

Parâmetros

NomeTipoDescrição
startIntegero índice da primeira linha de execução a ser recuperada
maxIntegero número máximo de threads a serem recuperados

Retorno

GmailThread[]: uma matriz de conversas do Gmail com estrela.

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/

getStarredUnreadCount()

Extrai o número de conversas não lidas marcadas com estrela.

Logger.log("# unread and starred: " + GmailApp.getStarredUnreadCount());

Retorno

Integer: o número de conversas com estrela que têm mensagens 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/

getThreadById(id)

Recebe uma linha de execução por ID.

Use-o em conjunto com getId() nas conversas do Gmail.

// Gets the first inbox thread.
const firstThread = GmailApp.getInboxThreads(0,1)[0];
// Gets the same thread by ID.
const threadById = GmailApp.getThreadById(firstThread.getId());
// Verifies that they are the same.
console.log(firstThread.getFirstMessageSubject() === threadById.getFirstMessageSubject());

Parâmetros

NomeTipoDescrição
idStringO ID da linha de execução a ser recuperada.

Retorno

GmailThread: a linha de execução com o ID fornecido ou null, se não for encontrada.

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


getTrashThreads()

Recupera todas as conversas de lixeira, independentemente dos marcadores.

Essa chamada vai falhar quando o tamanho de todas as linhas de execução for muito grande para o sistema processar. Quando o tamanho da linha de execução for desconhecido e possivelmente muito grande, use a chamada "paginada" e especifique os intervalos das linhas de execução a serem recuperadas em cada chamada.

Logger.log("# of total trash threads: " + GmailApp.getTrashThreads().length);

Retorno

GmailThread[]: uma matriz de conversas do Gmail na lixeira.

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/

getTrashThreads(start, max)

Recupera um intervalo de threads de lixeira, independentemente dos rótulos.

// Will log a number at most 5
Logger.log("# of total trash threads: " + GmailApp.getTrashThreads(0, 5).length);

Parâmetros

NomeTipoDescrição
startIntegero índice da primeira linha de execução a ser recuperada
maxIntegero número máximo de threads a serem recuperados

Retorno

GmailThread[]: uma matriz de conversas do Gmail na lixeira.

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/

getUserLabelByName(name)

Recupera um rótulo de acordo com o nome dele.

var labelObject = GmailApp.getUserLabelByName("myLabel");

Parâmetros

NomeTipoDescrição
nameStringo nome do rótulo a ser recuperado

Retorno

GmailLabel: o marcador do Gmail com o nome fornecido

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/

getUserLabels()

Recupera uma lista de rótulos criados pelo usuário.

// Logs all of the names of your labels
var labels = GmailApp.getUserLabels();
for (var i = 0; i < labels.length; i++) {
  Logger.log("label: " + labels[i].getName());
}

Retorno

GmailLabel[]: matriz de rótulos criados pelo usuário.

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/

markMessageRead(message)

Marca a mensagem como lida e força a atualização dela.

// Mark the first message in the first thread of your inbox as read
var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageRead(message);

Parâmetros

NomeTipoDescrição
messageGmailMessagea mensagem a ser marcada como lida

Retorno

GmailApp: o serviço do Gmail, útil 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


markMessageUnread(message)

Marca esta mensagem como não lida e força a atualização dela.

// Mark the first message in the first thread of your inbox as unread
var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageUnread(message);

Parâmetros

NomeTipoDescrição
messageGmailMessagea mensagem a ser marcada como não lida

Retorno

GmailApp: o serviço do Gmail, útil 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


markMessagesRead(messages)

Marca essas mensagens como lidas e força a atualização delas.

// Mark first three messages in the first inbox thread as read.
// Assumes that the first inbox thread has 3 messages in it.
var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
var messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesRead(thread.getMessages());

Parâmetros

NomeTipoDescrição
messagesGmailMessage[]uma matriz de mensagens para marcar como lidas

Retorno

GmailApp: o serviço do Gmail, útil 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


markMessagesUnread(messages)

Marca essas mensagens como não lidas e força a atualização delas.

// Mark first three messages in the first inbox thread as unread.
// Assumes that the first inbox thread has 3 messages in it
var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
var messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesUnread(thread.getMessages());

Parâmetros

NomeTipoDescrição
messagesGmailMessage[]uma matriz de mensagens para marcar como não lidas

Retorno

GmailApp: o serviço do Gmail, útil 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


markThreadImportant(thread)

Marca a linha de execução como importante e força a atualização dela.

// Marks first inbox thread as important
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadImportant(thread);

Parâmetros

NomeTipoDescrição
threadGmailThreada conversa para marcar como importante

Retorno

GmailApp: o serviço do Gmail, útil 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


markThreadRead(thread)

Marca a linha de execução como lida e força a atualização dela.

// Marks first inbox thread as read
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadRead(thread);

Parâmetros

NomeTipoDescrição
threadGmailThreada linha de execução a ser marcada como lida

Retorno

GmailApp: o serviço do Gmail, útil 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


markThreadUnimportant(thread)

Marca a conversa como não importante e força a atualização dela.

// Marks first inbox thread as unimportant
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnimportant(thread);

Parâmetros

NomeTipoDescrição
threadGmailThreadna conversa para marcar como não importante

Retorno

GmailApp: o serviço do Gmail, útil 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


markThreadUnread(thread)

Marca esta conversa como não lida e força a conversa a ser atualizada.

// Marks first inbox thread as unread
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnread(thread);

Parâmetros

NomeTipoDescrição
threadGmailThreada conversa a ser marcada como não lida

Retorno

GmailApp: o serviço do Gmail, útil 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


markThreadsImportant(threads)

Marca essas linhas de execução como importantes e força a atualização delas.

// Marks first two threads in inbox as important
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsImportant(threads);

Parâmetros

NomeTipoDescrição
threadsGmailThread[]uma matriz de linhas de execução para marcar como importante

Retorno

GmailApp: o serviço do Gmail, útil 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


markThreadsRead(threads)

Marca essas linhas de execução como lidas e força a atualização delas.

// Marks first two threads in inbox as read
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsRead(threads);

Parâmetros

NomeTipoDescrição
threadsGmailThread[]uma matriz de linhas de execução para marcar como lidas

Retorno

GmailApp: o serviço do Gmail, útil 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


markThreadsUnimportant(threads)

Marca essas conversas como não importantes e força a atualização delas.

// Marks first two threads in inbox as unimportant
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnimportant(threads);

Parâmetros

NomeTipoDescrição
threadsGmailThread[]uma matriz de linhas de execução para marcar como não importantes

Retorno

GmailApp: o serviço do Gmail, útil 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


markThreadsUnread(threads)

Marca essas conversas como não lidas e força a atualização delas.

// Marks first two threads in inbox as unread
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnread(threads);

Parâmetros

NomeTipoDescrição
threadsGmailThread[]uma matriz de conversas para marcar como não lidas

Retorno

GmailApp: o serviço do Gmail, útil 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


moveMessageToTrash(message)

Move a mensagem para a lixeira e força a atualização dela.

// Move the first message in your inbox to trash
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var firstMessage = firstThread.getMessages()[0];
GmailApp.moveMessageToTrash(firstMessage);

Parâmetros

NomeTipoDescrição
messageGmailMessagea mensagem para a lixeira

Retorno

GmailApp: o serviço do Gmail (útil 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


moveMessagesToTrash(messages)

Move as mensagens especificadas para a lixeira e força a atualização delas.

// Move first two messages in your inbox to trash
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var messages = firstThread.getMessages();
var toDelete = [messages[0], messages[1]];
GmailApp.moveMessagesToTrash(toDelete);

Parâmetros

NomeTipoDescrição
messagesGmailMessage[]as mensagens para a lixeira

Retorno

GmailApp: o serviço do Gmail (útil 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


moveThreadToArchive(thread)

Move a linha de execução para o arquivo e força a atualização dela.

// Archive the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
GmailApp.moveThreadToArchive(firstThread);

Parâmetros

NomeTipoDescrição
threadGmailThreada conversa a ser arquivada

Retorno

GmailApp: o serviço do Gmail, útil 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


moveThreadToInbox(thread)

Move a conversa para a caixa de entrada e força a atualização dela.

// Find a thread not already in your inbox
var thread = GmailApp.search("-in:inbox")[0]; // Get the first one
GmailApp.moveThreadToInbox(thread);

Parâmetros

NomeTipoDescrição
threadGmailThreada conversa seja movida para a caixa de entrada

Retorno

GmailApp: o serviço do Gmail, útil 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


moveThreadToSpam(thread)

Move esta conversa para "Spam" e força a atualização dela.

// Tag first thread in inbox as spam
var firstThread = GmailApp.getInboxThreads(0,1)[0];
GmailApp.moveThreadToSpam(firstThread);

Parâmetros

NomeTipoDescrição
threadGmailThreada conversa será movida para a caixa de spam

Retorno

GmailApp: o serviço do Gmail, útil 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


moveThreadToTrash(thread)

Move a linha de execução para a lixeira e força a atualização dela.

// Move first thread in inbox to trash
var firstThread = GmailApp.getInboxThreads(0,1)[0];
GmailApp.moveThreadToTrash(firstThread);

Parâmetros

NomeTipoDescrição
threadGmailThreada conversa que será movida para a lixeira

Retorno

GmailApp: o serviço do Gmail, útil 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


moveThreadsToArchive(threads)

Move essas linhas de execução para o arquivo e força a atualização delas.

// Move first two threads in your inbox to the archive
var firstTwoThreads = GmailApp.getInboxThreads(0,2);
GmailApp.moveThreadsToArchive(firstTwoThreads);

Parâmetros

NomeTipoDescrição
threadsGmailThread[]Uma matriz de linhas de execução a serem arquivadas

Retorno

GmailApp: o serviço do Gmail, útil 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


moveThreadsToInbox(threads)

Move essas conversas para a caixa de entrada e força a atualização delas.

// Find two threads not already in your inbox
var firstTwoThreads = GmailApp.search("-in:inbox", 0, 2);
GmailApp.moveThreadsToInbox(firstTwoThreads);

Parâmetros

NomeTipoDescrição
threadsGmailThread[]Uma matriz de conversas a serem movidas para a caixa de entrada

Retorno

GmailApp: o serviço do Gmail, útil 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


moveThreadsToSpam(threads)

Move essas conversas para "Spam" e força a atualização delas.

// Move first two threads in your inbox to spam
var firstTwoThreads = GmailApp.getInboxThreads(0,2);
GmailApp.moveThreadsToSpam(firstTwoThreads);

Parâmetros

NomeTipoDescrição
threadsGmailThread[]Uma matriz de conversas que serão movidas para a pasta "Spam"

Retorno

GmailApp: o serviço do Gmail, útil 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


moveThreadsToTrash(threads)

Move essas linhas de execução para a lixeira e força a atualização delas.

// Move first two threads in your inbox to trash
var firstTwoThreads = GmailApp.getInboxThreads(0,2);
GmailApp.moveThreadsToTrash(firstTwoThreads);

Parâmetros

NomeTipoDescrição
threadsGmailThread[]uma matriz de conversas a serem descartadas

Retorno

GmailApp: o serviço do Gmail, útil 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


refreshMessage(message)

Recarrega a mensagem e o estado associado do Gmail. Isso é útil caso os marcadores, o estado de leitura etc. tenham sido alterados.

var firstThread = GmailApp.getInboxThreads(0,1)[0];
var firstMessage = firstThread.getMessages()[0];
// ...Do something that may take a while here....
GmailApp.refreshMessage(firstMessage);
// ...Do more stuff with firstMessage...

Parâmetros

NomeTipoDescrição
messageGmailMessagea mensagem a ser atualizada

Retorno

GmailApp: o serviço do Gmail, útil 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


refreshMessages(messages)

Recarrega as mensagens e o estado associado do Gmail (útil caso os marcadores, o estado de leitura etc. tenham sido alterados).

var firstThread = GmailApp.getInboxThreads(0,1)[0];
var coupleOfMessages = firstThread.getMessages().slice(0, 2);
// ...Do something that may take a while here....
GmailApp.refreshMessages(coupleOfMessages);
// ...Do more stuff with coupleOfMessages...

Parâmetros

NomeTipoDescrição
messagesGmailMessage[]as mensagens a serem atualizadas

Retorno

GmailApp: o serviço do Gmail, útil 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


refreshThread(thread)

Recarrega a conversa e o estado associado do Gmail (útil caso os marcadores, o estado de leitura etc. tenham sido alterados).

var firstThread = GmailApp.getInboxThreads(0,1)[0];
// ...Do something that may take a while here....
GmailApp.refreshThread(firstThread);
// ... Do more stuff with the thread ...

Parâmetros

NomeTipoDescrição
threadGmailThreada linha de execução a ser atualizada

Retorno

GmailApp: o serviço do Gmail, útil 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


refreshThreads(threads)

Recarrega as linhas de execução e o estado associado do Gmail. Isso é útil caso os marcadores, o estado de leitura etc. tenham sido alterados.

var threads = GmailApp.getInboxThreads(0, 3);
// ...Do something that may take a while here....
GmailApp.refreshThreads(threads);
// ... Do more stuff with threads ...

Parâmetros

NomeTipoDescrição
threadsGmailThread[]as linhas de execução a serem atualizadas

Retorno

GmailApp: o serviço do Gmail, útil 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


search(query)

Pesquisar no Gmail com a consulta em questão.

Essa chamada vai falhar quando o tamanho de todas as linhas de execução for muito grande para o sistema processar. Quando o tamanho da linha de execução for desconhecido e possivelmente muito grande, use a chamada "paginada" e especifique os intervalos das linhas de execução a serem recuperadas em cada chamada.

// Find starred messages with subject IMPORTANT
var threads = GmailApp.search('is:starred subject:"IMPORTANT"');

Parâmetros

NomeTipoDescrição
queryStringa consulta de pesquisa, como você digitaria no Gmail

Retorno

GmailThread[]: uma matriz de conversas do Gmail que correspondem a essa consulta.

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/

search(query, start, max)

Pesquisar no Gmail com a consulta em questão.

// Find starred messages with subject IMPORTANT and return second batch of 10.
// Assumes there are at least 11 of them, otherwise this will return an empty array.
var threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);

Parâmetros

NomeTipoDescrição
queryStringa consulta de pesquisa, como você digitaria no Gmail
startIntegero índice da linha de execução inicial
maxIntegero número máximo de threads a serem retornados

Retorno

GmailThread[]: uma matriz de conversas do Gmail que correspondem a essa consulta.

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/

sendEmail(recipient, subject, body)

Envia uma mensagem de e-mail. O tamanho do e-mail (incluindo os cabeçalhos) é limitado por cota.

// The code below will send an email with the current date and time.
var now = new Date();
GmailApp.sendEmail("mike@example.com", "current time", "The time is: " + now.toString());

Parâmetros

NomeTipoDescrição
recipientStringlista de endereços de e-mail separados por vírgula
subjectStringassunto do e-mail (máximo de 250 caracteres)
bodyStringcorpo do e-mail

Retorno

GmailApp: o serviço do Gmail, útil 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


sendEmail(recipient, subject, body, options)

Envia uma mensagem de e-mail com argumentos opcionais. O e-mail pode conter texto simples ou um corpo HTML. O tamanho do e-mail (incluindo cabeçalhos, mas excluindo anexos) é limitado por cota.

// Send an email with a file from Google Drive attached as a PDF.
var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.sendEmail('mike@example.com', 'Attachment example', 'Please see the attached file.', {
    attachments: [file.getAs(MimeType.PDF)],
    name: 'Automatic Emailer Script'
});

Parâmetros

NomeTipoDescrição
recipientStringos endereços do destinatário
subjectStringna linha de assunto (máximo de 250 caracteres)
bodyStringo corpo do e-mail
optionsObjectum objeto JavaScript que especifica parâmetros avançados, conforme listado abaixo

Parâmetros avançados

NomeTipoDescrição
attachmentsBlobSource[]uma matriz de arquivos para enviar com o e-mail
bccStringuma lista de endereços de e-mail separados por vírgula em Cco
ccStringuma lista de endereços de e-mail separados por vírgulas para colocar em cópia
fromStringo endereço de origem do e-mail, que precisa ser um dos valores retornados por getAliases();
htmlBodyStringSe definido, os dispositivos capazes de renderizar HTML o usarão em vez do argumento obrigatório do corpo. Você pode adicionar um campo inlineImages opcional no corpo do HTML se tiver imagens inline do seu e-mail
inlineImagesObjectUm objeto JavaScript que contém um mapeamento da chave de imagem (String) para dados de imagem (BlobSource). Isso pressupõe que o parâmetro htmlBody é usado e contém referências a essas imagens no formato <img src="cid:imageKey" />
nameStringo nome do remetente do e-mail (padrão: o nome do usuário)
noReplyBooleantrue se o e-mail precisar ser enviado de um endereço genérico sem resposta para desencorajar os destinatários a responder aos e-mails. Essa opção só está disponível para contas do Google Workspace, não para usuários do Gmail
replyToStringUm endereço de e-mail para ser usado como o endereço para resposta padrão (padrão: o endereço de e-mail do usuário).

Retorno

GmailApp: o serviço do Gmail, útil 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


setCurrentMessageAccessToken(accessToken)

Define o token de acesso da mensagem atual que permite ao script acessar as propriedades GmailMessage atuais.

Apenas projetos de complementos do Google Workspace que usam escopos de mensagem atuais do Gmail exigem esse método.

function handleAddonActionEvent(e) {
  var accessToken = e.messageMetadata.accessToken;
  var messageId = e.messageMetadata.messageId;
  GmailApp.setCurrentMessageAccessToken(accessToken);
  var mailMessage = GmailApp.getMessageById(messageId);
  // Do something with mailMessage
}

Parâmetros

NomeTipoDescrição
accessTokenStringO token de acesso temporário recebido de um objeto de evento de ação do complemento do Gmail.

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/

starMessage(message)

Marca a mensagem com uma estrela e força a atualização dela.

// Stars the first message in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
GmailApp.starMessage(message);

Parâmetros

NomeTipoDescrição
messageGmailMessagea mensagem para marcar com estrela

Retorno

GmailApp: o serviço do Gmail, útil 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


starMessages(messages)

Adiciona estrelas a essas mensagens e força a atualização delas.

// Stars the first three messages in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.starMessages(coupleOfMessages);

Parâmetros

NomeTipoDescrição
messagesGmailMessage[]uma matriz de mensagens para marcar com estrela

Retorno

GmailApp: o serviço do Gmail, útil 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


unstarMessage(message)

Remove uma estrela da mensagem e força a atualização dela.

// Unstars the first message in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
GmailApp.unstarMessage(message);

Parâmetros

NomeTipoDescrição
messageGmailMessagea mensagem para remover a estrela

Retorno

GmailApp: o serviço do Gmail, útil 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


unstarMessages(messages)

Remove as estrelas dessas mensagens e força a atualização delas.

// Unstars the first three messages in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.unstarMessages(coupleOfMessages);

Parâmetros

NomeTipoDescrição
messagesGmailMessage[]uma matriz de mensagens para remover estrela

Retorno

GmailApp: o serviço do Gmail, útil 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

Métodos obsoletos