Class GmailApp

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.
GmailApp (link em inglês)

Concede acesso a conversas, mensagens e marcadores do Gmail.

Métodos

MétodoTipo de retornoBreve descrição
createDraft(recipient, subject, body)GmailDraftCria um e-mail de rascunho.
createDraft(recipient, subject, body, options)GmailDraftCria um e-mail de rascunho com argumentos opcionais.
createLabel(name)GmailLabelCrie um novo marcador de usuário com o nome fornecido.
deleteLabel(label)GmailAppExclui o rótulo especificado.
getAliases()String[]Recebe uma lista dos e-mails configurados como aliases para essa conta no Gmail.
getDraft(draftId)GmailDraftRecuperar um rascunho de mensagem de e-mail por ID.
getDraftMessages()GmailMessage[]Recupera todas as mensagens de rascunho.
getDrafts()GmailDraft[]Recebe todas as mensagens de rascunho do Gmail.
getInboxThreads()GmailThread[]Recupera todas as linhas de execução da caixa de entrada, independentemente dos marcadores.
getInboxThreads(start, max)GmailThread[]Recupera um intervalo de linhas de execução da caixa de entrada, independentemente dos marcadores.
getInboxUnreadCount()IntegerRecebe o número de conversas não lidas na caixa de entrada.
getMessageById(id)GmailMessageRecebe uma mensagem por ID.
getMessagesForThread(thread)GmailMessage[]Recuperar todas as mensagens da conversa especificada.
getMessagesForThreads(threads)GmailMessage[][]Recuperar todas as mensagens das conversas especificadas.
getPriorityInboxThreads()GmailThread[]Recupera todas as linhas de execução da Caixa prioritária, independentemente dos marcadores.
getPriorityInboxThreads(start, max)GmailThread[]Recupera um intervalo de conversas da Caixa prioritária, independentemente dos marcadores.
getPriorityInboxUnreadCount()IntegerRecebe o número de conversas não lidas na Caixa de entrada prioritária.
getSpamThreads()GmailThread[]Recupera todas as conversas de spam, independentemente dos rótulos.
getSpamThreads(start, max)GmailThread[]Recupera um intervalo de conversas de spam independentemente dos marcadores.
getSpamUnreadCount()IntegerRecebe o número de conversas não lidas que são spam.
getStarredThreads()GmailThread[]Recupera todas as linhas de execução com estrela, independentemente dos rótulos.
getStarredThreads(start, max)GmailThread[]Recupera um intervalo de linhas de execução com estrela, independentemente dos rótulos.
getStarredUnreadCount()IntegerRecebe o número de conversas não lidas com estrela.
getThreadById(id)GmailThreadRecebe uma linha de execução por ID.
getTrashThreads()GmailThread[]Recupera todas as linhas de execução da lixeira, independentemente dos marcadores.
getTrashThreads(start, max)GmailThread[]Recupera um intervalo de conversas da lixeira, independentemente dos rótulos.
getUserLabelByName(name)GmailLabelRecupera o rótulo com base no nome dele.
getUserLabels()GmailLabel[]Recupera uma lista de rótulos criados pelo usuário.
markMessageRead(message)GmailAppMarca esta mensagem como lida e força a atualização da mensagem.
markMessageUnread(message)GmailAppMarca esta mensagem como não lida e força a atualização da mensagem.
markMessagesRead(messages)GmailAppMarca estas mensagens como lidas e força a atualização delas.
markMessagesUnread(messages)GmailAppMarca estas mensagens como não lidas e força a atualização delas.
markThreadImportant(thread)GmailAppMarca esta conversa como importante e força a atualização.
markThreadRead(thread)GmailAppMarca esta conversa como lida e força a atualização.
markThreadUnimportant(thread)GmailAppMarca esta conversa como não importante e força a atualização.
markThreadUnread(thread)GmailAppMarca a conversa como não lida e força a atualização.
markThreadsImportant(threads)GmailAppMarca as conversas como importantes e força as atualizações.
markThreadsRead(threads)GmailAppMarca as linhas de execução como lidas e força a atualização delas.
markThreadsUnimportant(threads)GmailAppMarca as linhas de execução como não importantes e força as atualizações.
markThreadsUnread(threads)GmailAppMarca as conversas como não lidas e força as atualizações.
moveMessageToTrash(message)GmailAppMove a mensagem para a lixeira e força a atualização.
moveMessagesToTrash(messages)GmailAppMove as mensagens especificadas para a lixeira e as força a serem atualizadas.
moveThreadToArchive(thread)GmailAppMove essa linha de execução para o arquivo e força a atualização.
moveThreadToInbox(thread)GmailAppMove essa linha de execução para a Caixa de entrada e força a atualização.
moveThreadToSpam(thread)GmailAppMove essa linha de execução para spam e força a atualização a ela.
moveThreadToTrash(thread)GmailAppMove essa linha para a lixeira e força a atualização.
moveThreadsToArchive(threads)GmailAppMove as linhas de execução para o arquivo e as força a serem atualizadas.
moveThreadsToInbox(threads)GmailAppmove as linhas de execução para a caixa de entrada e as força a serem atualizadas.
moveThreadsToSpam(threads)GmailAppmove as conversas para a pasta "Spam" e as força a serem atualizadas;
moveThreadsToTrash(threads)GmailAppmove as conversas para a lixeira e as força a atualizar.
refreshMessage(message)GmailAppRecarrega a mensagem e o estado associado pelo Gmail (útil se os marcadores, o estado de leitura etc. tiverem mudado).
refreshMessages(messages)GmailAppRecarrega as mensagens e o estado associado pelo Gmail (útil caso os marcadores, o estado de leitura etc. tenham mudado).
refreshThread(thread)GmailAppRecarrega a linha de execução e o estado associado a partir do Gmail (útil caso os marcadores, o estado de leitura etc. tenham mudado).
refreshThreads(threads)GmailAppRecarrega as linhas de execução e o estado associado pelo Gmail (útil caso os rótulos, o estado de leitura etc. tenham mudado).
search(query)GmailThread[]Pesquise no Gmail a consulta fornecida.
search(query, start, max)GmailThread[]Pesquise no Gmail a consulta fornecida.
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 de mensagem atual que permite que o script acesse as propriedades atuais de GmailMessage.
starMessage(message)GmailAppAdiciona uma estrela a esta mensagem e força a mensagem a ser atualizada.
starMessages(messages)GmailAppAdiciona estrelas a essas mensagens e força as mensagens a serem atualizadas.
unstarMessage(message)GmailAppRemove uma estrela desta mensagem e força a mensagem a ser atualizada.
unstarMessages(messages)GmailAppRemove as estrelas dessas mensagens e força as atualizações.

