Class GmailApp

AppGmail

Fornece acesso a conversas, mensagens e marcadores do Gmail.

Métodos

Método	Tipo de retorno	Breve descrição
createDraft(recipient, subject, body)	GmailDraft	Cria uma mensagem de e-mail em rascunho.
createDraft(recipient, subject, body, options)	GmailDraft	Cria uma mensagem de e-mail em rascunho com argumentos opcionais.
createLabel(name)	GmailLabel	Cria um novo marcador de usuário com o nome especificado.
deleteLabel(label)	GmailApp	Exclui o marcador especificado.
getAliases()	String[]	Recebe uma lista dos e-mails configurados como aliases para essa conta no Gmail.
getDraft(draftId)	GmailDraft	Recupera um rascunho de mensagem de e-mail por ID.
getDraftMessages()	GmailMessage[]	Recupera todas as mensagens em rascunho.
getDrafts()	GmailDraft[]	Recebe todas as mensagens de rascunho do Gmail.
getInboxThreads()	GmailThread[]	Recupera todas as conversas do Inbox, independente dos rótulos.
getInboxThreads(start, max)	GmailThread[]	Recupera um intervalo de conversas da Caixa de entrada, independente dos marcadores.
getInboxUnreadCount()	Integer	Recebe o número de conversas não lidas na caixa de entrada.
getMessageById(id)	GmailMessage	Recebe uma mensagem por 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 de entrada prioritária, independente dos marcadores.
getPriorityInboxThreads(start, max)	GmailThread[]	Recupera um intervalo de conversas da Caixa prioritária, independente dos marcadores.
getPriorityInboxUnreadCount()	Integer	Recebe o número de conversas não lidas na Caixa prioritária.
getSpamThreads()	GmailThread[]	Recupera todas as conversas de spam, independente dos marcadores.
getSpamThreads(start, max)	GmailThread[]	Recupera um intervalo de conversas de spam, independente dos rótulos.
getSpamUnreadCount()	Integer	Recebe o número de conversas não lidas que são spam.
getStarredThreads()	GmailThread[]	Recupera todas as conversas marcadas com estrela, independente dos rótulos.
getStarredThreads(start, max)	GmailThread[]	Recupera um intervalo de conversas marcadas com estrela, independente dos marcadores.
getStarredUnreadCount()	Integer	Recebe o número de conversas não lidas marcadas com estrela.
getThreadById(id)	GmailThread|null	Recebe uma conversa por ID.
getTrashThreads()	GmailThread[]	Recupera todas as conversas da lixeira, independente dos rótulos.
getTrashThreads(start, max)	GmailThread[]	Recupera um intervalo de conversas da lixeira, independente dos marcadores.
getUserLabelByName(name)	GmailLabel	Recupera um marcador com base no nome dele.
getUserLabels()	GmailLabel[]	Recupera uma lista de rótulos criados pelo usuário.
markMessageRead(message)	GmailApp	Marca a mensagem como lida e força a atualização dela.
markMessageUnread(message)	GmailApp	Marca a mensagem como não lida e força a atualização dela.
markMessagesRead(messages)	GmailApp	Marca essas mensagens como lidas e força a atualização delas.
markMessagesUnread(messages)	GmailApp	Marca essas mensagens como não lidas e força a atualização delas.
markThreadImportant(thread)	GmailApp	Marca esta conversa como importante e força a atualização dela.
markThreadRead(thread)	GmailApp	Marca esta conversa como lida e força a atualização dela.
markThreadUnimportant(thread)	GmailApp	Marca esta conversa como não importante e força a atualização dela.
markThreadUnread(thread)	GmailApp	Marca esta conversa como não lida e força a atualização dela.
markThreadsImportant(threads)	GmailApp	Marca essas conversas como importantes e força a atualização delas.
markThreadsRead(threads)	GmailApp	Marca essas conversas como lidas e força a atualização delas.
markThreadsUnimportant(threads)	GmailApp	Marca essas conversas como não importantes e força a atualização delas.
markThreadsUnread(threads)	GmailApp	Marca essas conversas como não lidas e força a atualização delas.
moveMessageToTrash(message)	GmailApp	Move a mensagem para a lixeira e força a atualização dela.
moveMessagesToTrash(messages)	GmailApp	Move as mensagens especificadas para a lixeira e força a atualização delas.
moveThreadToArchive(thread)	GmailApp	Move esta conversa para o arquivo e força a atualização dela.
moveThreadToInbox(thread)	GmailApp	Move a conversa para a caixa de entrada e força a atualização dela.
moveThreadToSpam(thread)	GmailApp	Move esta conversa para o spam e força a atualização dela.
moveThreadToTrash(thread)	GmailApp	Move a conversa para a lixeira e força a atualização dela.
moveThreadsToArchive(threads)	GmailApp	Move essas conversas para o arquivo e força a atualização delas.
moveThreadsToInbox(threads)	GmailApp	Move essas conversas para a caixa de entrada e força a atualização delas.
moveThreadsToSpam(threads)	GmailApp	Move essas conversas para o spam e força a atualização delas.
moveThreadsToTrash(threads)	GmailApp	Move essas conversas para a lixeira e força a atualização delas.
refreshMessage(message)	GmailApp	Recarrega a mensagem e o estado associado do Gmail. Isso é útil caso os rótulos, o estado de leitura etc. tenham mudado.
refreshMessages(messages)	GmailApp	Recarrega as mensagens e o estado associado do Gmail. Isso é útil caso os rótulos, o estado de leitura etc. tenham mudado.
refreshThread(thread)	GmailApp	Recarrega a conversa e o estado associado do Gmail. Isso é útil caso os rótulos, o estado de leitura etc. tenham mudado.
refreshThreads(threads)	GmailApp	Recarrega as conversas e o estado associado do Gmail. Isso é útil caso os rótulos, o estado de leitura etc. tenham mudado.
search(query)	GmailThread[]	Pesquise no Gmail com a consulta especificada.
search(query, start, max)	GmailThread[]	Pesquise no Gmail com a consulta especificada.
sendEmail(recipient, subject, body)	GmailApp	Envia uma mensagem de e-mail.
sendEmail(recipient, subject, body, options)	GmailApp	Envia uma mensagem de e-mail com argumentos opcionais.
setCurrentMessageAccessToken(accessToken)	void	Define o token de acesso da mensagem atual que permite ao script acessar as propriedades GmailMessage atuais.
starMessage(message)	GmailApp	Adiciona uma estrela à mensagem e força a atualização dela.
starMessages(messages)	GmailApp	Adiciona estrelas a essas mensagens e força a atualização delas.
unstarMessage(message)	GmailApp	Remove uma estrela da mensagem e força a atualização dela.
unstarMessages(messages)	GmailApp	Remove as estrelas dessas mensagens e força a atualização delas.

