Class GmailMessage

Cria uma mensagem de rascunho usando o endereço para resposta para responder ao remetente. A o tamanho do e-mail (incluindo cabeçalhos) for 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

Retornar

GmailDraft: o rascunho recém-criado.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Consulte também

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

Cria uma mensagem de rascunho 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) é cota limitada.

// 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

Retornar

GmailDraft: o rascunho recém-criado.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Consulte também

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

Cria uma mensagem de rascunho respondendo ao remetente usando o endereço para resposta e todos os destinatários de esta 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

Retornar

GmailDraft: o rascunho recém-criado.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Consulte também

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

Cria uma mensagem de rascunho respondendo ao remetente 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) é cota limitada.

// 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

Retornar

GmailDraft: o rascunho recém-criado.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Consulte também

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

Encaminha 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

Retornar

GmailMessage: esta mensagem é útil para encadeamentos.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Consulte 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 cabeçalhos) é cota limitada.

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

Retornar

GmailMessage: esta mensagem é útil para encadeamentos.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Consulte também

• forward(recipient)

Extrai todos os anexos desta mensagem.

Retornar

GmailAttachment[]: uma matriz de anexos Blob para a mensagem.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Extrai todos os anexos desta mensagem.

Parâmetros

Parâmetros avançados

Retornar

GmailAttachment[]: uma matriz de anexos Blob para a mensagem.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

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

Por definição, esse campo fica 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

Retornar

String: os destinatários separados por vírgula adicionados como Cco nesta mensagem.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Consulte 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

Retornar

String: o conteúdo do corpo da mensagem.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Consulte também

• getSubject()

Extrai os destinatários separados por vírgula em cópia 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 em cópia nesta mensagem.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Consulte também

• getTo()

Recebe a data e a hora 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.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 precisam de autorização com um ou mais dos escopos a seguir 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

Retornar

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

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Consulte também

• getReplyTo()

Extrai 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

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 precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Extrai 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.

Extrai o conteúdo do corpo desta mensagem sem formatação HTML. Isso é mais complexo do 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 simples do corpo da mensagem.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Consulte também

• getSubject()

Extrai o conteúdo bruto desta mensagem. É equivalente a "Mostrar original" na interface do Gmail.

Retornar

String: o conteúdo bruto da mensagem.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir 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

Retornar

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

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Consulte 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

Retornar

String: o assunto da mensagem.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Consulte também

• getAttachments()

Extrai a conversa que contém a 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 a mensagem.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir 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

Retornar

String: os destinatários da mensagem separados por vírgula.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Consulte também

• getCc()

Descobre 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());

Retornar

Boolean: indica se a mensagem é um rascunho.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Descobre se esta mensagem é um bate-papo.

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: indica se a mensagem é um chat.

Descobre se esta 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á ou não na caixa de entrada.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Retorna true se esta mensagem estiver na caixa de entrada prioritária. retorna false caso contrário.

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: indica se a mensagem está na caixa de entrada prioritária.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Descobre 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: indica se a mensagem está na lixeira.

Descobre 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: indica se a mensagem está ou não com estrela.

Extrai 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 da mensagem.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir 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

Retornar

GmailMessage: esta GmailMessage, útil para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Consulte 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

Retornar

GmailMessage: esta GmailMessage, útil para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Consulte 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

Retornar

GmailMessage: esta GmailMessage, útil para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Consulte também

• isInTrash()

Recarrega esta mensagem e o estado associado do Gmail (útil caso os marcadores, o estado de leitura etc., foram 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

Retornar

GmailMessage: esta mensagem para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir 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 cabeçalhos) é cota limitada.

// 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

Retornar

GmailMessage: esta mensagem é útil para encadeamentos.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Consulte 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 cabeçalhos) é cota limitada.

// 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

Retornar

GmailMessage: esta mensagem é útil para encadeamentos.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Consulte também

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

Responde 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.

// 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

Retornar

GmailMessage: esta mensagem,útil para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Consulte 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 cabeçalhos) é cota limitada.

// 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

Retornar

GmailMessage: esta mensagem é útil para encadeamentos.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Consulte 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

Retornar

GmailMessage: esta GmailMessage, útil para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Consulte também

• unstar()

Removendo 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

Retornar

GmailMessage: esta GmailMessage, útil para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

• https://mail.google.com/

Consulte também

• star()