Documentação detalhada

createDraft(recipient, subject, body)

Cria um e-mail de rascunho. O tamanho do e-mail (incluindo cabeçalhos) é limitado pela 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írgulas
subjectStringassunto do e-mail
bodyStringcorpo do e-mail

Retornar

GmailDraft: o GmailRascunho 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 e-mail de rascunho 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 à 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.
subjectStringa linha 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 a serem enviados com o e-mail
bccStringUma lista separada por vírgulas de endereços de e-mail para Cco
ccStringuma lista de endereços de e-mail separados por vírgulas para Cc
fromStringO endereço do qual o e-mail deve ser enviado, que precisa ser um dos valores retornados por getAliases().
htmlBodyStringSe definida, os dispositivos capazes de renderizar o HTML o usarão em vez do argumento do corpo necessário. Você poderá adicionar um campo inlineImages opcional no corpo do HTML se tiver imagens in-line para seu e-mail
inlineImagesObjectum objeto JavaScript que contém um mapeamento da chave de imagem (String) para os 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 usar como endereço de resposta padrão (padrão: o endereço de e-mail do usuário)

Retornar

GmailDraft: o GmailRascunho 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)

Crie um novo marcador de usuário com o nome fornecido.

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

Parâmetros

NomeTipoDescrição
nameStringo nome do novo rótulo

Retornar