Métodos obsoletos

Método	Tipo de retorno	Breve descrição
getChatThreads()	GmailThread[]	Recebe todas as conversas do Google Hangouts clássico e do Google Chat até que o Google mude todos os usuários do Hangouts clássico para o Chat ainda este ano.
getChatThreads(start, max)	GmailThread[]	Recebe um intervalo de conversas do Google Hangouts clássico e do Google Chat até que o Google mude todos os usuários do Hangouts clássico para o Chat ainda este ano.

Documentação detalhada

createDraft(recipient, subject, body)

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

// The code below creates a draft email with the current date and time.
const now = new Date();
GmailApp.createDraft(
    '[e-mail]',
    'current time',
    `The time is: ${now.toString()}`,
);

Parâmetros

Nome	Tipo	Descrição
recipient	String	lista de endereços de e-mail separados por vírgulas
subject	String	assunto do e-mail
body	String	corpo do e-mail

Retornar

GmailDraft: o GmailDraft 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/

Consulte também

• createDraft(recipient, subject, body, options)

---

createDraft(recipient, subject, body, options)

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

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

Parâmetros

Nome	Tipo	Descrição
recipient	String	os endereços do destinatário
subject	String	a linha de assunto
body	String	o corpo do e-mail
options	Object	um objeto JavaScript que especifica parâmetros avançados, conforme listado abaixo

