Concede acesso a conversas, mensagens e marcadores do Gmail.
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
createDraft(recipient, subject, body) | GmailDraft | Cria um rascunho de e-mail. |
createDraft(recipient, subject, body, options) | GmailDraft | Cria um rascunho de mensagem de e-mail com argumentos opcionais. |
createLabel(name) | GmailLabel | Cria um novo rótulo de usuário com o nome fornecido. |
deleteLabel(label) | GmailApp | Exclui o rótulo especificado. |
getAliases() | String[] | Recebe uma lista dos e-mails configurados como aliases dessa conta no Gmail. |
getDraft(draftId) | GmailDraft | Recuperar o rascunho de uma mensagem de e-mail por ID. |
getDraftMessages() | GmailMessage[] | Recupera todos os rascunhos de mensagens. |
getDrafts() | GmailDraft[] | Recebe todos os rascunhos de mensagens do Gmail. |
getInboxThreads() | GmailThread[] | Recupera todas as conversas da Caixa de entrada, independentemente dos marcadores. |
getInboxThreads(start, max) | GmailThread[] | Recupera um intervalo de conversas do Caixa de entrada, independentemente dos marcadores. |
getInboxUnreadCount() | Integer | Recebe o número de conversas não lidas na caixa de entrada. |
getMessageById(id) | GmailMessage | Recebe uma mensagem por ID. |
getMessagesForThread(thread) | GmailMessage[] | Recuperar todas as mensagens na conversa especificada. |
getMessagesForThreads(threads) | GmailMessage[][] | Recuperar todas as mensagens nas conversas especificadas. |
getPriorityInboxThreads() | GmailThread[] | Recupera todas as conversas da Caixa prioritária, independentemente dos marcadores. |
getPriorityInboxThreads(start, max) | GmailThread[] | Recupera um intervalo de conversas da Caixa prioritária, independentemente dos marcadores. |
getPriorityInboxUnreadCount() | Integer | Acessa o número de conversas não lidas na Caixa prioritária. |
getSpamThreads() | GmailThread[] | Recupera todas as conversas de spam, independentemente dos marcadores. |
getSpamThreads(start, max) | GmailThread[] | Recupera uma série de conversas de spam, independentemente dos marcadores. |
getSpamUnreadCount() | Integer | Recebe o número de conversas não lidas que são spam. |
getStarredThreads() | GmailThread[] | Recupera todas as conversas marcadas com estrela, independentemente dos rótulos. |
getStarredThreads(start, max) | GmailThread[] | Recupera um intervalo de conversas marcadas com estrela, independentemente dos rótulos. |
getStarredUnreadCount() | Integer | Recebe o número de conversas não lidas com estrela. |
getThreadById(id) | GmailThread | Recebe um thread por ID. |
getTrashThreads() | GmailThread[] | Recupera todas as conversas da lixeira, independentemente dos marcadores. |
getTrashThreads(start, max) | GmailThread[] | Recupera um intervalo de conversas da lixeira, independentemente dos rótulos. |
getUserLabelByName(name) | GmailLabel | Recupera um rótulo dado o nome dele. |
getUserLabels() | GmailLabel[] | Recupera uma lista de marcadores criados pelo usuário. |
markMessageRead(message) | GmailApp | Marca a mensagem como lida e força a atualização dela. |
markMessageUnread(message) | GmailApp | Marca esta mensagem como não lida e força a atualização dela. |
markMessagesRead(messages) | GmailApp | Marca essas mensagens como lidas e força a atualização delas. |
markMessagesUnread(messages) | GmailApp | Marca essas mensagens como não lidas e força a atualização delas. |
markThreadImportant(thread) | GmailApp | Marca esta linha de execução como importante e força a linha de execução a ser atualizada. |
markThreadRead(thread) | GmailApp | Marca a linha de execução como lida e força a atualização dela. |
markThreadUnimportant(thread) | GmailApp | Marca esta conversa como não importante e força a atualização dela. |
markThreadUnread(thread) | GmailApp | Marca esta conversa como não lida e força a atualização dela. |
markThreadsImportant(threads) | GmailApp | Marca essas linhas de execução como importantes e força a atualização delas. |
markThreadsRead(threads) | GmailApp | Marca essas linhas de execução como lidas e força a atualização delas. |
markThreadsUnimportant(threads) | GmailApp | Marca essas linhas de execução como não importantes e força a atualização delas. |
markThreadsUnread(threads) | GmailApp | Marca essas conversas como não lidas e força a atualização delas. |
moveMessageToTrash(message) | GmailApp | Move a mensagem para a lixeira e força a atualização dela. |
moveMessagesToTrash(messages) | GmailApp | Move as mensagens especificadas para a lixeira e força a atualização delas. |
moveThreadToArchive(thread) | GmailApp | Move esta linha de execução para o arquivo e força a linha de execução a ser atualizada. |
moveThreadToInbox(thread) | GmailApp | Move esta conversa para a caixa de entrada e força a atualização da conversa. |
moveThreadToSpam(thread) | GmailApp | Move esta conversa para a caixa de spam e força a atualização dela. |
moveThreadToTrash(thread) | GmailApp | Move a linha de execução para a lixeira e força a atualização dela. |
moveThreadsToArchive(threads) | GmailApp | Move essas linhas de execução para o arquivo e força a atualização delas. |
moveThreadsToInbox(threads) | GmailApp | Move essas conversas para a caixa de entrada e força a atualização delas. |
moveThreadsToSpam(threads) | GmailApp | Move estas conversas para a pasta "Spam" e força a atualização delas. |
moveThreadsToTrash(threads) | GmailApp | Move essas conversas para a lixeira e força a atualização delas. |
refreshMessage(message) | GmailApp | Recarrega a mensagem e o estado associado do Gmail (útil caso os marcadores, o estado de leitura etc., foram alterados). |
refreshMessages(messages) | GmailApp | Recarrega as mensagens e o estado associado do Gmail (útil caso os marcadores, o estado de leitura etc., foram alterados). |
refreshThread(thread) | GmailApp | Recarrega a conversa e o estado associado do Gmail (útil caso os marcadores, o estado de leitura etc., foram alterados). |
refreshThreads(threads) | GmailApp | Recarrega as conversas e o estado associado do Gmail (útil caso os marcadores, o estado de leitura etc., foram alterados). |
search(query) | GmailThread[] | Pesquise no Gmail com a consulta fornecida. |
search(query, start, max) | GmailThread[] | Pesquise no Gmail com a consulta fornecida. |
sendEmail(recipient, subject, body) | GmailApp | Envia uma mensagem de e-mail. |
sendEmail(recipient, subject, body, options) | GmailApp | Envia uma mensagem de e-mail com argumentos opcionais. |
setCurrentMessageAccessToken(accessToken) | void | Define a mensagem atual
token de acesso, que permite ao script acessar as propriedades atuais do GmailMessage . |
starMessage(message) | GmailApp | Adiciona uma estrela à mensagem e força a atualização dela. |
starMessages(messages) | GmailApp | Adiciona estrelas a essas mensagens e força a atualização delas. |
unstarMessage(message) | GmailApp | Remove uma estrela desta mensagem e força a atualização da mensagem. |
unstarMessages(messages) | GmailApp | Remove estrelas dessas mensagens e força a atualização delas. |
Documentação detalhada
createDraft(recipient, subject, body)
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
Nome | Tipo | Descrição |
---|---|---|
recipient | String | lista separada por vírgulas de endereços de e-mail |
subject | String | assunto do e-mail |
body | String | corpo do e-mail |
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
Nome | Tipo | Descrição |
---|---|---|
recipient | String | os endereços do destinatário |
subject | String | linha de assunto |
body | String | no corpo do e-mail |
options | Object | um objeto JavaScript que especifica parâmetros avançados, como listado abaixo |
Parâmetros avançados
Nome | Tipo | Descrição |
---|---|---|
attachments | BlobSource[] | um matriz de arquivos para enviar com o e-mail |
bcc | String | uma lista separada por vírgulas de endereços de e-mail para Cco |
cc | String | uma lista separada por vírgulas de endereços de e-mail para Cc |
from | String | o endereço do qual o e-mail deve ser enviado, que deve ser um
dos valores retornados por getAliases() |
htmlBody | String | Se definido, ele será usado pelos dispositivos capazes de processar HTML
do argumento "body" obrigatório. é possível adicionar um campo inlineImages opcional em HTML
corpo se você tiver imagens inline para seu e-mail |
inlineImages | Object | um objeto JavaScript que contém um mapeamento da chave de imagem
(String ) aos dados da imagem (BlobSource ); Isso pressupõe que o parâmetro htmlBody é usado e contém referências a essas imagens no formato <img src="cid:imageKey" /> |
name | String | o nome do remetente do e-mail (padrão: o nome do usuário) |
replyTo | String | um endereço de e-mail para ser usado como o endereço padrão para resposta (padrão: endereço de e-mail do usuário) |
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
createLabel(name)
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
Nome | Tipo | Descrição |
---|---|---|
name | String | o nome do novo rótulo |
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
Nome | Tipo | Descrição |
---|---|---|
label | GmailLabel | o rótulo a ser excluído |
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
getAliases()
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
getDraft(draftId)
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
Nome | Tipo | Descrição |
---|---|---|
draftId | String | o ID do rascunho a ser recuperado |
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/
getDraftMessages()
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/
getDrafts()
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/
getInboxThreads()
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/
getInboxThreads(start, max)
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
Nome | Tipo | Descrição |
---|---|---|
start | Integer | o índice da primeira linha de execução a ser recuperada |
max | Integer | o número máximo de linhas de execução a serem recuperadas |
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/
getInboxUnreadCount()
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/
getMessageById(id)
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
Nome | Tipo | Descrição |
---|---|---|
id | String | o ID da mensagem a ser recuperada |
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
getMessagesForThread(thread)
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
Nome | Tipo | Descrição |
---|---|---|
thread | GmailThread | a sequência de mensagens a serem recuperadas |
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
Nome | Tipo | Descrição |
---|---|---|
threads | GmailThread[] | as sequências das mensagens a serem recuperadas |
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
getPriorityInboxThreads()
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/
getPriorityInboxThreads(start, max)
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
Nome | Tipo | Descrição |
---|---|---|
start | Integer | o índice da primeira linha de execução a ser recuperada |
max | Integer | o número máximo de linhas de execução a serem recuperadas |
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/
getPriorityInboxUnreadCount()
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/
getSpamThreads()
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/
getSpamThreads(start, max)
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
Nome | Tipo | Descrição |
---|---|---|
start | Integer | o índice da primeira linha de execução a ser recuperada |
max | Integer | o número máximo de linhas de execução a serem recuperadas |
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/
getSpamUnreadCount()
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/
getStarredThreads()
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/
getStarredThreads(start, max)
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
Nome | Tipo | Descrição |
---|---|---|
start | Integer | o índice da primeira linha de execução a ser recuperada |
max | Integer | o número máximo de linhas de execução a serem recuperadas |
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/
getStarredUnreadCount()
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/
getThreadById(id)
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
Nome | Tipo | Descrição |
---|---|---|
id | String | O ID da linha de execução a ser recuperada. |
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
getTrashThreads()
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/
getTrashThreads(start, max)
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
Nome | Tipo | Descrição |
---|---|---|
start | Integer | o índice da primeira linha de execução a ser recuperada |
max | Integer | o número máximo de linhas de execução a serem recuperadas |
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/
getUserLabelByName(name)
Recupera um rótulo dado o nome dele.
var labelObject = GmailApp.getUserLabelByName("myLabel");
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
name | String | o nome do rótulo a ser recuperado |
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/
getUserLabels()
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/
markMessageRead(message)
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
Nome | Tipo | Descrição |
---|---|---|
message | GmailMessage | a mensagem a ser marcada como lida |
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
Nome | Tipo | Descrição |
---|---|---|
message | GmailMessage | a mensagem a ser marcada como não lida |
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 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
Nome | Tipo | Descrição |
---|---|---|
messages | GmailMessage[] | uma matriz de mensagens para marcar como lidas |
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
Nome | Tipo | Descrição |
---|---|---|
messages | GmailMessage[] | uma matriz de mensagens para marcar como não lidas |
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 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
Nome | Tipo | Descrição |
---|---|---|
thread | GmailThread | a conversa a ser marcada como importante |
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 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
Nome | Tipo | Descrição |
---|---|---|
thread | GmailThread | a conversa a ser marcada como lida |
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 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
Nome | Tipo | Descrição |
---|---|---|
thread | GmailThread | a conversa a ser marcada como não importante |
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 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
Nome | Tipo | Descrição |
---|---|---|
thread | GmailThread | a conversa a ser marcada como não lida |
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 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
Nome | Tipo | Descrição |
---|---|---|
threads | GmailThread[] | uma matriz de linhas de execução para marcar como importante |
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)
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
Nome | Tipo | Descrição |
---|---|---|
threads | GmailThread[] | uma matriz de linhas de execução para marcar como lida |
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 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
Nome | Tipo | Descrição |
---|---|---|
threads | GmailThread[] | uma matriz de linhas de execução para marcar como não importantes |
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 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
Nome | Tipo | Descrição |
---|---|---|
threads | GmailThread[] | uma matriz de conversas para marcar como não lidas |
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 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
Nome | Tipo | Descrição |
---|---|---|
message | GmailMessage | a mensagem a ser movida para a lixeira |
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
Nome | Tipo | Descrição |
---|---|---|
messages | GmailMessage[] | as mensagens que serão movidas para a lixeira |
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
moveThreadToArchive(thread)
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
Nome | Tipo | Descrição |
---|---|---|
thread | GmailThread | a linha de execução a ser arquivada |
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)
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
Nome | Tipo | Descrição |
---|---|---|
thread | GmailThread | a conversa a ser movida para a caixa de entrada |
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
moveThreadToSpam(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
Nome | Tipo | Descrição |
---|---|---|
thread | GmailThread | a conversa a ser movida para a caixa de spam |
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)
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
Nome | Tipo | Descrição |
---|---|---|
thread | GmailThread | a conversa que será movida para a lixeira |
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
moveThreadsToArchive(threads)
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
Nome | Tipo | Descrição |
---|---|---|
threads | GmailThread[] | uma matriz de conversas a serem arquivadas |
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)
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
Nome | Tipo | Descrição |
---|---|---|
threads | GmailThread[] | uma matriz de conversas a serem movidas para a caixa de entrada. |
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
moveThreadsToSpam(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
Nome | Tipo | Descrição |
---|---|---|
threads | GmailThread[] | uma matriz de conversas a serem movidas para a caixa de spam |
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)
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
Nome | Tipo | Descrição |
---|---|---|
threads | GmailThread[] | uma matriz de conversas que serão enviadas para a lixeira |
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 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
Nome | Tipo | Descrição |
---|---|---|
message | GmailMessage | a mensagem a ser atualizada |
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
Nome | Tipo | Descrição |
---|---|---|
messages | GmailMessage[] | as mensagens a serem atualizadas |
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)
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
Nome | Tipo | Descrição |
---|---|---|
thread | GmailThread | a linha de execução a ser atualizada |
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
Nome | Tipo | Descrição |
---|---|---|
threads | GmailThread[] | as linhas de execução que serão atualizadas |
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
search(query)
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
Nome | Tipo | Descrição |
---|---|---|
query | String | a consulta de pesquisa, como você a digitaria no Gmail |
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/
search(query, start, max)
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
Nome | Tipo | Descrição |
---|---|---|
query | String | a consulta de pesquisa, como você a digitaria no Gmail |
start | Integer | o índice da linha de execução inicial |
max | Integer | o número máximo de linhas de execução a serem retornadas |
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/
sendEmail(recipient, subject, body)
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
Nome | Tipo | Descrição |
---|---|---|
recipient | String | lista separada por vírgulas de endereços de e-mail |
subject | String | assunto do e-mail (máximo de 250 caracteres) |
body | String | corpo do e-mail |
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
Nome | Tipo | Descrição |
---|---|---|
recipient | String | os endereços do destinatário |
subject | String | a linha de assunto (máximo de 250 caracteres) |
body | String | no corpo do e-mail |
options | Object | um objeto JavaScript que especifica parâmetros avançados, como listado abaixo |
Parâmetros avançados
Nome | Tipo | Descrição |
---|---|---|
attachments | BlobSource[] | um matriz de arquivos para enviar com o e-mail |
bcc | String | uma lista separada por vírgulas de endereços de e-mail para Cco |
cc | String | uma lista separada por vírgulas de endereços de e-mail para Cc |
from | String | o endereço do qual o e-mail deve ser enviado, que deve ser um
dos valores retornados por getAliases() |
htmlBody | String | Se definido, ele será usado pelos dispositivos capazes de processar HTML
do argumento "body" obrigatório. é possível adicionar um campo inlineImages opcional em HTML
corpo se você tiver imagens inline para seu e-mail |
inlineImages | Object | um objeto JavaScript que contém um mapeamento da chave de imagem
(String ) aos dados da imagem (BlobSource ); Isso pressupõe que o parâmetro htmlBody é usado e contém referências a essas imagens no formato <img src="cid:imageKey" /> |
name | String | o nome do remetente do e-mail (padrão: o nome do usuário) |
noReply | Boolean | true se o e-mail precisar ser enviado de um endereço genérico
endereço de e-mail sem resposta para desencorajar os destinatários a responder a e-mails; essa opção está
disponível apenas para contas do Google Workspace, e não para usuários do Gmail. |
replyTo | String | um endereço de e-mail para ser usado como o endereço padrão para resposta (padrão: endereço de e-mail do usuário) |
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
setCurrentMessageAccessToken(accessToken)
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
Nome | Tipo | Descrição |
---|---|---|
accessToken | String | O token de acesso temporário recebido de um objeto de evento de ação do complemento 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/
starMessage(message)
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
Nome | Tipo | Descrição |
---|---|---|
message | GmailMessage | a mensagem a ser marcada com estrela |
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
Nome | Tipo | Descrição |
---|---|---|
messages | GmailMessage[] | uma matriz de mensagens para marcar com estrela |
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)
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
Nome | Tipo | Descrição |
---|---|---|
message | GmailMessage | a mensagem a ser removida com estrela |
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
Nome | Tipo | Descrição |
---|---|---|
messages | GmailMessage[] | uma matriz de mensagens para remover estrela |
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/