Class GmailMessage

GmailMessage

Uma mensagem na conta do Gmail de um usuário.

Métodos

Método	Tipo de retorno	Breve descrição
createDraftReply(body)	GmailDraft	Cria uma mensagem de rascunho respondendo ao remetente desta mensagem usando o Endereço para resposta.
createDraftReply(body, options)	GmailDraft	Cria um rascunho de mensagem respondendo ao remetente usando o endereço para resposta, com argumentos opcionais.
createDraftReplyAll(body)	GmailDraft	Cria uma mensagem de rascunho respondendo ao remetente usando o Endereço para resposta e todos os destinatários desta mensagem.
createDraftReplyAll(body, options)	GmailDraft	Cria uma mensagem de rascunho respondendo ao remetente desta mensagem usando o Endereço para resposta e todos os destinatários, com argumentos opcionais.
forward(recipient)	GmailMessage	Encaminha esta mensagem para novos destinatários.
forward(recipient, options)	GmailMessage	Encaminha esta mensagem para novos destinatários, com argumentos opcionais.
getAttachments()	GmailAttachment[]	Recebe todos os anexos desta mensagem.
getAttachments(options)	GmailAttachment[]	Recebe todos os anexos desta mensagem.
getBcc()	String	Recebe os destinatários em cópia oculta separados por vírgulas desta mensagem.
getBody()	String	Recebe o conteúdo HTML do corpo desta mensagem.
getCc()	String	Recebe os destinatários em cópia da mensagem separados por vírgula.
getDate()	Date	Recebe a data e a hora desta mensagem.
getFrom()	String	Extrai o remetente desta mensagem.
getHeader(name)	String	Recebe o valor de um cabeçalho RFC 2822 com base no nome dele.
getId()	String	Recebe o ID desta mensagem.
getPlainBody()	String	Recebe o conteúdo do corpo desta mensagem sem formatação HTML.
getRawContent()	String	Recebe o conteúdo bruto desta mensagem.
getReplyTo()	String	Recebe o endereço para resposta desta mensagem (geralmente o remetente).
getSubject()	String	Extrai o assunto desta mensagem.
getThread()	GmailThread	Recebe a conversa que contém esta mensagem.
getTo()	String	Recebe os destinatários separados por vírgula desta mensagem.
isDraft()	Boolean	Recebe se esta mensagem é um rascunho.
isInChats()	Boolean	Recebe se esta mensagem é um chat.
isInInbox()	Boolean	Recebe se esta mensagem está na caixa de entrada.
isInPriorityInbox()	Boolean	Retorna true se a mensagem estiver na caixa de entrada prioritária. Caso contrário, retorna false.
isInTrash()	Boolean	Recebe se esta mensagem está na lixeira.
isStarred()	Boolean	Recebe se esta mensagem está marcada com estrela.
isUnread()	Boolean	Recebe se esta mensagem não foi lida.
markRead()	GmailMessage	Marca a mensagem como lida.
markUnread()	GmailMessage	Marca a mensagem como não lida.
moveToTrash()	GmailMessage	Move a mensagem para a lixeira.
refresh()	GmailMessage	Recarrega esta mensagem e o estado associado do Gmail. Isso é útil caso os rótulos, o estado de leitura etc. tenham mudado.
reply(body)	GmailMessage	Responde ao remetente desta mensagem usando o Endereço para resposta.
reply(body, options)	GmailMessage	Responde ao remetente desta mensagem usando o endereço para resposta, com argumentos opcionais.
replyAll(body)	GmailMessage	Responde ao remetente usando o Endereço para resposta e todos os destinatários da mensagem.
replyAll(body, options)	GmailMessage	Responde ao remetente desta mensagem usando o Endereço para resposta e todos os destinatários, com argumentos opcionais.
star()	GmailMessage	Marca a mensagem com estrela.
unstar()	GmailMessage	Remove a estrela da mensagem.

Documentação detalhada

createDraftReply(body)

Cria uma mensagem de rascunho respondendo ao remetente desta mensagem usando o Endereço para resposta. O tamanho do e-mail (incluindo cabeçalhos) está limitado pela cota.

// Create a draft reply to the original message with an acknowledgment.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReply('Got your message');

Parâmetros

Nome	Tipo	Descrição
body	String	O corpo do e-mail.

Retornar

GmailDraft: a mensagem de rascunho recém-criada.

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