Parâmetros avançados

Nome	Tipo	Descrição
attachments	BlobSource[]	uma matriz de arquivos para enviar com o e-mail
bcc	String	uma lista separada por vírgulas de endereços de e-mail para CCO
cc	String	uma lista separada por vírgulas de endereços de e-mail para incluir em Cc
from	String	o endereço de e-mail de envio, que precisa ser um dos valores retornados por getAliases()
htmlBody	String	se definido, os dispositivos capazes de renderizar HTML vão usá-lo em vez do argumento de corpo obrigatório. Você pode adicionar um campo inlineImages opcional no corpo HTML se tiver imagens inline no e-mail.
inlineImages	Object	um objeto JavaScript que contém um mapeamento da chave da imagem (String) para os dados da imagem (BlobSource). Isso pressupõe que o parâmetro htmlBody seja usado e contenha referências a essas imagens no formato <img src="cid:imageKey" />.
name	String	o nome do remetente do e-mail (padrão: o nome do usuário)
replyTo	String	um endereço de e-mail para usar como o endereço para resposta padrão (padrão: o endereço de e-mail do usuário)

Retornar

GmailDraft: o GmailDraft 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/

Consulte também

• createDraft(recipient, subject, body)

---

createLabel(name)

Cria um novo marcador de usuário com o nome especificado.

// Creates the label @FOO and logs label: FOO
Logger.log(`label: ${GmailApp.createLabel('FOO')}`);

Parâmetros

Nome	Tipo	Descrição
name	String	o nome do novo marcador

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/

Consulte também

• deleteLabel(label)

---

deleteLabel(label)

Exclui o marcador especificado.

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

Parâmetros

Nome	Tipo	Descrição
label	GmailLabel	o marcador a ser excluído

Retornar

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/

Consulte também

• createLabel(name)

---

getAliases()

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

Você pode 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.
const me = Session.getActiveUser().getEmail();
const 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/

Consulte também

• sendEmail(recipient, subject, body, options)

---

getDraft(draftId)

Recupera um rascunho de mensagem de e-mail por ID.

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

// Get the first draft message in your drafts folder
const draft = GmailApp.getDrafts()[0];
// Get its ID
const draftId = draft.getId();
// Now fetch the same draft using that ID.
const 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

Nome	Tipo	Descrição
draftId	String	o ID do rascunho a ser recuperado

Retornar

GmailDraft: o rascunho com o ID especificado

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 em rascunho.

// Logs the number of draft messages
const 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.

