Class GmailApp

Cria um rascunho de e-mail. O tamanho do e-mail (incluindo cabeçalhos) é limitado pela cota.

// The code below creates a draft email with the current date and time.
var now = new Date();
GmailApp.createDraft("mike@example.com", "current time", "The time is: " + now.toString());

Parâmetros

Retornar

GmailDraft: o rascunho recém-criado do Gmail

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

• createDraft(recipient, subject, body, options)

Cria um rascunho de mensagem de e-mail com argumentos opcionais. O e-mail pode conter texto simples ou uma Corpo HTML. O tamanho do e-mail (incluindo os cabeçalhos, mas excluindo anexos) é limitado pela cota.

// Create a draft email with a file from Google Drive attached as a PDF.
var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.createDraft('mike@example.com', 'Attachment example', 'Please see attached file.', {
    attachments: [file.getAs(MimeType.PDF)],
    name: 'Automatic Emailer Script'
});

Parâmetros

Parâmetros avançados

Retornar

GmailDraft: o rascunho recém-criado do Gmail

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

• createDraft(recipient, subject, body)

Cria um novo rótulo de usuário com o nome fornecido.

// Creates the label @FOO and logs label: FOO
Logger.log("label: " + GmailApp.createLabel("FOO"));

Parâmetros

Retornar

GmailLabel: o rótulo 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

• deleteLabel(label)

Exclui o rótulo especificado.

// Have to get the label by name first
var label = GmailApp.getUserLabelByName("FOO");
GmailApp.deleteLabel(label);

Parâmetros

Retornar

GmailApp: o serviço do Gmail, ú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

• createLabel(name)

Recebe uma lista dos e-mails configurados como aliases dessa conta no Gmail.

É possível enviar uma mensagem de qualquer um desses aliases usando o botão "De" argumento opcional.

// Log the aliases for this Gmail account and send an email as the first one.
var me = Session.getActiveUser().getEmail();
var aliases = GmailApp.getAliases();
Logger.log(aliases);
if (aliases.length > 0) {
  GmailApp.sendEmail(me, 'From an alias', 'A message from an alias!', {'from': aliases[0]});
} else {
  GmailApp.sendEmail(me, 'No aliases found', 'You have no aliases.');
}

Retornar

String[]: uma matriz de aliases para esta conta.

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

• sendEmail(recipient, subject, body, options)

Recuperar o rascunho de uma mensagem de e-mail por ID.

Use-o em conjunto com getId() nos rascunhos do Gmail.

// Get the first draft message in your drafts folder
var draft = GmailApp.getDrafts()[0];
// Get its ID
var draftId = draft.getId();
// Now fetch the same draft using that ID.
var draftById = GmailApp.getDraft(draftId);
// Should always log true as they should be the same message
Logger.log(draft.getMessage().getSubject() == draftById.getMessage().getSubject());

Parâmetros

Retornar

GmailDraft: o rascunho com o código fornecido.

Gera

Error: se nenhum rascunho com o ID fornecido for encontrado.

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/

Recupera todos os rascunhos de mensagens.

// Logs the number of draft messages
var drafts = GmailApp.getDraftMessages();
Logger.log(drafts.length);

Retornar

GmailMessage[]: uma matriz de rascunhos de mensagens do Gmail.

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 todos os rascunhos de mensagens do Gmail.

var drafts = GmailApp.getDrafts();
for (var i = 0; i < drafts.length; i++) {
  Logger.log(drafts[i].getId());
}

Retornar

GmailDraft[]: uma matriz de mensagens de rascunho do Gmail.

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/

Recupera todas as conversas da Caixa de entrada, independentemente dos marcadores.

Essa chamada vai falhar quando o tamanho de todas as linhas de execução for muito grande para o sistema processar. Quando o tamanho da linha de execução for desconhecido e possivelmente muito grande, use o valor "paginado" chamada e especificar intervalos dos threads a serem recuperados em cada chamada.

