Class GmailMessage

Cria uma mensagem de rascunho que responde ao remetente usando o endereço de resposta. O tamanho do e-mail (incluindo cabeçalhos) é limitado por cota.

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

Parâmetros

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 adequados 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 que responde ao remetente usando o endereço de 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.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReply('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  cc: 'another@example.com',
});

Parâmetros

Parâmetros avançados

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 adequados da API REST relacionada:

• https://mail.google.com/

Consulte também

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

Cria um rascunho de mensagem que responde ao remetente usando o endereço de resposta e todos os destinatários da mensagem. O tamanho do e-mail (incluindo cabeçalhos) é limitado por cota.

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

Parâmetros

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 adequados 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 que responde ao remetente usando o endereço de 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.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReplyAll('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  cc: 'another@example.com',
});

Parâmetros

Parâmetros avançados

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 adequados da API REST relacionada:

• https://mail.google.com/

Consulte também

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

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

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

Parâmetros

Retornar

GmailMessage: esta mensagem é útil para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados 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 um corpo HTML. O tamanho do e-mail (incluindo cabeçalhos) é limitado pela cota.

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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 encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados 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 de blob para esta mensagem.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados 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 de blob para esta mensagem.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

• https://mail.google.com/

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

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

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

Retornar

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

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

• https://mail.google.com/

Consulte também

• getTo()

Recebe o conteúdo HTML do corpo desta mensagem.

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

Retornar

String: o conteúdo do corpo da mensagem.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

• https://mail.google.com/

Consulte também

• getSubject()

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

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

Retornar

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

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

• https://mail.google.com/

Consulte também

• getTo()

Recebe a data e a hora dessa mensagem.

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

Retornar

Date: a data e a hora da mensagem.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

• https://mail.google.com/

Extrai o remetente desta mensagem.

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

Retornar

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

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

• https://mail.google.com/

Consulte também

• getReplyTo()

Extrai o valor de um cabeçalho RFC 2822 com base no nome do cabeçalho.

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

Parâmetros

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 adequados da API REST relacionada:

• https://mail.google.com/

Extrai o ID desta mensagem.

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

Retornar

String: o ID da mensagem.

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

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

Retornar

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

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

• https://mail.google.com/

Consulte também

• getSubject()

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

Retornar

String: o conteúdo bruto da mensagem.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

• https://mail.google.com/

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

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

Retornar

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

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

• https://mail.google.com/

Consulte também

• getCc()

Extrai o assunto desta mensagem.

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

Retornar

String: o assunto da mensagem.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

• https://mail.google.com/

Consulte também

• getAttachments()

Recebe a linha de execução que contém esta mensagem.

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

Retornar

GmailThread: a 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 adequados da API REST relacionada:

• https://mail.google.com/

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

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

Retornar

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

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

• https://mail.google.com/

Consulte também

• getCc()

Verifica se a mensagem é um rascunho.

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

Retornar

Boolean: indica se a mensagem é um rascunho.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

• https://mail.google.com/

Verifica se a mensagem é um chat.

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

Retornar

Boolean: indica se a mensagem é um chat.

Verifica se a mensagem está na caixa de entrada.

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

Retornar

Boolean: indica se a mensagem está na caixa de entrada.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

• https://mail.google.com/

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

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

Retornar

Boolean: indica se a mensagem está na caixa de entrada prioritária.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

• https://mail.google.com/

Verifica se a mensagem está na lixeira.

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

Retornar

Boolean: indica se a mensagem está na lixeira.

Verifica se a mensagem está marcada com estrela.

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

Retornar

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

Verifica se a mensagem está lida.

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

Retornar

Boolean: o status de leitura desta mensagem.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

• https://mail.google.com/

Marca a mensagem como lida.

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

Retornar

GmailMessage: esta 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 adequados da API REST relacionada:

• https://mail.google.com/

Consulte também

• isUnread()

Marca a mensagem como não lida.

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

Retornar

GmailMessage: esta 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 adequados da API REST relacionada:

• https://mail.google.com/

Consulte também

• isUnread()

Move a mensagem para a lixeira.

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

Retornar

GmailMessage: esta 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 adequados da API REST relacionada:

• https://mail.google.com/

Consulte também

• isInTrash()

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

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

Retornar

GmailMessage: esta mensagem para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

• https://mail.google.com/

Resposta ao remetente desta mensagem usando o endereço de resposta. O tamanho do e-mail (incluindo cabeçalhos) é limitado pela cota.

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

Parâmetros

Retornar

GmailMessage: esta mensagem é útil para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados 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 de 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.

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

Parâmetros

Parâmetros avançados

Retornar

GmailMessage: esta mensagem é útil para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

• https://mail.google.com/

Consulte também

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

Resposta ao remetente usando o endereço de resposta e todos os destinatários desta mensagem. O tamanho do e-mail (incluindo cabeçalhos) é limitado por cota.

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

Parâmetros

Retornar

GmailMessage: esta mensagem é útil para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados 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 de 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.

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

Parâmetros

Parâmetros avançados

Retornar

GmailMessage: esta mensagem é útil para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

• https://mail.google.com/

Consulte também

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

Marca a mensagem com uma estrela.

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

Retornar

GmailMessage: esta 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 adequados da API REST relacionada:

• https://mail.google.com/

Consulte também

• unstar()

Remove a estrela da mensagem.

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

Retornar

GmailMessage: esta 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 adequados da API REST relacionada:

• https://mail.google.com/

Consulte também

• star()