const drafts = GmailApp.getDrafts();
for (let 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 conversas do Inbox, independente 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 conversa for desconhecido e potencialmente muito grande, use a chamada "paginada" e especifique intervalos das conversas a serem recuperadas em cada chamada.

// Log the subject lines of your Inbox
const threads = GmailApp.getInboxThreads();
for (let 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 conversas da Caixa de entrada, independente dos marcadores.

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

Parâmetros

Nome	Tipo	Descrição
start	Integer	o índice da primeira conversa a ser recuperada
max	Integer	o número máximo de encadeamentos a serem recuperados

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 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 por ID.

Use isso em conjunto com getId() em mensagens do Gmail.

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

Parâmetros

Nome	Tipo	Descrição
id	String	o ID da mensagem a ser recuperada

Retornar

GmailMessage: a mensagem com o ID especificado

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/

Consulte também

• getThreadById(id)

---

getMessagesForThread(thread)

Recupera todas as mensagens na conversa especificada.

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

Parâmetros

Nome	Tipo	Descrição
thread	GmailThread	a conversa de mensagens a ser recuperada

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/

Consulte também

• getMessagesForThreads(threads)

---

getMessagesForThreads(threads)

Recupera todas as mensagens nas conversas especificadas.

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

Parâmetros

Nome	Tipo	Descrição
threads	GmailThread[]	as linhas de execução de mensagens a serem recuperadas

Retornar

GmailMessage[][]: uma matriz de matrizes de mensagens, em que cada item na matriz externa corresponde a uma conversa, e a matriz interna contém as mensagens dessa 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/

Consulte também

• getMessagesForThread(thread)

---

getPriorityInboxThreads()

Recupera todas as conversas da caixa de entrada prioritária, independente 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 conversa for desconhecido e potencialmente muito grande, use a chamada "paginada" e especifique intervalos das conversas 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, independente dos marcadores.

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

Parâmetros

Nome	Tipo	Descrição
start	Integer	o índice da primeira conversa a ser recuperada
max	Integer	o número máximo de encadeamentos a serem recuperados

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 prioritária.

Logger.log(
    `Number of unread emails in your Priority Inbox : ${
        GmailApp.getPriorityInboxUnreadCount()}`,
);

Retornar

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, independente 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 conversa for desconhecido e potencialmente muito grande, use a chamada "paginada" e especifique intervalos das conversas 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, independente dos rótulos.

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

Parâmetros

Nome	Tipo	Descrição
start	Integer	o índice da primeira conversa a ser recuperada
max	Integer	o número máximo de encadeamentos a serem recuperados

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 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 marcadas com estrela, independente 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 conversa for desconhecido e potencialmente muito grande, use a chamada "paginada" e especifique intervalos das conversas 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 marcadas com estrela 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/

---

getStarredThreads(start, max)

Recupera um intervalo de conversas marcadas com estrela, independente dos marcadores.

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

Parâmetros

Nome	Tipo	Descrição
start	Integer	o índice da primeira conversa a ser recuperada
max	Integer	o número máximo de encadeamentos a serem recuperados

Retornar

GmailThread[]: uma matriz de conversas marcadas com estrela 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/

---

getStarredUnreadCount()

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

Logger.log(`# unread and starred: ${GmailApp.getStarredUnreadCount()}`);

Retornar

Integer: o número de conversas marcadas 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 conversa por ID.

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

Nome	Tipo	Descrição
id	String	O ID da conversa a ser recuperada.

Retornar

GmailThread|null: a conversa 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/

Consulte também

• getMessageById(id)

---

getTrashThreads()

Recupera todas as conversas da lixeira, independente 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 conversa for desconhecido e potencialmente muito grande, use a chamada "paginada" e especifique intervalos das conversas 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, independente dos marcadores.

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

Parâmetros

Nome	Tipo	Descrição
start	Integer	o índice da primeira conversa a ser recuperada
max	Integer	o número máximo de encadeamentos a serem recuperados

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 um marcador com base no nome dele.

const labelObject = GmailApp.getUserLabelByName('myLabel');

Parâmetros

Nome	Tipo	Descrição
name	String	o nome do rótulo a ser recuperado

Retornar

GmailLabel: o marcador do Gmail com o nome informado

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
const labels = GmailApp.getUserLabels();
for (let i = 0; i < labels.length; i++) {
  Logger.log(`label: ${labels[i].getName()}`);
}

Retornar

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
const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageRead(message);

Parâmetros

Nome	Tipo	Descrição
message	GmailMessage	a mensagem a ser marcada como lida

Retornar

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/

Consulte também

• markMessageUnread(message)

---

markMessageUnread(message)

Marca a 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
const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageUnread(message);

Parâmetros

Nome	Tipo	Descrição
message	GmailMessage	a mensagem a ser marcada como não lida

Retornar

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/

Consulte também

• markMessageRead(message)

---

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.
const threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
const messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesRead(messages);

Parâmetros

Nome	Tipo	Descrição
messages	GmailMessage[]	uma matriz de mensagens a serem marcadas como lidas

Retornar

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/

Consulte também

• markMessagesUnread(messages)

---

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
const threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
const messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesUnread(messages);

Parâmetros

Nome	Tipo	Descrição
messages	GmailMessage[]	uma matriz de mensagens para marcar como não lidas

Retornar

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/

Consulte também

• markMessagesRead(messages)

---

markThreadImportant(thread)

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

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

Parâmetros

Nome	Tipo	Descrição
thread	GmailThread	a conversa para marcar como importante

Retornar

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/

Consulte também

• markThreadUnimportant(thread)

---

markThreadRead(thread)

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

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

Parâmetros

Nome	Tipo	Descrição
thread	GmailThread	a conversa a ser marcada como lida

Retornar

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/

Consulte também

• markThreadUnread(thread)

---

markThreadUnimportant(thread)

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

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

Parâmetros

Nome	Tipo	Descrição
thread	GmailThread	a conversa para marcar como não importante

Retornar

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/

Consulte também

• markThreadImportant(thread)

---

markThreadUnread(thread)

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

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

Parâmetros

Nome	Tipo	Descrição
thread	GmailThread	a conversa para marcar como não lida

Retornar

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/

Consulte também

• markThreadRead(thread)

---

markThreadsImportant(threads)

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

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

Parâmetros

Nome	Tipo	Descrição
threads	GmailThread[]	Uma matriz de conversas para marcar como importantes

Retornar

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/

Consulte também

• markThreadsUnimportant(threads)

---

markThreadsRead(threads)

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

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

Parâmetros

Nome	Tipo	Descrição
threads	GmailThread[]	Uma matriz de conversas a serem marcadas como lidas.

Retornar

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/

Consulte também

• markThreadsUnread(threads)

---

markThreadsUnimportant(threads)

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

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

Parâmetros

Nome	Tipo	Descrição
threads	GmailThread[]	Uma matriz de conversas para marcar como não importantes.

Retornar

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/

Consulte também

• markThreadsImportant(threads)

---

markThreadsUnread(threads)

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

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

Parâmetros

Nome	Tipo	Descrição
threads	GmailThread[]	Uma matriz de conversas a serem marcadas como não lidas.

Retornar

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/

Consulte também

• markThreadsRead(threads)

---

moveMessageToTrash(message)

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

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

Parâmetros

Nome	Tipo	Descrição
message	GmailMessage	a mensagem a ser movida para a lixeira

Retornar

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/

Consulte também

• moveMessagesToTrash(messages)

---

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
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const messages = firstThread.getMessages();
const toDelete = [messages[0], messages[1]];
GmailApp.moveMessagesToTrash(toDelete);

Parâmetros

Nome	Tipo	Descrição
messages	GmailMessage[]	as mensagens a serem movidas para a lixeira

Retornar

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/

Consulte também

• moveMessageToTrash(message)

---

moveThreadToArchive(thread)

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

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

Parâmetros

Nome	Tipo	Descrição
thread	GmailThread	a conversa a ser arquivada

Retornar

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/

Consulte também

• moveThreadToInbox(thread)
• moveThreadToSpam(thread)
• moveThreadToTrash(thread)

---

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
const thread = GmailApp.search('-in:inbox')[0];  // Get the first one
GmailApp.moveThreadToInbox(thread);

Parâmetros

Nome	Tipo	Descrição
thread	GmailThread	a conversa a ser movida para a caixa de entrada

Retornar

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/

Consulte também

• moveThreadToTrash(thread)
• moveThreadToSpam(thread)
• moveThreadToArchive(thread)

---

moveThreadToSpam(thread)

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

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

Parâmetros

Nome	Tipo	Descrição
thread	GmailThread	a conversa a ser movida para spam

Retornar

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/

Consulte também

• moveThreadToTrash(thread)
• moveThreadToInbox(thread)
• moveThreadToArchive(thread)

---

moveThreadToTrash(thread)

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

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

Parâmetros

Nome	Tipo	Descrição
thread	GmailThread	a conversa a ser movida para a lixeira

Retornar

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/

Consulte também

• moveThreadToInbox(thread)
• moveThreadToSpam(thread)
• moveThreadToArchive(thread)

---

moveThreadsToArchive(threads)

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

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

Parâmetros

Nome	Tipo	Descrição
threads	GmailThread[]	uma matriz de conversas a serem arquivadas

Retornar

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/

Consulte também

• moveThreadsToInbox(threads)
• moveThreadsToSpam(threads)
• moveThreadsToTrash(threads)

---

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
const firstTwoThreads = GmailApp.search('-in:inbox', 0, 2);
GmailApp.moveThreadsToInbox(firstTwoThreads);

Parâmetros

Nome	Tipo	Descrição
threads	GmailThread[]	uma matriz de conversas a serem movidas para a caixa de entrada

Retornar

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/

Consulte também

• moveThreadsToTrash(threads)
• moveThreadsToSpam(threads)
• moveThreadsToArchive(threads)

---

moveThreadsToSpam(threads)

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

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

Parâmetros

Nome	Tipo	Descrição
threads	GmailThread[]	uma matriz de conversas a serem movidas para o spam

Retornar

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/

Consulte também

• moveThreadsToInbox(threads)
• moveThreadsToTrash(threads)
• moveThreadsToArchive(threads)

---

moveThreadsToTrash(threads)

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

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

Parâmetros

Nome	Tipo	Descrição
threads	GmailThread[]	uma matriz de conversas a serem movidas para a lixeira

Retornar

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/

Consulte também

• moveThreadsToInbox(threads)
• moveThreadsToSpam(threads)
• moveThreadsToArchive(threads)

---

refreshMessage(message)

Recarrega a mensagem e o estado associado do Gmail. Isso é útil caso os rótulos, o estado de leitura etc. tenham mudado.

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

Parâmetros

Nome	Tipo	Descrição
message	GmailMessage	a mensagem a ser atualizada

Retornar

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/

Consulte também

• refreshMessages(messages)

---

refreshMessages(messages)

Recarrega as mensagens e o estado associado do Gmail. Isso é útil caso os rótulos, o estado de leitura etc. tenham mudado.

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

Parâmetros

Nome	Tipo	Descrição
messages	GmailMessage[]	as mensagens a serem atualizadas

Retornar

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/

Consulte também

• refreshMessage(message)

---

refreshThread(thread)

Recarrega a conversa e o estado associado do Gmail. Isso é útil caso os rótulos, o estado de leitura etc. tenham mudado.

const 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

Nome	Tipo	Descrição
thread	GmailThread	a conversa a ser atualizada

Retornar

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/

Consulte também

• refreshThreads(threads)

---

refreshThreads(threads)

Recarrega as conversas e o estado associado do Gmail. Isso é útil caso os rótulos, o estado de leitura etc. tenham mudado.

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

Parâmetros

Nome	Tipo	Descrição
threads	GmailThread[]	as linhas de execução a serem atualizadas

Retornar

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/

Consulte também

• refreshThread(thread)

---

search(query)

Pesquise no Gmail com a consulta especificada.

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 conversa for desconhecido e potencialmente muito grande, use a chamada "paginada" e especifique intervalos das conversas a serem recuperadas em cada chamada.

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

Parâmetros

Nome	Tipo	Descrição
query	String	a consulta de pesquisa, como você digitaria no Gmail

Retornar

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)

Pesquise no Gmail com a consulta especificada.

// 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.
const threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);