• reply(body)
• createDraftReply(body, options)
• createDraftReplyAll(body)
• createDraftReplyAll(body, options)

---

createDraftReply(body, options)

Cria um rascunho de mensagem respondendo ao remetente usando o endereço para resposta, com argumentos opcionais.

O e-mail pode conter texto simples e um corpo HTML. O tamanho do e-mail (incluindo cabeçalhos) excedeu a cota.

// Create a draft response with an HTML text body.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReply('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  cc: '[e-mail]',
});

Parâmetros

Nome	Tipo	Descrição
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 GmailApp.getAliases()
htmlBody	String	Quando definido, os dispositivos capazes de renderizar HTML o usam 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)
subject	String	Uma nova linha de assunto para o e-mail, com até 250 caracteres.

Retornar

GmailDraft: a mensagem de rascunho recém-criada.

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

• reply(body, options)
• createDraftReply(body)
• createDraftReplyAll(body)
• createDraftReplyAll(body, options)

---

createDraftReplyAll(body)

Cria uma mensagem de rascunho respondendo ao remetente usando o Endereço para resposta e todos os destinatários desta mensagem. O tamanho do e-mail (incluindo cabeçalhos) é limitado por cota.

// Create a draft response to all recipients (except those bcc'd) with an
// acknowledgment.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReplyAll('Got your message');

Parâmetros

Nome	Tipo	Descrição
body	String	O corpo do e-mail.

Retornar

GmailDraft: a mensagem de rascunho recém-criada.

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

• replyAll(body)
• createDraftReply(body)
• createDraftReply(body, options)
• createDraftReplyAll(body, options)

---

createDraftReplyAll(body, options)

Cria uma mensagem de rascunho respondendo ao remetente desta mensagem usando o Endereço para resposta e todos os destinatários, com argumentos opcionais.

O e-mail pode conter texto simples e um corpo HTML. O tamanho do e-mail (incluindo cabeçalhos) excedeu a cota.

// Create a draft response to all recipients (except those bcc'd) using an HTML
// text body.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReplyAll('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  cc: '[e-mail]',
});

Parâmetros

Nome	Tipo	Descrição
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 GmailApp.getAliases()
htmlBody	String	Quando definido, os dispositivos capazes de renderizar HTML o usam 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)
subject	String	Uma nova linha de assunto para o e-mail, com até 250 caracteres.

Retornar

GmailDraft: a mensagem de rascunho recém-criada.

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

• replyAll(body, options)
• createDraftReply(body)
• createDraftReply(body, options)
• createDraftReplyAll(body)

---

forward(recipient)

Encaminha esta mensagem para novos destinatários. O tamanho do e-mail (incluindo cabeçalhos) é limitado por cota.

// Forward first message of first inbox thread to recipient1 & recipient2,
// both @example.com
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.forward('[e-mail],[e-mail]');

Parâmetros

Nome	Tipo	Descrição
recipient	String	Uma lista separada por vírgulas de endereços de e-mail.

Retornar

GmailMessage: esta mensagem é ú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

• forward(recipient, options)

---

forward(recipient, options)

Encaminha esta mensagem para novos destinatários, com argumentos opcionais.

O e-mail pode conter texto simples e um corpo HTML. O tamanho do e-mail (incluindo cabeçalhos) está limitado pela cota.

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.forward('[e-mail],[e-mail]', {
  cc: '[e-mail]',
  bcc: '[e-mail],[e-mail]',
});

Parâmetros

Nome	Tipo	Descrição
recipient	String	Uma lista separada por vírgulas de endereços de 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 GmailApp.getAliases()
htmlBody	String	Quando definido, os dispositivos capazes de renderizar HTML o usam em vez do argumento de corpo obrigatório. Você pode adicionar um campo inlineImages opcional no corpo HTML se tiver imagens em linha 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)
subject	String	Uma nova linha de assunto para o e-mail, com até 250 caracteres.

Retornar

GmailMessage: esta mensagem é ú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

• forward(recipient)

---

getAttachments()

Recebe todos os anexos desta mensagem.

Retornar

GmailAttachment[]: uma matriz de anexos de blob para esta mensagem.

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/

---

getAttachments(options)

Recebe todos os anexos desta mensagem.

Parâmetros

Nome	Tipo	Descrição
options	Object	Um objeto JavaScript que especifica parâmetros avançados, conforme listado abaixo.

