Class GmailMessage

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

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

• reply(body)
• createDraftReply(body, options)
• createDraftReplyAll(body)
• createDraftReplyAll(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

Parâmetros avançados

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

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

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

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

• replyAll(body)
• createDraftReply(body)
• createDraftReply(body, options)
• 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

Parâmetros avançados

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

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

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

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

Parâmetros avançados

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)

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/

Extrai todos os anexos desta mensagem.

Parâmetros

Parâmetros avançados

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/

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

• getTo()

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

• getSubject()

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

• getTo()

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/

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

• getReplyTo()

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

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/

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.

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

• getSubject()

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/

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

• getCc()

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

• getAttachments()

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/

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

• getCc()

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/

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.

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/

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/

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.

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.

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/

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

• isUnread()

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

• isUnread()

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

• isInTrash()

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/

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

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)
• replyAll(body)
• replyAll(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

Parâmetros avançados

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)
• replyAll(body)
• replyAll(body, options)

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

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

Parâmetros avançados

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)
• reply(body, options)
• replyAll(body)

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/

Veja também

• star()