Parâmetros

Nome	Tipo	Descrição
query	String	a consulta de pesquisa, como você digitaria no Gmail
start	Integer	o índice da thread inicial
max	Integer	o número máximo de encadeamentos a serem retornados

Retornar

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 cabeçalhos) é limitado por cota.

// The code below will send an email with the current date and time.
const now = new Date();
GmailApp.sendEmail(
    '[e-mail]',
    'current time',
    `The time is: ${now.toString()}`,
);

Parâmetros

Nome	Tipo	Descrição
recipient	String	lista de endereços de e-mail separados por vírgulas
subject	String	assunto do e-mail (máximo de 250 caracteres)
body	String	corpo do e-mail

Retornar

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/

Consulte também

• sendEmail(recipient, subject, body, options)

---

sendEmail(recipient, subject, body, options)

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

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

Parâmetros

Nome	Tipo	Descrição
recipient	String	os endereços do destinatário
subject	String	a linha de assunto (máximo de 250 caracteres)
body	String	o corpo do e-mail
options	Object	um objeto JavaScript que especifica parâmetros avançados, conforme listado abaixo

Parâmetros avançados

Nome	Tipo	Descrição
attachments	BlobSource[]	uma matriz de arquivos para enviar com o e-mail
bcc	String	uma lista separada por vírgulas de endereços de e-mail para CCO
cc	String	uma lista separada por vírgulas de endereços de e-mail para incluir em Cc
from	String	o endereço de e-mail de envio, que precisa ser um dos valores retornados por getAliases()
htmlBody	String	se definido, os dispositivos capazes de renderizar HTML vão usá-lo em vez do argumento de corpo obrigatório. Você pode adicionar um campo inlineImages opcional no corpo HTML se tiver imagens inline no e-mail.
inlineImages	Object	um objeto JavaScript que contém um mapeamento da chave da imagem (String) para os dados da imagem (BlobSource). Isso pressupõe que o parâmetro htmlBody seja usado e contenha referências a essas imagens no formato <img src="cid:imageKey" />.
name	String	o nome do remetente do e-mail (padrão: o nome do usuário)
noReply	Boolean	true se o e-mail deve ser enviado de um endereço genérico sem resposta para desencorajar os destinatários a responderem. Essa opção só é possível para contas do Google Workspace, não para usuários do Gmail.
replyTo	String	um endereço de e-mail para usar como o endereço para resposta padrão (padrão: o endereço de e-mail do usuário)