Parâmetros avançados

Nome	Tipo	Descrição
includeInlineImages	Boolean	true se a matriz retornada de anexos de blob incluir imagens inline (o padrão é true).
includeAttachments	Boolean	true se a matriz retornada de anexos Blob incluir anexos regulares (não inline). O padrão é true.

Retornar

GmailAttachment[]: uma matriz de anexos de blob para esta mensagem.

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/

---

getBcc()

Recebe os destinatários em cópia oculta separados por vírgulas desta mensagem.

Por definição, esse campo fica vazio para todas as mensagens recebidas.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getBcc());                      // Log bcc'd addresses

Retornar

String: os destinatários em cópia oculta separados por vírgula nesta mensagem.

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

• getTo()

---

getBody()

Recebe o conteúdo HTML do corpo desta mensagem.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getBody());                     // Log contents of the body

Retornar

String: o conteúdo do corpo desta mensagem.

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

• getSubject()

---

getCc()

Recebe os destinatários em cópia da mensagem separados por vírgula.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getCc());                       // Log cc'd addresses

Retornar

String: os destinatários em cópia da mensagem, separados por vírgulas.

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

• getTo()

---

getDate()

Recebe a data e a hora desta mensagem.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getDate());  // Log date and time of the message

Retornar

Date: a data e a hora da mensagem.

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/

---

getFrom()

Extrai o remetente desta mensagem.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getFrom());  // Log from address of the message

Retornar

String: o endereço de e-mail do remetente da mensagem.

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

• getReplyTo()

---

getHeader(name)

Recebe o valor de um cabeçalho RFC 2822 com base no nome dele.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox.
const message = thread.getMessages()[0];           // Get the first message.
Logger.log(
    message.getHeader('Message-ID'));  // Logs the Message-ID RFC 2822 header.

Parâmetros

Nome	Tipo	Descrição
name	String	O nome do cabeçalho RFC, sem os dois pontos que o separam do valor.

Retornar

String: o valor do cabeçalho ou uma string vazia se o cabeçalho não existir na mensagem.

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/

---

getId()

Recebe o ID desta mensagem.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
const id = message.getId();
const messageById = GmailApp.getMessageById(id);
Logger.log(
    message.getSubject() === messageById.getMessage());  // Always logs true

Retornar

String: o ID da mensagem.

---

getPlainBody()

Recebe o conteúdo do corpo desta mensagem sem formatação HTML. Esse processo é mais complexo que o getBody() e leva mais tempo.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getPlainBody());                // Log contents of the body

Retornar

String: o conteúdo do corpo simples desta mensagem.

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

• getSubject()

---

getRawContent()

Recebe o conteúdo bruto desta mensagem. Isso equivale a "Mostrar original" na interface do Gmail.

Retornar

String: o conteúdo bruto da mensagem.

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/

---

getReplyTo()

Recebe o endereço para resposta desta mensagem (geralmente o remetente).

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getReplyTo());                  // Logs reply-to address

Retornar

String: o endereço de e-mail para respostas.

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

• getCc()

---

getSubject()

Extrai o assunto desta mensagem.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getSubject());                  // Log subject line

Retornar

String: o assunto da mensagem.

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

• getAttachments()

---

getThread()

Recebe a conversa que contém esta mensagem.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(
    message.getThread().getFirstMessageSubject() ===
        thread.getFirstMessageSubject(),
);  // Always logs true

Retornar

GmailThread: o GmailThread que contém esta mensagem.

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/

---

getTo()

Recebe os destinatários separados por vírgula desta mensagem.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getTo());  // Log the recipient of message

Retornar

String: os destinatários desta mensagem separados por vírgulas.

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

• getCc()

---

isDraft()

Recebe se esta mensagem é um rascunho.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is draft? ${message.isDraft()}`);

Retornar

Boolean: indica se a mensagem é um rascunho.

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/

---

isInChats()

Recebe se esta mensagem é um chat.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is a chat? ${message.isInChats()}`);

Retornar

Boolean: indica se a mensagem é um chat.

---

isInInbox()

