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 para responder ao remetente usando o endereço para resposta. |
createDraftReply(body, options) | GmailDraft | Cria uma mensagem de rascunho para responder ao remetente usando o endereço para resposta, com argumentos opcionais. |
createDraftReplyAll(body) | GmailDraft | Cria uma mensagem de rascunho para responder ao remetente usando o endereço para resposta e todos os destinatários desta mensagem. |
createDraftReplyAll(body, options) | GmailDraft | Cria uma mensagem de rascunho para responder ao remetente dessa mensagem usando o endereço para resposta e todos os destinatários, com argumentos opcionais. |
forward(recipient) | GmailMessage | Encaminha esta mensagem para os novos destinatários. |
forward(recipient, options) | GmailMessage | Encaminha esta mensagem para novos destinatários, com argumentos opcionais. |
getAttachments() | GmailAttachment[] | Extrai todos os anexos desta mensagem. |
getAttachments(options) | GmailAttachment[] | Extrai todos os anexos desta mensagem. |
getBcc() | String | Extrai os destinatários separados por vírgula incluídos em Cco nesta mensagem. |
getBody() | String | Extrai o conteúdo HTML do corpo desta mensagem. |
getCc() | String | Extrai os destinatários separados por vírgula em cópia na mensagem. |
getDate() | Date | Extrai a data e a hora da mensagem. |
getFrom() | String | Extrai o remetente desta mensagem. |
getHeader(name) | String | Recebe o valor de um cabeçalho RFC 2822 com base no nome do cabeçalho. |
getId() | String | Extrai o ID dessa mensagem. |
getPlainBody() | String | Extrai o conteúdo do corpo desta mensagem sem formatação HTML. |
getRawContent() | String | Extrai o conteúdo bruto dessa mensagem. |
getReplyTo() | String | Extrai o endereço para resposta desta mensagem (geralmente o remetente). |
getSubject() | String | Extrai o assunto desta mensagem. |
getThread() | GmailThread | Extrai a conversa que contém essa mensagem. |
getTo() | String | Extrai os destinatários separados por vírgula desta mensagem. |
isDraft() | Boolean | Verifica se esta mensagem é um rascunho. |
isInChats() | Boolean | Descobre se esta mensagem é um chat. |
isInInbox() | Boolean | Verifica se a mensagem está na caixa de entrada. |
isInPriorityInbox() | Boolean | Retorna true se esta mensagem estiver na caixa de entrada prioritária. Caso contrário, retorna false . |
isInTrash() | Boolean | Verifica se a mensagem está na lixeira. |
isStarred() | Boolean | Verifica se a mensagem está marcada com estrela. |
isUnread() | Boolean | Mostra se a 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 essa mensagem e o estado associado do Gmail (útil caso os marcadores, o estado de leitura etc. tenham sido alterados). |
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 desta 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 para responder ao remetente usando o endereço para resposta. O tamanho do e-mail (incluindo os cabeçalhos) é limitado por cota.
// Create a draft reply to the original message with an acknowledgment. var firstThread = GmailApp.getInboxThreads(0,1)[0]; var message = firstThread.getMessages()[0]; message.createDraftReply("Got your message");
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
body | String | O corpo do e-mail. |
Retorno
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/
Veja também
createDraftReply(body, options)
Cria uma mensagem de rascunho para responder ao remetente usando o endereço para resposta, com argumentos opcionais.
O e-mail pode conter texto simples e corpo HTML. O tamanho do e-mail (incluindo os cabeçalhos) é limitado por cota.
// Create a draft response with an HTML text body. var firstThread = GmailApp.getInboxThreads(0,1)[0]; var message = firstThread.getMessages()[0]; message.createDraftReply("incapable of HTML", { htmlBody: "<b>some HTML body text</b>", cc: "another@example.com" });
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 de endereços de e-mail separados por vírgula em Cco |
cc | String | uma lista de endereços de e-mail separados por vírgulas para colocar em cópia |
from | String | o endereço de origem do e-mail, que precisa ser um dos valores retornados por GmailApp.getAliases() ; |
htmlBody | String | quando definido, os dispositivos capazes de renderizar HTML o utilizam em vez do argumento de corpo obrigatório. Você pode adicionar um campo inlineImages opcional no corpo do HTML se tiver imagens inline para o e-mail |
inlineImages | Object | Um objeto JavaScript que contém um mapeamento da chave de imagem
(String ) para dados de imagem (BlobSource ). Isso pressupõe que o parâmetro htmlBody é usado e contém referências a essas imagens no formato <img src="cid:imageKey" /> |
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 ser usado 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. |
Retorno
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/
Veja também
createDraftReplyAll(body)
Cria uma mensagem de rascunho para responder ao remetente usando o endereço para resposta e todos os destinatários desta mensagem. O tamanho do e-mail (incluindo os cabeçalhos) é limitado por cota.
// Create a draft response to all recipients (except those bcc'd) with an acknowledgment. var firstThread = GmailApp.getInboxThreads(0,1)[0]; var message = firstThread.getMessages()[0]; message.createDraftReplyAll("Got your message");
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
body | String | O corpo do e-mail. |
Retorno
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/
Veja também
createDraftReplyAll(body, options)
Cria uma mensagem de rascunho para responder ao remetente dessa mensagem usando o endereço para resposta e todos os destinatários, com argumentos opcionais.
O e-mail pode conter texto simples e corpo HTML. O tamanho do e-mail (incluindo os cabeçalhos) é limitado por cota.
// Create a draft response to all recipients (except those bcc'd) using an HTML text body. var firstThread = GmailApp.getInboxThreads(0,1)[0]; var message = firstThread.getMessages()[0]; message.createDraftReplyAll("incapable of HTML", { htmlBody: "<b>some HTML body text</b>", cc: "another@example.com" });
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 de endereços de e-mail separados por vírgula em Cco |
cc | String | uma lista de endereços de e-mail separados por vírgulas para colocar em cópia |
from | String | o endereço de origem do e-mail, que precisa ser um dos valores retornados por GmailApp.getAliases() ; |
htmlBody | String | quando definido, os dispositivos capazes de renderizar HTML o utilizam em vez do argumento de corpo obrigatório. Você pode adicionar um campo inlineImages opcional no corpo do HTML se tiver imagens inline para o e-mail |
inlineImages | Object | Um objeto JavaScript que contém um mapeamento da chave de imagem
(String ) para dados de imagem (BlobSource ). Isso pressupõe que o parâmetro htmlBody é usado e contém referências a essas imagens no formato <img src="cid:imageKey" /> |
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 ser usado 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. |
Retorno
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/
Veja também
forward(recipient)
Encaminha esta mensagem para os novos destinatários. O tamanho do e-mail (incluindo os cabeçalhos) é limitado por cota.
// Forward first message of first inbox thread to recipient1 & recipient2, both @example.com var firstThread = GmailApp.getInboxThreads(0,1)[0]; var message = firstThread.getMessages()[0]; message.forward("recipient1@example.com,recipient2@example.com");
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
recipient | String | Uma lista de endereços de e-mail separados por vírgulas. |
Retorno
GmailMessage
: 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/
Veja também
forward(recipient, options)
Encaminha esta mensagem para novos destinatários, com argumentos opcionais.
O e-mail pode conter texto simples e também um corpo HTML. O tamanho do e-mail (incluindo os cabeçalhos) é limitado por cota.
var firstThread = GmailApp.getInboxThreads(0,1)[0]; var message = firstThread.getMessages()[0]; message.forward("recipient1@example.com,recipient2@example.com", { cc: "myboss@example.com", bcc: "mybosses-boss@example.com,vp@example.com" });
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
recipient | String | Uma lista de endereços de e-mail separados por vírgulas. |
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 de endereços de e-mail separados por vírgula em Cco |
cc | String | uma lista de endereços de e-mail separados por vírgulas para colocar em cópia |
from | String | o endereço de origem do e-mail, que precisa ser um dos valores retornados por GmailApp.getAliases() ; |
htmlBody | String | quando definido, os dispositivos capazes de renderizar HTML o utilizam em vez do argumento de corpo obrigatório. Você pode adicionar um campo inlineImages opcional no corpo do HTML se tiver imagens inline para o e-mail |
inlineImages | Object | Um objeto JavaScript que contém um mapeamento da chave de imagem
(String ) para dados de imagem (BlobSource ). Isso pressupõe que o parâmetro htmlBody é usado e contém referências a essas imagens no formato <img src="cid:imageKey" /> |
name | String | o nome do remetente do e-mail (padrão: o nome do usuário) |
noReply | Boolean | true se o e-mail precisar ser enviado de um endereço genérico
sem resposta para desencorajar os destinatários a responder aos e-mails. Essa opção só
está disponível para contas do Google Workspace, não para usuários do Gmail |
replyTo | String | Um endereço de e-mail para ser usado como o endereço para resposta padrão (padrão: o endereço de e-mail do usuário). |
subject | String | Uma nova linha de assunto para o e-mail, com até 250 caracteres. |
Retorno
GmailMessage
: 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/
Veja também
getAttachments()
Extrai todos os anexos desta mensagem.
Retorno
GmailAttachment[]
: uma matriz de anexos do Blob para a 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)
Extrai 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 do Blob precisar incluir imagens inline (o padrão é true ). |
includeAttachments | Boolean | true se a matriz retornada de anexos do Blob precisar incluir anexos normais (não inline) (o padrão é true ). |
Retorno
GmailAttachment[]
: uma matriz de anexos do Blob para a 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()
Extrai os destinatários separados por vírgula incluídos em Cco nesta mensagem.
Por definição, esse campo está vazio para todas as mensagens recebidas.
var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox var message = thread.getMessages()[0]; // Get first message Logger.log(message.getBcc()); // Log bcc'd addresses
Retorno
String
: os destinatários separados por vírgulas colocados em Cco 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/
Veja também
getBody()
Extrai o conteúdo HTML do corpo desta mensagem.
var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox var message = thread.getMessages()[0]; // Get first message Logger.log(message.getBody()); // Log contents of the body
Retorno
String
: o conteúdo do corpo 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/
Veja também
getCc()
Extrai os destinatários separados por vírgula em cópia na mensagem.
var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox var message = thread.getMessages()[0]; // Get first message Logger.log(message.getCc()); // Log cc'd addresses
Retorno
String
: os destinatários separados por vírgula em cópia 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/
Veja também
getDate()
Extrai a data e a hora da mensagem.
var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox var message = thread.getMessages()[0]; // Get first message Logger.log(message.getDate()); // Log date and time of the message
Retorno
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.
var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox var message = thread.getMessages()[0]; // Get first message Logger.log(message.getFrom()); // Log from address of the message
Retorno
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/
Veja também
getHeader(name)
Recebe o valor de um cabeçalho RFC 2822 com base no nome do cabeçalho.
var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox. var 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 separando-o do valor. |
Retorno
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()
Extrai o ID dessa mensagem.
var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox var message = thread.getMessages()[0]; // Get first message var id = message.getId(); var messageById = GmailApp.getMessageById(id); Logger.log(message.getSubject() == messageById.getMessage()); // Always logs true
Retorno
String
: o ID da mensagem.
getPlainBody()
Extrai o conteúdo do corpo desta mensagem sem formatação HTML. Essa ação é mais complexa do que
getBody()
e leva mais tempo.
var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox var message = thread.getMessages()[0]; // Get first message Logger.log(message.getPlainBody()); // Log contents of the body
Retorno
String
: o conteúdo do corpo sem formatação 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/
Veja também
getRawContent()
Extrai o conteúdo bruto dessa mensagem. Isso equivale a "Mostrar original" na interface do Gmail.
Retorno
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()
Extrai o endereço para resposta desta mensagem (geralmente o remetente).
var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox var message = thread.getMessages()[0]; // Get first message Logger.log(message.getReplyTo()); // Logs reply-to address
Retorno
String
: o endereço de e-mail para as 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/
Veja também
getSubject()
Extrai o assunto desta mensagem.
var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox var message = thread.getMessages()[0]; // Get first message Logger.log(message.getSubject()); // Log subject line
Retorno
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/
Veja também
getThread()
Extrai a conversa que contém essa mensagem.
var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox var message = thread.getMessages()[0]; // Get first message Logger.log(message.getThread().getFirstMessageSubject() == thread.getFirstMessageSubject()); // Always logs true
Retorno
GmailThread
: a GmailThread que contém a 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()
Extrai os destinatários separados por vírgula desta mensagem.
var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox var message = thread.getMessages()[0]; // Get first message Logger.log(message.getTo()); // Log the recipient of message
Retorno
String
: os destinatários separados por vírgula 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/
Veja também
isDraft()
Verifica se esta mensagem é um rascunho.
var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox var message = thread.getMessages()[0]; // Get first message Logger.log("is draft? " + message.isDraft());
Retorno
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()
Descobre se esta mensagem é um chat.
var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox var message = thread.getMessages()[0]; // Get first message Logger.log("is a chat? " + message.isInChats());
Retorno
Boolean
: indica se a mensagem é um chat.
isInInbox()
Verifica se a mensagem está na caixa de entrada.
var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox var message = thread.getMessages()[0]; // Get first message Logger.log("is in inbox? " + message.isInInbox());
Retorno
Boolean
: 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 esta mensagem estiver na caixa de entrada prioritária. Caso contrário, retorna false
.
var thread = GmailApp.getPriorityInboxThreads(0,1)[0]; // Get first thread in priority inbox var messages = thread.getMessages(); for (var 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()); }
Retorno
Boolean
: se a mensagem está ou não 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/
isInTrash()
Verifica se a mensagem está na lixeira.
var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox var message = thread.getMessages()[0]; // Get first message Logger.log("is in the trash? " + message.isInTrash());
Retorno
Boolean
: se a mensagem está na lixeira.
isStarred()
Verifica se a mensagem está marcada com estrela.
var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox var message = thread.getMessages()[0]; // Get first message Logger.log("is starred? " + message.isStarred());
Retorno
Boolean
: indica se a mensagem está marcada com estrela.
isUnread()
Mostra se a mensagem não foi lida.
var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox var message = thread.getMessages()[0]; // Get first message Logger.log("is unread? " + message.isUnread());
Retorno
Boolean
: o status não lido 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/
markRead()
Marca a mensagem como lida.
var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox var message = thread.getMessages()[0]; // Get first message message.markRead(); // Mark as read
Retorno
GmailMessage
: 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/
Veja também
markUnread()
Marca a mensagem como não lida.
var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox var message = thread.getMessages()[0]; // Get first message message.markUnread(); // Mark as unread
Retorno
GmailMessage
: 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/
Veja também
moveToTrash()
Move a mensagem para a lixeira.
var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox var message = thread.getMessages()[0]; // Get first message message.moveToTrash(); // Move message to trash
Retorno
GmailMessage
: 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/
Veja também
refresh()
Recarrega essa mensagem e o estado associado do Gmail (útil caso os marcadores, o estado de leitura etc. tenham sido alterados).
var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox var 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
Retorno
GmailMessage
: mensagem de 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 os cabeçalhos) é limitado por cota.
// Respond to author of message with acknowledgment var firstThread = GmailApp.getInboxThreads(0,1)[0]; var message = firstThread.getMessages()[0]; message.reply("Got your message");
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
body | String | O corpo do e-mail. |
Retorno
GmailMessage
: 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/
Veja também
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 também um corpo HTML. O tamanho do e-mail (incluindo os cabeçalhos) é limitado por cota.
// Respond with HTML body text var firstThread = GmailApp.getInboxThreads(0,1)[0]; var 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 de endereços de e-mail separados por vírgula em Cco |
cc | String | uma lista de endereços de e-mail separados por vírgulas para colocar em cópia |
from | String | o endereço de origem do e-mail, que precisa ser um dos valores retornados por GmailApp.getAliases() ; |
htmlBody | String | quando definido, os dispositivos capazes de renderizar HTML o utilizam em vez do argumento de corpo obrigatório. Você pode adicionar um campo inlineImages opcional no corpo do HTML se tiver imagens inline para o e-mail |
inlineImages | Object | Um objeto JavaScript que contém um mapeamento da chave de imagem
(String ) para dados de imagem (BlobSource ). Isso pressupõe que o parâmetro htmlBody é usado e contém referências a essas imagens no formato <img src="cid:imageKey" /> |
name | String | o nome do remetente do e-mail (padrão: o nome do usuário) |
noReply | Boolean | true se o e-mail precisar ser enviado de um endereço genérico
sem resposta para desencorajar os destinatários a responder aos e-mails. Essa opção só
está disponível para contas do Google Workspace, não para usuários do Gmail |
replyTo | String | Um endereço de e-mail para ser usado como o endereço para resposta padrão (padrão: o endereço de e-mail do usuário). |
subject | String | Uma nova linha de assunto para o e-mail, com até 250 caracteres. |
Retorno
GmailMessage
: 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/
Veja também
replyAll(body)
Responde ao remetente usando o endereço para resposta e todos os destinatários desta mensagem. O tamanho do e-mail (incluindo os cabeçalhos) é limitado por cota.
// Respond to all recipients (except bcc'd) of last email in thread with acknowledgment var firstThread = GmailApp.getInboxThreads(0,1)[0]; var message = firstThread.getMessages()[0]; message.replyAll("Got your message");
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
body | String | O corpo do e-mail. |
Retorno
GmailMessage
: 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/
Veja também
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 também um corpo HTML. O tamanho do e-mail (incluindo os cabeçalhos) é limitado por cota.
// Respond with HTML body text var firstThread = GmailApp.getInboxThreads(0,1)[0]; var message = firstThread.getMessages()[0]; messageThread.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 de endereços de e-mail separados por vírgula em Cco |
cc | String | uma lista de endereços de e-mail separados por vírgulas para colocar em cópia |
from | String | o endereço de origem do e-mail, que precisa ser um dos valores retornados por GmailApp.getAliases() ; |
htmlBody | String | quando definido, os dispositivos capazes de renderizar HTML o utilizam em vez do argumento de corpo obrigatório. Você pode adicionar um campo inlineImages opcional no corpo do HTML se tiver imagens inline para o e-mail |
inlineImages | Object | Um objeto JavaScript que contém um mapeamento da chave de imagem
(String ) para dados de imagem (BlobSource ). Isso pressupõe que o parâmetro htmlBody é usado e contém referências a essas imagens no formato <img src="cid:imageKey" /> |
name | String | o nome do remetente do e-mail (padrão: o nome do usuário) |
noReply | Boolean | true se o e-mail precisar ser enviado de um endereço genérico
sem resposta para desencorajar os destinatários a responder aos e-mails. Essa opção só
está disponível para contas do Google Workspace, não para usuários do Gmail |
replyTo | String | Um endereço de e-mail para ser usado como o endereço para resposta padrão (padrão: o endereço de e-mail do usuário). |
subject | String | Uma nova linha de assunto para o e-mail, com até 250 caracteres. |
Retorno
GmailMessage
: 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/
Veja também
star()
Marca a mensagem com estrela.
var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox var message = thread.getMessages()[0]; // Get first message message.star(); // Star the message
Retorno
GmailMessage
: 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/
Veja também
unstar()
Remove a estrela da mensagem.
var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox var message = thread.getMessages()[0]; // Get first message message.unstar(); // Unstar the message
Retorno
GmailMessage
: 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/