Retornar

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/

Consulte também

• sendEmail(recipient, subject, body)

---

setCurrentMessageAccessToken(accessToken)

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

Somente projetos de complementos do Google Workspace que usam os escopos de mensagens atuais do Gmail exigem esse método.

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

Parâmetros

Nome	Tipo	Descrição
accessToken	String	o token de acesso temporário obtido de um objeto de evento de ação de 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)

Adiciona uma estrela à mensagem e força a atualização dela.

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

Parâmetros

Nome	Tipo	Descrição
message	GmailMessage	a mensagem para marcar com estrela

Retornar

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/

Consulte também

• starMessages(messages)

---

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
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.starMessages(coupleOfMessages);

Parâmetros

Nome	Tipo	Descrição
messages	GmailMessage[]	uma matriz de mensagens para marcar com estrela

Retornar

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/

Consulte também

• starMessage(message)

---

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
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
GmailApp.unstarMessage(message);

Parâmetros

Nome	Tipo	Descrição
message	GmailMessage	a mensagem para remover a estrela

Retornar

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/

Consulte também

• unstarMessages(messages)

---

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
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.unstarMessages(coupleOfMessages);

Parâmetros

Nome	Tipo	Descrição
messages	GmailMessage[]	uma matriz de mensagens para remover a estrela