GmailLabel: o marcador 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 marcador a ser excluído

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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

Recebe uma lista dos e-mails configurados como aliases para essa conta no Gmail.

Você pode enviar uma mensagem a partir 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.');
}

Retornar

String[]: uma matriz de aliases para esta 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 por ID.

Use isso em conjunto com getId() em 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

Retornar

GmailDraft: o rascunho com o código 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 todas as mensagens de rascunho.

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

Retornar

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 todas as mensagens de rascunho do Gmail.

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

Retornar

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 linhas de execução da caixa de entrada, independentemente dos marcadores.

A chamada 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 'paged' e especifique intervalos de 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());
}

Retornar

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

Retornar

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

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

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

Retornar

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

getMessageById(id)

Recebe uma mensagem por ID.

Use isso em conjunto com getId() em 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
idStringID da mensagem a ser recuperada

Retornar

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)

Recuperar todas as mensagens da 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

Retornar

GmailMessage[]: matriz de mensagens correspondentes a esta conversa

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)

Recuperar todas as mensagens das 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[]as conversas das mensagens a serem recuperadas;

Retornar

GmailMessage[][]: uma matriz de mensagens de mensagens em que cada item na matriz externa corresponde a uma linha de execução e a matriz interna contém as mensagens nessa 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 linhas de execução da Caixa prioritária, independentemente dos marcadores.

A chamada 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 'paged' e especifique intervalos de linhas de execução a serem recuperadas em cada chamada.

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

Retornar

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 linhas de execução a serem recuperadas

Retornar

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

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

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

Retornar

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

getSpamThreads()

Recupera todas as conversas de spam, independentemente dos rótulos.

A chamada 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 'paged' e especifique intervalos de linhas de execução a serem recuperadas em cada chamada.

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

Retornar

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

Retornar

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

Recebe 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());

Retornar

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

getStarredThreads()

Recupera todas as linhas de execução com estrela, independentemente dos rótulos.

A chamada 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 'paged' e especifique intervalos de linhas de execução a serem recuperadas em cada chamada.

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

Retornar

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

Retornar

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

Recebe o número de conversas não lidas com estrela.

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

Retornar

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 isso em conjunto com getId() em conversas do Gmail.

// Thread IDs can also be found in the location bar when you have a thread open in Gmail
// get first inbox thread
var firstThread = GmailApp.getInboxThreads(0,1)[0];
// Get the same thread by ID
var threadById = GmailApp.getThreadById(firstThread.getId());
// Verify they are the same
Logger.log(firstThread.getFirstMessageSubject() == threadById.getFirstMessageSubject());

Parâmetros

NomeTipoDescrição
idStringID da linha de execução a ser recuperada

Retornar

GmailThread: a linha de execução com o ID fornecido ou nulo se não 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/

Veja também


getTrashThreads()

Recupera todas as linhas de execução da lixeira, independentemente dos marcadores.

A chamada 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 'paged' e especifique intervalos de linhas de execução a serem recuperadas em cada chamada.

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

Retornar

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 conversas da 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 linhas de execução a serem recuperadas

Retornar

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 o rótulo com base no nome dele.

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

Parâmetros

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

Retornar

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());
}

Retornar

GmailLabel[]: matriz de marcadores 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 esta mensagem como lida e força a atualização da mensagem.

// 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

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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 da mensagem.

// 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

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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 estas 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[]Matriz de mensagens a serem marcadas como lidas.

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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 estas 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[]Matriz de mensagens a serem marcadas como não lidas.

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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 esta conversa como importante e força a atualização.

// 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

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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 esta conversa como lida e força a atualização.

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

Parâmetros

NomeTipoDescrição
threadGmailThreada conversa a ser marcada como lida

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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 esta conversa como não importante e força a atualização.

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

Parâmetros

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

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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 a conversa como não lida e força a atualização.

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

Parâmetros

NomeTipoDescrição
threadGmailThreada conversa para marcar como não lida

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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 as conversas como importantes e força as atualizações.

// 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 conversas para marcar como importante

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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 as 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 conversas para marcar como lida

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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 as linhas de execução como não importantes e força as atualizações.