// Log the subject lines of your Inbox
var threads = GmailApp.getInboxThreads();
for (var i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

Retornar

GmailThread[]: uma matriz de conversas do Gmail 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/

Recupera um intervalo de conversas do Caixa de entrada, independentemente dos marcadores.

// Log the subject lines of up to the first 50 emails in your Inbox
var threads = GmailApp.getInboxThreads(0, 50);
for (var i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

Parâmetros

Retornar

GmailThread[]: uma matriz de conversas do Gmail 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/

Recebe o número de conversas não lidas na caixa de entrada.

Logger.log("Messages unread in inbox: " + GmailApp.getInboxUnreadCount());

Retornar

Integer: o número de conversas na caixa de entrada que têm mensagens não lidas

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 uma mensagem por ID.

Use-o em conjunto com getId() nas mensagens do Gmail.

// Get the first message in the first thread of your inbox
var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
// Get its ID
var messageId = message.getId();
// Now fetch the same message using that ID.
var messageById = GmailApp.getMessageById(messageId);
// Should always log true as they should be the same message
Logger.log(message.getSubject() == messageById.getSubject());

Parâmetros

Retornar

GmailMessage: a mensagem com o ID fornecido.

Gera

Error: se nenhuma mensagem com o ID fornecido for encontrada.

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

• getThreadById(id)

Recuperar todas as mensagens na conversa especificada.

// Log all the subject lines in the first thread of your inbox
var thread = GmailApp.getInboxThreads(0, 1)[0];
var messages = GmailApp.getMessagesForThread(thread);
for (var i = 0 ; i < messages.length; i++) {
  Logger.log("subject: " + messages[i].getSubject());
}

Parâmetros

Retornar

GmailMessage[]: matriz de mensagens correspondentes a essa conversa

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

• getMessagesForThreads(threads)

Recuperar todas as mensagens nas conversas especificadas.

// Log the subject lines of all messages in the first two threads of your inbox
var thread = GmailApp.getInboxThreads(0, 2);
var messages = GmailApp.getMessagesForThreads(thread);
for (var i = 0 ; i < messages.length; i++) {
  for (var j = 0; j < messages[i].length; j++) {
    Logger.log("subject: " + messages[i][j].getSubject());
  }
}

Parâmetros

Retornar

GmailMessage[][]: uma matriz de matrizes de mensagens, em que cada item da matriz externa corresponde a um thread e a matriz interna contém as mensagens dessa linha

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

• getMessagesForThread(thread)

Recupera todas as conversas da Caixa prioritária, independentemente dos marcadores.

Essa chamada vai falhar quando o tamanho de todas as linhas de execução for muito grande para o sistema processar. Quando o tamanho da linha de execução for desconhecido e possivelmente muito grande, use o valor "paginado" chamada e especificar intervalos dos threads a serem recuperados em cada chamada.

Logger.log("# of messages in your Priority Inbox: " +
           GmailApp.getPriorityInboxThreads().length);

Retornar

GmailThread[]: uma matriz de conversas do Gmail na Caixa 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/

Recupera um intervalo de conversas da Caixa prioritária, independentemente dos marcadores.

// Will log some number 2 or less
Logger.log("# of messages in your Priority Inbox: " +
           GmailApp.getPriorityInboxThreads(0, 2).length);

Parâmetros

Retornar

GmailThread[]: uma matriz de conversas do Gmail na Caixa 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/

Acessa o número de conversas não lidas na Caixa prioritária.

Logger.log("Number of unread emails in your Priority Inbox : " +
           GmailApp.getPriorityInboxUnreadCount());

Retornar

Integer: o número de conversas na Caixa prioritária que tem mensagens não lidas

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/

Recupera todas as conversas de spam, independentemente dos marcadores.

Essa chamada vai falhar quando o tamanho de todas as linhas de execução for muito grande para o sistema processar. Quando o tamanho da linha de execução for desconhecido e possivelmente muito grande, use o valor "paginado" chamada e especificar intervalos dos threads a serem recuperados em cada chamada.

Logger.log("# of total spam threads: " + GmailApp.getSpamThreads().length);

Retornar

GmailThread[]: uma matriz de conversas do Gmail na pasta de spam.

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/

Recupera uma série de conversas de spam, independentemente dos marcadores.

// Will log a number at most 5
Logger.log("# of total spam threads: " + GmailApp.getSpamThreads(0, 5).length);

Parâmetros

Retornar

GmailThread[]: uma matriz de conversas do Gmail na pasta de spam.

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 o número de conversas não lidas que são spam.

// Unless you actually read stuff in your spam folder, this should be the same as
// the number of messages in your spam folder.
Logger.log("# unread threads that are spam: " + GmailApp.getSpamUnreadCount());

Retornar

Integer: o número de conversas de spam com mensagens não lidas

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/

Recupera todas as conversas marcadas com estrela, independentemente dos rótulos.

Essa chamada vai falhar quando o tamanho de todas as linhas de execução for muito grande para o sistema processar. Quando o tamanho da linha de execução for desconhecido e possivelmente muito grande, use o valor "paginado" chamada e especificar intervalos dos threads a serem recuperados em cada chamada.

// Logs the number of starred threads
Logger.log("# Starred threads: " + GmailApp.getStarredThreads().length);

Retornar

GmailThread[]: uma matriz de conversas do Gmail com estrela

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/

Recupera um intervalo de conversas marcadas com estrela, independentemente dos rótulos.

// Logs the number of starred threads to a maximum of 5
Logger.log("# Starred threads: " + GmailApp.getStarredThreads(0, 5).length);

Parâmetros

Retornar

GmailThread[]: uma matriz de conversas do Gmail com estrela

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 o número de conversas não lidas com estrela.

Logger.log("# unread and starred: " + GmailApp.getStarredUnreadCount());

Retornar

Integer: o número de conversas com estrela que têm mensagens não lidas

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 um thread por ID.

Use-o em conjunto com getId() nas conversas do Gmail.

// Gets the first inbox thread.
const firstThread = GmailApp.getInboxThreads(0,1)[0];
// Gets the same thread by ID.
const threadById = GmailApp.getThreadById(firstThread.getId());
// Verifies that they are the same.
console.log(firstThread.getFirstMessageSubject() === threadById.getFirstMessageSubject());

Parâmetros

Retornar

GmailThread: a linha de execução com o ID fornecido ou null, se não for encontrada.

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

• getMessageById(id)

Recupera todas as conversas da lixeira, independentemente dos marcadores.

Essa chamada vai falhar quando o tamanho de todas as linhas de execução for muito grande para o sistema processar. Quando o tamanho da linha de execução for desconhecido e possivelmente muito grande, use o valor "paginado" chamada e especificar intervalos dos threads a serem recuperados em cada chamada.

Logger.log("# of total trash threads: " + GmailApp.getTrashThreads().length);

Retornar

GmailThread[]: uma matriz de conversas do Gmail na lixeira.

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/

Recupera um intervalo de conversas da lixeira, independentemente dos rótulos.

// Will log a number at most 5
Logger.log("# of total trash threads: " + GmailApp.getTrashThreads(0, 5).length);

Parâmetros

Retornar

GmailThread[]: uma matriz de conversas do Gmail na lixeira.

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/

Recupera um rótulo dado o nome dele.

var labelObject = GmailApp.getUserLabelByName("myLabel");

Parâmetros

Retornar

GmailLabel: o marcador do Gmail com o nome fornecido.

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/

Recupera uma lista de marcadores criados pelo usuário.

// Logs all of the names of your labels
var labels = GmailApp.getUserLabels();
for (var i = 0; i < labels.length; i++) {
  Logger.log("label: " + labels[i].getName());
}

Retornar

GmailLabel[]: matriz de rótulos criados pelo usuário

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 e força a atualização dela.

// Mark the first message in the first thread of your inbox as read
var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageRead(message);

Parâmetros

Retornar

GmailApp: o serviço do Gmail, ú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

• markMessageUnread(message)

Marca esta mensagem como não lida e força a atualização dela.

// Mark the first message in the first thread of your inbox as unread
var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageUnread(message);

Parâmetros

Retornar

GmailApp: o serviço do Gmail, ú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

• markMessageRead(message)

Marca essas mensagens como lidas e força a atualização delas.

// Mark first three messages in the first inbox thread as read.
// Assumes that the first inbox thread has 3 messages in it.
var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
var messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesRead(thread.getMessages());

Parâmetros

Retornar

GmailApp: o serviço do Gmail, ú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

• markMessagesUnread(messages)

Marca essas mensagens como não lidas e força a atualização delas.

// Mark first three messages in the first inbox thread as unread.
// Assumes that the first inbox thread has 3 messages in it
var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
var messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesUnread(thread.getMessages());

Parâmetros

Retornar

GmailApp: o serviço do Gmail, ú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

• markMessagesRead(messages)

Marca esta linha de execução como importante e força a linha de execução a ser atualizada.

// Marks first inbox thread as important
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadImportant(thread);

Parâmetros

Retornar

GmailApp: o serviço do Gmail, ú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

• markThreadUnimportant(thread)

Marca a linha de execução como lida e força a atualização dela.

// Marks first inbox thread as read
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadRead(thread);

Parâmetros

Retornar

GmailApp: o serviço do Gmail, ú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

• markThreadUnread(thread)

Marca esta conversa como não importante e força a atualização dela.

// Marks first inbox thread as unimportant
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnimportant(thread);

Parâmetros

Retornar

GmailApp: o serviço do Gmail, ú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

• markThreadImportant(thread)

Marca esta conversa como não lida e força a atualização dela.

// Marks first inbox thread as unread
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnread(thread);

Parâmetros

Retornar

GmailApp: o serviço do Gmail, ú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

• markThreadRead(thread)

Marca essas linhas de execução como importantes e força a atualização delas.

// Marks first two threads in inbox as important
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsImportant(threads);

Parâmetros

Retornar

GmailApp: o serviço do Gmail, ú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

• markThreadsUnimportant(threads)

Marca essas linhas de execução como lidas e força a atualização delas.

// Marks first two threads in inbox as read
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsRead(threads);

Parâmetros

Retornar

GmailApp: o serviço do Gmail, ú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

• markThreadsUnread(threads)

Marca essas linhas de execução como não importantes e força a atualização delas.

// Marks first two threads in inbox as unimportant
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnimportant(threads);

Parâmetros

Retornar

GmailApp: o serviço do Gmail, ú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

• markThreadsImportant(threads)

Marca essas conversas como não lidas e força a atualização delas.

// Marks first two threads in inbox as unread
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnread(threads);

Parâmetros

Retornar

GmailApp: o serviço do Gmail, ú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

• markThreadsRead(threads)

Move a mensagem para a lixeira e força a atualização dela.

// Move the first message in your inbox to trash
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var firstMessage = firstThread.getMessages()[0];
GmailApp.moveMessageToTrash(firstMessage);

Parâmetros

Retornar

GmailApp: o serviço do Gmail (ú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

• moveMessagesToTrash(messages)

Move as mensagens especificadas para a lixeira e força a atualização delas.

// Move first two messages in your inbox to trash
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var messages = firstThread.getMessages();
var toDelete = [messages[0], messages[1]];
GmailApp.moveMessagesToTrash(toDelete);

Parâmetros

Retornar

GmailApp: o serviço do Gmail (ú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

• moveMessageToTrash(message)

Move esta linha de execução para o arquivo e força a linha de execução a ser atualizada.

// Archive the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
GmailApp.moveThreadToArchive(firstThread);

Parâmetros

Retornar

GmailApp: o serviço do Gmail, ú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

• moveThreadToInbox(thread)
• moveThreadToSpam(thread)
• moveThreadToTrash(thread)

Move esta conversa para a caixa de entrada e força a atualização da conversa.

// Find a thread not already in your inbox
var thread = GmailApp.search("-in:inbox")[0]; // Get the first one
GmailApp.moveThreadToInbox(thread);

Parâmetros

Retornar

GmailApp: o serviço do Gmail, ú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

• moveThreadToTrash(thread)
• moveThreadToSpam(thread)
• moveThreadToArchive(thread)

Move esta conversa para a caixa de spam e força a atualização dela.

// Tag first thread in inbox as spam
var firstThread = GmailApp.getInboxThreads(0,1)[0];
GmailApp.moveThreadToSpam(firstThread);

Parâmetros

Retornar

GmailApp: o serviço do Gmail, ú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

• moveThreadToTrash(thread)
• moveThreadToInbox(thread)
• moveThreadToArchive(thread)

Move a linha de execução para a lixeira e força a atualização dela.

// Move first thread in inbox to trash
var firstThread = GmailApp.getInboxThreads(0,1)[0];
GmailApp.moveThreadToTrash(firstThread);

Parâmetros

Retornar

GmailApp: o serviço do Gmail, ú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

• moveThreadToInbox(thread)
• moveThreadToSpam(thread)
• moveThreadToArchive(thread)

Move essas linhas de execução para o arquivo e força a atualização delas.

// Move first two threads in your inbox to the archive
var firstTwoThreads = GmailApp.getInboxThreads(0,2);
GmailApp.moveThreadsToArchive(firstTwoThreads);

Parâmetros

Retornar

GmailApp: o serviço do Gmail, ú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

• moveThreadsToInbox(threads)
• moveThreadsToSpam(threads)
• moveThreadsToTrash(threads)

Move essas conversas para a caixa de entrada e força a atualização delas.

// Find two threads not already in your inbox
var firstTwoThreads = GmailApp.search("-in:inbox", 0, 2);
GmailApp.moveThreadsToInbox(firstTwoThreads);

Parâmetros

Retornar

GmailApp: o serviço do Gmail, ú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

• moveThreadsToTrash(threads)
• moveThreadsToSpam(threads)
• moveThreadsToArchive(threads)

Move estas conversas para a pasta "Spam" e força a atualização delas.

// Move first two threads in your inbox to spam
var firstTwoThreads = GmailApp.getInboxThreads(0,2);
GmailApp.moveThreadsToSpam(firstTwoThreads);

Parâmetros

Retornar

GmailApp: o serviço do Gmail, ú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

• moveThreadsToInbox(threads)
• moveThreadsToTrash(threads)
• moveThreadsToArchive(threads)

Move essas conversas para a lixeira e força a atualização delas.

// Move first two threads in your inbox to trash
var firstTwoThreads = GmailApp.getInboxThreads(0,2);
GmailApp.moveThreadsToTrash(firstTwoThreads);

Parâmetros

Retornar

GmailApp: o serviço do Gmail, ú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

• moveThreadsToInbox(threads)
• moveThreadsToSpam(threads)
• moveThreadsToArchive(threads)

Recarrega a mensagem e o estado associado do Gmail (útil caso os marcadores, o estado de leitura etc., foram alterados).

var firstThread = GmailApp.getInboxThreads(0,1)[0];
var firstMessage = firstThread.getMessages()[0];
// ...Do something that may take a while here....
GmailApp.refreshMessage(firstMessage);
// ...Do more stuff with firstMessage...

Parâmetros

Retornar

GmailApp: o serviço do Gmail, ú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

• refreshMessages(messages)

Recarrega as mensagens e o estado associado do Gmail (útil caso os marcadores, o estado de leitura etc., foram alterados).

var firstThread = GmailApp.getInboxThreads(0,1)[0];
var coupleOfMessages = firstThread.getMessages().slice(0, 2);
// ...Do something that may take a while here....
GmailApp.refreshMessages(coupleOfMessages);
// ...Do more stuff with coupleOfMessages...

Parâmetros

Retornar

GmailApp: o serviço do Gmail, ú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

• refreshMessage(message)

Recarrega a conversa e o estado associado do Gmail (útil caso os marcadores, o estado de leitura etc., foram alterados).

var firstThread = GmailApp.getInboxThreads(0,1)[0];
// ...Do something that may take a while here....
GmailApp.refreshThread(firstThread);
// ... Do more stuff with the thread ...

Parâmetros

Retornar

GmailApp: o serviço do Gmail, ú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

• refreshThreads(threads)

Recarrega as conversas e o estado associado do Gmail (útil caso os marcadores, o estado de leitura etc., foram alterados).

var threads = GmailApp.getInboxThreads(0, 3);
// ...Do something that may take a while here....
GmailApp.refreshThreads(threads);
// ... Do more stuff with threads ...

Parâmetros

Retornar

GmailApp: o serviço do Gmail, ú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

• refreshThread(thread)

Pesquise no Gmail com a consulta fornecida.

Essa chamada vai falhar quando o tamanho de todas as linhas de execução for muito grande para o sistema processar. Quando o tamanho da linha de execução for desconhecido e possivelmente muito grande, use o valor "paginado" chamada e especificar intervalos dos threads a serem recuperados em cada chamada.

// Find starred messages with subject IMPORTANT
var threads = GmailApp.search('is:starred subject:"IMPORTANT"');

Parâmetros

Retornar

GmailThread[]: uma matriz de conversas do Gmail que correspondem a esta consulta.

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/

Pesquise no Gmail com a consulta fornecida.

// Find starred messages with subject IMPORTANT and return second batch of 10.
// Assumes there are at least 11 of them, otherwise this will return an empty array.
var threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);

Parâmetros

Retornar

GmailThread[]: uma matriz de conversas do Gmail que correspondem a esta consulta.

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/

Envia uma mensagem de e-mail. O tamanho do e-mail (incluindo cabeçalhos) é limitado pela cota.

// The code below will send an email with the current date and time.
var now = new Date();
GmailApp.sendEmail("mike@example.com", "current time", "The time is: " + now.toString());

Parâmetros

Retornar

GmailApp: o serviço do Gmail, ú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

• sendEmail(recipient, subject, body, options)

Envia uma mensagem de e-mail com argumentos opcionais. O e-mail pode conter texto simples ou um arquivo HTML corpo O tamanho do e-mail (incluindo os cabeçalhos, mas excluindo anexos) é limitado pela cota.

// Send an email with a file from Google Drive attached as a PDF.
var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.sendEmail('mike@example.com', 'Attachment example', 'Please see the attached file.', {
    attachments: [file.getAs(MimeType.PDF)],
    name: 'Automatic Emailer Script'
});

Parâmetros

Parâmetros avançados

Retornar

GmailApp: o serviço do Gmail, ú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

• sendEmail(recipient, subject, body)

Define a mensagem atual token de acesso, que permite ao script acessar as propriedades atuais do GmailMessage.

Apenas projetos de complementos do Google Workspace que usam escopos de mensagens atuais do Gmail. exigem esse método.

function handleAddonActionEvent(e) {
  var accessToken = e.messageMetadata.accessToken;
  var messageId = e.messageMetadata.messageId;
  GmailApp.setCurrentMessageAccessToken(accessToken);
  var mailMessage = GmailApp.getMessageById(messageId);
  // Do something with mailMessage
}

Parâmetros

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/

Adiciona uma estrela à mensagem e força a atualização dela.

// Stars the first message in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
GmailApp.starMessage(message);

Parâmetros

Retornar

GmailApp: o serviço do Gmail, ú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

• starMessages(messages)

Adiciona estrelas a essas mensagens e força a atualização delas.

// Stars the first three messages in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.starMessages(coupleOfMessages);

Parâmetros

Retornar

GmailApp: o serviço do Gmail, ú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

• starMessage(message)

Remove uma estrela desta mensagem e força a atualização da mensagem.

// Unstars the first message in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
GmailApp.unstarMessage(message);

Parâmetros

Retornar

GmailApp: o serviço do Gmail, ú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

• unstarMessages(messages)

Remove estrelas dessas mensagens e força a atualização delas.

// Unstars the first three messages in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.unstarMessages(coupleOfMessages);

Parâmetros

Retornar

GmailApp: o serviço do Gmail, ú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

• unstarMessage(message)