Recebe se esta mensagem está na caixa de entrada.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is in inbox? ${message.isInInbox()}`);

Retornar

Boolean: indica se a mensagem está 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/

---

isInPriorityInbox()

Retorna true se a mensagem estiver na caixa de entrada prioritária. Caso contrário, retorna false.

const thread = GmailApp.getPriorityInboxThreads(
    0, 1)[0];  // Get first thread in priority inbox
const messages = thread.getMessages();
for (let i = 0; i < messages.length; i++) {
  // At least one of the messages is in priority inbox
  Logger.log(`is in priority inbox? ${messages[i].isInPriorityInbox()}`);
}

Retornar

Boolean: indica se a mensagem está na caixa de entrada 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/

---

isInTrash()

Recebe se esta mensagem está na lixeira.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is in the trash? ${message.isInTrash()}`);

Retornar

Boolean: se a mensagem está na lixeira.

---

isStarred()

Recebe se esta mensagem está marcada com estrela.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is starred? ${message.isStarred()}`);

Retornar

Boolean: indica se a mensagem está marcada com estrela.

---

isUnread()

Recebe se esta mensagem não foi lida.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is unread? ${message.isUnread()}`);

Retornar

Boolean: o status de não lida da mensagem.

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/

---

markRead()

Marca a mensagem como lida.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.markRead();                                // Mark as read

Retornar

GmailMessage: este GmailMessage, ú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

• isUnread()

---

markUnread()

Marca a mensagem como não lida.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.markUnread();                              // Mark as unread

Retornar

GmailMessage: este GmailMessage, ú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

• isUnread()

---

moveToTrash()

Move a mensagem para a lixeira.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.moveToTrash();                             // Move message to trash

Retornar

GmailMessage: este GmailMessage, ú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

• isInTrash()

---

refresh()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
// .. Do bunch of stuff here
message.refresh();  // Make sure it's up to date
// Do more stuff to message

Retornar

GmailMessage: esta mensagem 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/

---

reply(body)

Responde ao remetente desta mensagem usando o Endereço para resposta. O tamanho do e-mail (incluindo cabeçalhos) está limitado pela cota.

// Respond to author of message with acknowledgment
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.reply('Got your message');

Parâmetros

Nome	Tipo	Descrição
body	String	O corpo do e-mail.

Retornar

GmailMessage: esta mensagem é ú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

• reply(body, options)
• replyAll(body)
• replyAll(body, options)

---

reply(body, options)

Responde ao remetente desta mensagem usando o endereço para resposta, com argumentos opcionais.

O e-mail pode conter texto simples e um corpo HTML. O tamanho do e-mail (incluindo cabeçalhos) está limitado pela cota.

// Respond with HTML body text
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.reply('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  noReply: true,
});

Parâmetros

Nome	Tipo	Descrição
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 GmailApp.getAliases()
htmlBody	String	Quando definido, os dispositivos capazes de renderizar HTML o usam 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)
subject	String	Uma nova linha de assunto para o e-mail, com até 250 caracteres.

Retornar

GmailMessage: esta mensagem é ú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

• reply(body)
• replyAll(body)
• replyAll(body, options)

---

replyAll(body)

Responde ao remetente usando o Endereço para resposta e todos os destinatários da mensagem. O tamanho do e-mail (incluindo cabeçalhos) está limitado pela cota.

// Respond to all recipients (except bcc'd) of last email in thread with
// acknowledgment
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.replyAll('Got your message');

Parâmetros

Nome	Tipo	Descrição
body	String	O corpo do e-mail.

Retornar

GmailMessage: esta mensagem,ú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

• reply(body)
• reply(body, options)
• replyAll(body, options)

---

replyAll(body, options)

Responde ao remetente desta mensagem usando o Endereço para resposta e todos os destinatários, com argumentos opcionais.

O e-mail pode conter texto simples e um corpo HTML. O tamanho do e-mail (incluindo cabeçalhos) está limitado pela cota.

// Respond with HTML body text
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.replyAll('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  noReply: true,
});

Parâmetros

Nome	Tipo	Descrição
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 GmailApp.getAliases()
htmlBody	String	Quando definido, os dispositivos capazes de renderizar HTML o usam 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)
subject	String	Uma nova linha de assunto para o e-mail, com até 250 caracteres.

Retornar

GmailMessage: esta mensagem é ú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

• reply(body)
• reply(body, options)
• replyAll(body)

---

star()

Marca a mensagem com estrela.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.star();                                    // Star the message

Retornar

GmailMessage: este GmailMessage, ú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

• unstar()

---

unstar()

Remove a estrela da mensagem.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.unstar();                                  // Unstar the message

Retornar

GmailMessage: este GmailMessage, ú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

• star()