Retornar

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/

Consulte também

• unstarMessage(message)

Métodos obsoletos

getChatThreads()

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Recebe todas as conversas do Google Hangouts clássico e do Google Chat até que o Google mude todos os usuários do Hangouts clássico para o Chat ainda este ano. Para saber mais, consulte Saiba mais sobre a mudança do Hangouts clássico para o Google Chat.

Essa chamada falha quando o tamanho de todas as linhas de execução é muito grande para o sistema processar. Quando o tamanho da conversa for desconhecido e potencialmente muito grande, use a chamada "paginada" e especifique intervalos das conversas a serem recuperadas em cada chamada.

const threads = GmailApp.getChatThreads();
Logger.log(`# of chat threads: ${threads.length}`);

Retornar

GmailThread[]: uma matriz de conversas 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/

---

getChatThreads(start, max)

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Recebe um intervalo de conversas do Google Hangouts clássico e do Google Chat até que o Google mude todos os usuários do Hangouts clássico para o Chat ainda este ano. Para saber mais, consulte Saiba mais sobre a mudança do Hangouts clássico para o Google Chat.

// Get first 50 chat threads
const threads = GmailApp.getChatThreads(0, 50);
// Will log no more than 50.0
Logger.log(threads.length);
Logger.log(threads[0].getFirstMessageSubject());

Parâmetros

Nome	Tipo	Descrição
start	Integer	o índice da primeira conversa a ser recuperada
max	Integer	o número máximo de encadeamentos a serem recuperados

Retornar

GmailThread[]: uma matriz de conversas 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/