Uma mensagem na conta do Gmail de um usuário.
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
createDraftReply(body) | GmailDraft | Cria um rascunho de mensagem respondendo ao remetente dessa mensagem usando o endereço para resposta. |
createDraftReply(body, options) | GmailDraft | Cria um rascunho de mensagem respondendo ao remetente dessa mensagem usando o endereço para resposta, com argumentos opcionais. |
createDraftReplyAll(body) | GmailDraft | Cria um rascunho de mensagem respondendo ao remetente usando o endereço para resposta e todos os destinatários da mensagem. |
createDraftReplyAll(body, options) | GmailDraft | Cria um rascunho de mensagem respondendo ao remetente dessa mensagem usando o endereço para resposta e todos os destinatários, com argumentos opcionais. |
forward(recipient) | GmailMessage | Encaminhar 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 separados por vírgulas como Cco nesta mensagem. |
getBody() | String | Recebe o conteúdo HTML do corpo desta mensagem. |
getCc() | String | Recebe os destinatários separados por vírgula cc'd nesta mensagem. |
getDate() | Date | Recebe a data e a hora da mensagem. |
getFrom() | String | Extrai o remetente desta mensagem. |
getHeader(name) | String | Acessa o valor de um cabeçalho RFC 2822 de acordo com o nome do cabeçalho. |
getId() | String | Recebe o ID desta mensagem. |
getPlainBody() | String | Recebe o conteúdo do corpo da mensagem sem a 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 essa mensagem. |
getTo() | String | Recebe os destinatários separados por vírgula da mensagem. |
isDraft() | Boolean | Recebe se a mensagem é um rascunho. |
isInChats() | Boolean | Recebe se esta mensagem é um chat. |
isInInbox() | Boolean | Recebe se a mensagem está na caixa de entrada. |
isInPriorityInbox() | Boolean | Retornará true se essa mensagem estiver na caixa de entrada prioritária. Caso contrário, retornará false . |
isInTrash() | Boolean | Recebe se a mensagem está na lixeira. |
isStarred() | Boolean | Recebe se a mensagem está marcada com estrela. |
isUnread() | Boolean | Recebe 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 esta mensagem e o estado associado do Gmail (útil caso os marcadores, 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 | Respostas 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 | Estrela removida da mensagem. |
Documentação detalhada
createDraftReply(body)
Cria um rascunho de mensagem respondendo ao remetente dessa mensagem usando o endereço para resposta. O tamanho do e-mail (incluindo cabeçalhos) é limitado pela 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. |
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/
Veja também
createDraftReply(body, options)
Cria um rascunho de mensagem respondendo ao remetente dessa 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) é limitado pela 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 a serem enviados com o e-mail |
bcc | String | Uma lista separada por vírgulas de endereços de e-mail para Cco |
cc | String | uma lista de endereços de e-mail separados por vírgulas para Cc |
from | String | O endereço do qual o e-mail deve ser enviado, que precisa ser um dos valores retornados por GmailApp.getAliases() . |
htmlBody | String | quando definidos, os dispositivos capazes de renderizar o HTML o usarão em vez do argumento de corpo obrigatório. Você pode adicionar um campo inlineImages opcional no corpo do HTML se tiver imagens in-line para seu e-mail |
inlineImages | Object | um objeto JavaScript que contém um mapeamento da chave de imagem (String ) para os dados de imagem (BlobSource ). Isso pressupõe que o parâmetro htmlBody é usado e contém referências a essas imagens no formato <img src="cid:imageKey" /> |
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 endereço de 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; |
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/
Veja também
createDraftReplyAll(body)
Cria um rascunho de mensagem respondendo ao remetente usando o endereço para resposta e todos os destinatários da mensagem. O tamanho do e-mail (incluindo cabeçalhos) é limitado pela 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. |
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/
Veja também
createDraftReplyAll(body, options)
Cria um rascunho de mensagem respondendo 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 um corpo HTML. O tamanho do e-mail (incluindo cabeçalhos) é limitado pela 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 a serem enviados com o e-mail |
bcc | String | Uma lista separada por vírgulas de endereços de e-mail para Cco |
cc | String | uma lista de endereços de e-mail separados por vírgulas para Cc |
from | String | O endereço do qual o e-mail deve ser enviado, que precisa ser um dos valores retornados por GmailApp.getAliases() . |
htmlBody | String | quando definidos, os dispositivos capazes de renderizar o HTML o usarão em vez do argumento de corpo obrigatório. Você pode adicionar um campo inlineImages opcional no corpo do HTML se tiver imagens in-line para seu e-mail |
inlineImages | Object | um objeto JavaScript que contém um mapeamento da chave de imagem (String ) para os dados de imagem (BlobSource ). Isso pressupõe que o parâmetro htmlBody é usado e contém referências a essas imagens no formato <img src="cid:imageKey" /> |
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 endereço de 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; |
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/
Veja também
forward(recipient)
Encaminhar esta mensagem para novos destinatários. O tamanho do e-mail (incluindo cabeçalhos) é limitado pela 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. |
Retornar
GmailMessage
: esta mensagem, útil para encadeamentos.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:
-
https://mail.google.com/
Veja também
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) é limitado à 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 a serem enviados com o e-mail |
bcc | String | Uma lista separada por vírgulas de endereços de e-mail para Cco |
cc | String | uma lista de endereços de e-mail separados por vírgulas para Cc |
from | String | O endereço do qual o e-mail deve ser enviado, que precisa ser um dos valores retornados por GmailApp.getAliases() . |
htmlBody | String | quando definidos, os dispositivos capazes de renderizar o HTML o usarão em vez do argumento de corpo obrigatório. Você pode adicionar um campo inlineImages opcional no corpo do HTML se tiver imagens in-line para seu e-mail |
inlineImages | Object | um objeto JavaScript que contém um mapeamento da chave de imagem (String ) para os dados de imagem (BlobSource ). Isso pressupõe que o parâmetro htmlBody é usado e contém referências a essas imagens no formato <img src="cid:imageKey" /> |
name | String | o nome do remetente do e-mail (padrão: o nome do usuário) |
noReply | Boolean | true : se o e-mail for enviado de um endereço genérico
sem resposta para desencorajar os destinatários a responder aos e-mails. Essa opção só
é possível para contas do Google Workspace, e não usuários do Gmail |
replyTo | String | Um endereço de e-mail para usar como endereço de resposta padrão (padrão: o endereço de e-mail do usuário) |
subject | String | uma nova linha de assunto para o e-mail; |
Retornar
GmailMessage
: esta mensagem, útil para encadeamentos.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:
-
https://mail.google.com/
Veja também
getAttachments()
Recebe todos os anexos desta mensagem.
Retornar
GmailAttachment[]
: uma matriz de anexos 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 Blob
incluir imagens inline (o padrão é true ). |
includeAttachments | Boolean | true se a matriz de anexos Blob retornada tiver anexos regulares (não inline). O padrão é true . |
Retornar
GmailAttachment[]
: uma matriz de anexos 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 separados por vírgulas como Cco nesta mensagem.
Esse campo fica vazio para todas as mensagens recebidas, por definição.
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
Retornar
String
: os destinatários separados por vírgula são incluídos 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()
Recebe 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
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/
Veja também
getCc()
Recebe os destinatários separados por vírgula cc'd nesta 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
Retornar
String
: os destinatários separados por vírgula carregam 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
getDate()
Recebe 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
Retornar
Date
: a data e a hora 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/
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
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/
Veja também
getHeader(name)
Acessa o valor de um cabeçalho RFC 2822 de acordo com o 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. |
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.
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
Retornar
String
: o ID da mensagem.
getPlainBody()
Recebe o conteúdo do corpo da mensagem sem a formatação HTML. Esse método é mais complexo que getBody()
e demora mais.
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
Retornar
String
: o conteúdo de 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/
Veja também
getRawContent()
Recebe o conteúdo bruto desta mensagem. Isso é equivalente a "Mostrar original" na IU do Gmail.
Retornar
String
: o conteúdo bruto 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/
getReplyTo()
Recebe 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
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/
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
Retornar
String
: o assunto 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
getThread()
Recebe 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
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 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.getTo()); // Log the recipient of message
Retornar
String
: os destinatários 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/
Veja também
isDraft()
Recebe se a 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());
Retornar
Boolean
: se esta 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.
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());
Retornar
Boolean
: se a mensagem é um chat.
isInInbox()
Recebe 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());
Retornar
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()
Retornará true
se essa mensagem estiver na caixa de entrada prioritária. Caso contrário, retornará 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()); }
Retornar
Boolean
: 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 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());
Retornar
Boolean
: se a mensagem está na lixeira.
isStarred()
Recebe 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());
Retornar
Boolean
: se esta mensagem é marcada com estrela.
isUnread()
Recebe 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());
Retornar
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
Retornar
GmailMessage
: esta GmailMessage, útil para encadeamentos.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:
-
https://mail.google.com/
Veja também
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
Retornar
GmailMessage
: esta GmailMessage, útil para encadeamentos.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:
-
https://mail.google.com/
Veja também
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
Retornar
GmailMessage
: esta GmailMessage, útil para encadeamentos.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:
-
https://mail.google.com/
Veja também
refresh()
Recarrega esta mensagem e o estado associado do Gmail (útil caso os marcadores, o estado de leitura etc. tenham mudado).
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
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) é limitado à 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. |
Retornar
GmailMessage
: esta mensagem, útil para encadeamentos.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:
-
https://mail.google.com/
Veja também
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) é limitado à 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 a serem enviados com o e-mail |
bcc | String | Uma lista separada por vírgulas de endereços de e-mail para Cco |
cc | String | uma lista de endereços de e-mail separados por vírgulas para Cc |
from | String | O endereço do qual o e-mail deve ser enviado, que precisa ser um dos valores retornados por GmailApp.getAliases() . |
htmlBody | String | quando definidos, os dispositivos capazes de renderizar o HTML o usarão em vez do argumento de corpo obrigatório. Você pode adicionar um campo inlineImages opcional no corpo do HTML se tiver imagens in-line para seu e-mail |
inlineImages | Object | um objeto JavaScript que contém um mapeamento da chave de imagem (String ) para os dados de imagem (BlobSource ). Isso pressupõe que o parâmetro htmlBody é usado e contém referências a essas imagens no formato <img src="cid:imageKey" /> |
name | String | o nome do remetente do e-mail (padrão: o nome do usuário) |
noReply | Boolean | true : se o e-mail for enviado de um endereço genérico
sem resposta para desencorajar os destinatários a responder aos e-mails. Essa opção só
é possível para contas do Google Workspace, e não usuários do Gmail |
replyTo | String | Um endereço de e-mail para usar como endereço de resposta padrão (padrão: o endereço de e-mail do usuário) |
subject | String | uma nova linha de assunto para o e-mail; |
Retornar
GmailMessage
: esta mensagem, útil para encadeamentos.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:
-
https://mail.google.com/
Veja também
replyAll(body)
Respostas ao remetente usando o endereço para resposta e todos os destinatários desta mensagem. O tamanho do e-mail (incluindo cabeçalhos) é limitado pela 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. |
Retornar
GmailMessage
: esta mensagem,útil para encadeamentos.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:
-
https://mail.google.com/
Veja também
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) é limitado à 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 a serem enviados com o e-mail |
bcc | String | Uma lista separada por vírgulas de endereços de e-mail para Cco |
cc | String | uma lista de endereços de e-mail separados por vírgulas para Cc |
from | String | O endereço do qual o e-mail deve ser enviado, que precisa ser um dos valores retornados por GmailApp.getAliases() . |
htmlBody | String | quando definidos, os dispositivos capazes de renderizar o HTML o usarão em vez do argumento de corpo obrigatório. Você pode adicionar um campo inlineImages opcional no corpo do HTML se tiver imagens in-line para seu e-mail |
inlineImages | Object | um objeto JavaScript que contém um mapeamento da chave de imagem (String ) para os dados de imagem (BlobSource ). Isso pressupõe que o parâmetro htmlBody é usado e contém referências a essas imagens no formato <img src="cid:imageKey" /> |
name | String | o nome do remetente do e-mail (padrão: o nome do usuário) |
noReply | Boolean | true : se o e-mail for enviado de um endereço genérico
sem resposta para desencorajar os destinatários a responder aos e-mails. Essa opção só
é possível para contas do Google Workspace, e não usuários do Gmail |
replyTo | String | Um endereço de e-mail para usar como endereço de resposta padrão (padrão: o endereço de e-mail do usuário) |
subject | String | uma nova linha de assunto para o e-mail (máximo de 250 caracteres); |
Retornar
GmailMessage
: esta mensagem, útil para encadeamentos.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:
-
https://mail.google.com/
Veja também
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
Retornar
GmailMessage
: esta GmailMessage, útil para encadeamentos.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:
-
https://mail.google.com/
Veja também
unstar()
Estrela removida 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
Retornar
GmailMessage
: esta GmailMessage, útil para encadeamentos.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:
-
https://mail.google.com/