// 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 conversas para marcar como não importantes

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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 as conversas como não lidas e força as atualizações.

// 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

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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.

// 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 a ser movida para a lixeira

Retornar

GmailApp: o serviço do Gmail (útil para encadeamentos)

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 as força a serem atualizadas.

// 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 na lixeira

Retornar

GmailApp: o serviço do Gmail (útil para encadeamentos)

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 essa linha de execução para o arquivo e força a atualização.

// 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

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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 essa linha de execução para a Caixa de entrada e força a atualização.

// 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 que será movida para a Caixa de entrada

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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 essa linha de execução para spam e força a atualização a ela.

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

Parâmetros

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

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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 essa linha para a lixeira e força a atualização.

// 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

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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 as linhas de execução para o arquivo e as força a serem atualizadas.

// 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 conversas a ser arquivada

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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 as linhas de execução para a caixa de entrada e as força a serem atualizadas.

// 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 ser movida para a Caixa de entrada

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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 as conversas para a pasta "Spam" e as força a serem atualizadas;

// 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 a ser movida para a pasta "Spam"

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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 as conversas para a lixeira e as força a atualizar.

// 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 ser movida para a lixeira

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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 pelo Gmail (útil se os marcadores, o estado de leitura etc. tiverem mudado).

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

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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 pelo Gmail (útil caso os marcadores, o estado de leitura etc. tenham mudado).

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

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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 linha de execução e o estado associado a partir do Gmail (útil caso os marcadores, o estado de leitura etc. tenham mudado).

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 conversa a ser atualizada

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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 pelo Gmail (útil caso os rótulos, o estado de leitura etc. tenham mudado).

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 conversas a serem atualizadas

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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)

Pesquise no Gmail a consulta fornecida.

A chamada 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 'paged' e especifique intervalos de 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ê a digitaria no Gmail

Retornar

GmailThread[]: uma matriz de conversas do Gmail correspondentes a esta 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)

Pesquise no Gmail a consulta fornecida.

// 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ê a digitaria no Gmail
startIntegero índice da linha de execução inicial
maxIntegero número máximo de linhas de execução a serem retornadas

Retornar

GmailThread[]: uma matriz de conversas do Gmail correspondentes a esta 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 cabeçalhos) é limitado pela 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írgulas
subjectStringassunto do e-mail (máximo de 250 caracteres)
bodyStringcorpo do e-mail

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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 à 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.
subjectStringa 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 a serem enviados com o e-mail
bccStringUma lista separada por vírgulas de endereços de e-mail para Cco
ccStringuma lista de endereços de e-mail separados por vírgulas para Cc
fromStringO endereço do qual o e-mail deve ser enviado, que precisa ser um dos valores retornados por getAliases().
htmlBodyStringSe definida, os dispositivos capazes de renderizar o HTML o usarão em vez do argumento do corpo necessário. Você poderá adicionar um campo inlineImages opcional no corpo do HTML se tiver imagens in-line para seu e-mail
inlineImagesObjectum objeto JavaScript que contém um mapeamento da chave de imagem (String) para os 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 for enviado de um endereço genérico sem resposta para desencorajar os destinatários a responder aos e-mails. Essa opção só é possível para contas do Google Workspace, e não usuários do Gmail
replyToStringUm endereço de e-mail para usar como endereço de resposta padrão (padrão: o endereço de e-mail do usuário)

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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 de mensagem atual que permite que o script acesse as propriedades atuais de GmailMessage.

Apenas os projetos dos Complementos do Google Workspace que usam escopos de mensagens 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 eventos de ação dos complementos 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)

Adiciona uma estrela a esta mensagem e força a mensagem a ser atualizada.

// 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

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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 as mensagens a serem atualizadas.

// 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 a serem marcadas com estrela

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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 desta mensagem e força a mensagem a ser atualizada.

// 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
messageGmailMessageremover mensagem da estrela

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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 as atualizações.

// 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

Retornar

GmailApp: o serviço do Gmail, útil para encadeamentos

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