Gmail Service

Gmail

Esse serviço permite enviar e-mails, escrever rascunhos, gerenciar marcadores, marcar mensagens e conversas e conduzir várias outras tarefas de gerenciamento de contas do Gmail. Consulte também Serviço de e-mail, um serviço mais simples que permite apenas o envio de e-mails.

Aulas

NomeBreve descrição
GmailAppDá acesso a conversas, mensagens e marcadores do Gmail.
GmailAttachmentUm anexo do Gmail.
GmailDraftUma mensagem de rascunho criada por um usuário na conta do Gmail de um usuário.
GmailLabelUm marcador criado pelo usuário na conta do Gmail de um usuário.
GmailMessageUma mensagem na conta do Gmail de um usuário.
GmailThreadUma conversa na conta do Gmail de um usuário.

GmailApp

Métodos

MétodoTipo de retornoBreve descrição
createDraft(recipient, subject, body)GmailDraftCria um rascunho de mensagem de e-mail.
createDraft(recipient, subject, body, options)GmailDraftCria um rascunho de mensagem de e-mail com argumentos opcionais.
createLabel(name)GmailLabelCria um novo rótulo de usuário com o nome informado.
deleteLabel(label)GmailAppExclui o rótulo especificado.
getAliases()String[]Extrai uma lista dos e-mails configurados como aliases dessa conta no Gmail.
getDraft(draftId)GmailDraftRecuperar um rascunho de mensagem de e-mail pelo ID.
getDraftMessages()GmailMessage[]Recupera todos os rascunhos.
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 vários tópicos da Caixa de entrada, independentemente dos marcadores.
getInboxUnreadCount()IntegerMostra o número de conversas não lidas na caixa de entrada.
getMessageById(id)GmailMessageRecebe uma mensagem pelo ID.
getMessagesForThread(thread)GmailMessage[]Recupera todas as mensagens na conversa especificada.
getMessagesForThreads(threads)GmailMessage[][]Recupera 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()IntegerMostra 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 variedade de conversas de spam, independentemente dos marcadores.
getSpamUnreadCount()IntegerMostra o número de conversas não lidas que são spam.
getStarredThreads()GmailThread[]Recupera todas as conversas com estrela, independentemente dos rótulos.
getStarredThreads(start, max)GmailThread[]Recupera uma variedade de conversas com estrela, independentemente dos rótulos.
getStarredUnreadCount()IntegerExtrai o número de conversas não lidas marcadas com estrela.
getThreadById(id)GmailThreadRecebe uma linha de execução por ID.
getTrashThreads()GmailThread[]Recupera todas as conversas de lixeira, independentemente dos marcadores.
getTrashThreads(start, max)GmailThread[]Recupera um intervalo de threads de lixeira, independentemente dos rótulos.
getUserLabelByName(name)GmailLabelRecupera um rótulo de acordo com o nome dele.
getUserLabels()GmailLabel[]Recupera uma lista de rótulos criados pelo usuário.
markMessageRead(message)GmailAppMarca a mensagem como lida e força a atualização dela.
markMessageUnread(message)GmailAppMarca esta mensagem como não lida e força a atualização dela.
markMessagesRead(messages)GmailAppMarca essas mensagens como lidas e força a atualização delas.
markMessagesUnread(messages)GmailAppMarca essas mensagens como não lidas e força a atualização delas.
markThreadImportant(thread)GmailAppMarca a linha de execução como importante e força a atualização dela.
markThreadRead(thread)GmailAppMarca a linha de execução como lida e força a atualização dela.
markThreadUnimportant(thread)GmailAppMarca a conversa como não importante e força a atualização dela.
markThreadUnread(thread)GmailAppMarca esta conversa como não lida e força a conversa a ser atualizada.
markThreadsImportant(threads)GmailAppMarca essas linhas de execução como importantes e força a atualização delas.
markThreadsRead(threads)GmailAppMarca essas linhas de execução como lidas e força a atualização delas.
markThreadsUnimportant(threads)GmailAppMarca essas conversas como não importantes e força a atualização delas.
markThreadsUnread(threads)GmailAppMarca essas conversas como não lidas e força a atualização delas.
moveMessageToTrash(message)GmailAppMove a mensagem para a lixeira e força a atualização dela.
moveMessagesToTrash(messages)GmailAppMove as mensagens especificadas para a lixeira e força a atualização delas.
moveThreadToArchive(thread)GmailAppMove a linha de execução para o arquivo e força a atualização dela.
moveThreadToInbox(thread)GmailAppMove a conversa para a caixa de entrada e força a atualização dela.
moveThreadToSpam(thread)GmailAppMove esta conversa para "Spam" e força a atualização dela.
moveThreadToTrash(thread)GmailAppMove a linha de execução para a lixeira e força a atualização dela.
moveThreadsToArchive(threads)GmailAppMove essas linhas de execução para o arquivo e força a atualização delas.
moveThreadsToInbox(threads)GmailAppMove essas conversas para a caixa de entrada e força a atualização delas.
moveThreadsToSpam(threads)GmailAppMove essas conversas para "Spam" e força a atualização delas.
moveThreadsToTrash(threads)GmailAppMove essas linhas de execução para a lixeira e força a atualização delas.
refreshMessage(message)GmailAppRecarrega a mensagem e o estado associado do Gmail. Isso é útil caso os marcadores, o estado de leitura etc. tenham sido alterados.
refreshMessages(messages)GmailAppRecarrega as mensagens e o estado associado do Gmail (útil caso os marcadores, o estado de leitura etc. tenham sido alterados).
refreshThread(thread)GmailAppRecarrega a conversa e o estado associado do Gmail (útil caso os marcadores, o estado de leitura etc. tenham sido alterados).
refreshThreads(threads)GmailAppRecarrega as linhas de execução e o estado associado do Gmail. Isso é útil caso os marcadores, o estado de leitura etc. tenham sido alterados.
search(query)GmailThread[]Pesquisar no Gmail com a consulta em questão.
search(query, start, max)GmailThread[]Pesquisar no Gmail com a consulta em questão.
sendEmail(recipient, subject, body)GmailAppEnvia uma mensagem de e-mail.
sendEmail(recipient, subject, body, options)GmailAppEnvia uma mensagem de e-mail com argumentos opcionais.
setCurrentMessageAccessToken(accessToken)voidDefine o token de acesso da mensagem atual que permite ao script acessar as propriedades GmailMessage atuais.
starMessage(message)GmailAppMarca a mensagem com uma estrela e força a atualização dela.
starMessages(messages)GmailAppAdiciona estrelas a essas mensagens e força a atualização delas.
unstarMessage(message)GmailAppRemove uma estrela da mensagem e força a atualização dela.
unstarMessages(messages)GmailAppRemove as estrelas dessas mensagens e força a atualização delas.

GmailAttachment

Métodos

MétodoTipo de retornoBreve descrição
copyBlob()BlobRetorna uma cópia desse blob.
getAs(contentType)BlobRetorne os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado.
getBytes()Byte[]Recebe os dados armazenados neste blob.
getContentType()StringExtrai o tipo de conteúdo dos bytes neste blob.
getDataAsString()StringRecebe os dados desse blob como uma String com codificação UTF-8.
getDataAsString(charset)StringRecebe os dados desse blob como uma string com a codificação especificada.
getHash()StringRecebe o hash de conteúdo SHA1 deste anexo.
getName()StringRecebe o nome desse blob.
getSize()IntegerExtrai o tamanho deste anexo.
isGoogleType()BooleanRetorna indicando se o blob é um arquivo do Google Workspace (Planilhas, Documentos etc.).
setBytes(data)BlobDefine os dados armazenados neste blob.
setContentType(contentType)BlobDefine o tipo de conteúdo dos bytes neste blob.
setContentTypeFromExtension()BlobDefine o tipo de conteúdo dos bytes nesse blob com base na extensão do arquivo.
setDataFromString(string)BlobDefine os dados desse blob de uma string com codificação UTF-8.
setDataFromString(string, charset)BlobDefine os dados desse blob de uma string com a codificação especificada.
setName(name)BlobDefine o nome desse blob.

GmailDraft

Métodos

MétodoTipo de retornoBreve descrição
deleteDraft()voidExclui esta mensagem de rascunho.
getId()StringExtrai o ID desta mensagem de rascunho.
getMessage()GmailMessageRetorna uma GmailMessage que representa este rascunho.
getMessageId()StringRetorna o ID da GmailMessage que representa esse rascunho.
send()GmailMessageEnvia este rascunho de mensagem de e-mail.
update(recipient, subject, body)GmailDraftSubstitui o conteúdo desta mensagem de rascunho.
update(recipient, subject, body, options)GmailDraftSubstitui o conteúdo desta mensagem de rascunho usando argumentos opcionais.

GmailLabel

Métodos

MétodoTipo de retornoBreve descrição
addToThread(thread)GmailLabelAdiciona esse rótulo à linha de execução fornecida e força a linha a ser atualizada (GmailThread.refresh()).
addToThreads(threads)GmailLabelAdiciona esse rótulo às linhas de execução fornecidas e força a atualização delas.
deleteLabel()voidExclui este marcador.
getName()StringExtrai o nome desse rótulo.
getThreads()GmailThread[]Extrai as conversas marcadas com esse rótulo.
getThreads(start, max)GmailThread[]Recebe um intervalo de conversas marcadas com esse rótulo.
getUnreadCount()IntegerRecebe o número de conversas não lidas marcadas com este marcador.
removeFromThread(thread)GmailLabelRemove esse rótulo da linha de execução fornecida e força a linha a ser atualizada.
removeFromThreads(threads)GmailLabelRemove esse rótulo das linhas de execução fornecidas e força a atualização delas.

GmailMessage

Métodos

MétodoTipo de retornoBreve descrição
createDraftReply(body)GmailDraftCria uma mensagem de rascunho para responder ao remetente usando o endereço para resposta.
createDraftReply(body, options)GmailDraftCria uma mensagem de rascunho para responder ao remetente usando o endereço para resposta, com argumentos opcionais.
createDraftReplyAll(body)GmailDraftCria uma mensagem de rascunho para responder ao remetente usando o endereço para resposta e todos os destinatários desta mensagem.
createDraftReplyAll(body, options)GmailDraftCria uma mensagem de rascunho para responder ao remetente dessa mensagem usando o endereço para resposta e todos os destinatários, com argumentos opcionais.
forward(recipient)GmailMessageEncaminha esta mensagem para os novos destinatários.
forward(recipient, options)GmailMessageEncaminha esta mensagem para novos destinatários, com argumentos opcionais.
getAttachments()GmailAttachment[]Extrai todos os anexos desta mensagem.
getAttachments(options)GmailAttachment[]Extrai todos os anexos desta mensagem.
getBcc()StringExtrai os destinatários separados por vírgula incluídos em Cco nesta mensagem.
getBody()StringExtrai o conteúdo HTML do corpo desta mensagem.
getCc()StringExtrai os destinatários separados por vírgula em cópia na mensagem.
getDate()DateExtrai a data e a hora da mensagem.
getFrom()StringExtrai o remetente desta mensagem.
getHeader(name)StringRecebe o valor de um cabeçalho RFC 2822 com base no nome do cabeçalho.
getId()StringExtrai o ID dessa mensagem.
getPlainBody()StringExtrai o conteúdo do corpo desta mensagem sem formatação HTML.
getRawContent()StringExtrai o conteúdo bruto dessa mensagem.
getReplyTo()StringExtrai o endereço para resposta desta mensagem (geralmente o remetente).
getSubject()StringExtrai o assunto desta mensagem.
getThread()GmailThreadExtrai a conversa que contém essa mensagem.
getTo()StringExtrai os destinatários separados por vírgula desta mensagem.
isDraft()BooleanVerifica se esta mensagem é um rascunho.
isInChats()BooleanDescobre se esta mensagem é um chat.
isInInbox()BooleanVerifica se a mensagem está na caixa de entrada.
isInPriorityInbox()BooleanRetorna true se esta mensagem estiver na caixa de entrada prioritária. Caso contrário, retorna false.
isInTrash()BooleanVerifica se a mensagem está na lixeira.
isStarred()BooleanVerifica se a mensagem está marcada com estrela.
isUnread()BooleanMostra se a mensagem não foi lida.
markRead()GmailMessageMarca a mensagem como lida.
markUnread()GmailMessageMarca a mensagem como não lida.
moveToTrash()GmailMessageMove a mensagem para a lixeira.
refresh()GmailMessageRecarrega essa mensagem e o estado associado do Gmail (útil caso os marcadores, o estado de leitura etc. tenham sido alterados).
reply(body)GmailMessageResponde ao remetente desta mensagem usando o endereço para resposta.
reply(body, options)GmailMessageResponde ao remetente desta mensagem usando o endereço para resposta, com argumentos opcionais.
replyAll(body)GmailMessageResponde ao remetente usando o endereço para resposta e todos os destinatários desta mensagem.
replyAll(body, options)GmailMessageResponde ao remetente desta mensagem usando o endereço para resposta e todos os destinatários, com argumentos opcionais.
star()GmailMessageMarca a mensagem com estrela.
unstar()GmailMessageRemove a estrela da mensagem.

GmailThread

Métodos

MétodoTipo de retornoBreve descrição
addLabel(label)GmailThreadAdiciona esse marcador à conversa.
createDraftReply(body)GmailDraftCria um rascunho para responder ao remetente da última mensagem nesta conversa usando o endereço para resposta.
createDraftReply(body, options)GmailDraftCria uma mensagem de rascunho respondendo ao remetente da última mensagem nesta conversa usando o endereço para resposta, com argumentos opcionais.
createDraftReplyAll(body)GmailDraftCria uma mensagem de rascunho para responder ao remetente da última mensagem nesta conversa, usando o endereço para resposta e todos os destinatários desta mensagem.
createDraftReplyAll(body, options)GmailDraftCria uma mensagem de rascunho respondendo ao remetente da última mensagem nesta conversa usando o endereço para resposta e todos os destinatários, com argumentos opcionais.
getFirstMessageSubject()StringExtrai o assunto da primeira mensagem da conversa.
getId()StringExtrai o ID dessa linha de execução.
getLabels()GmailLabel[]Retorna os rótulos criados pelo usuário nessa linha de execução.
getLastMessageDate()DateExtrai a data da mensagem mais recente dessa conversa.
getMessageCount()IntegerRetorna o número de mensagens na conversa.
getMessages()GmailMessage[]Recebe as mensagens nesta conversa.
getPermalink()StringRecebe um link permanente para esta conversa.
hasStarredMessages()BooleanRetorna se a conversa tem mensagens marcadas com estrela.
isImportant()BooleanRetorna se a linha de execução está marcada como importante.
isInChats()BooleanRetorna se a conversa está marcada como um chat.
isInInbox()BooleanRetorna se a conversa está na caixa de entrada.
isInPriorityInbox()BooleanRetorna "true" se essa conversa está na caixa de entrada prioritária. Caso contrário, retorna "false".
isInSpam()BooleanRetorna se a conversa está marcada como spam.
isInTrash()BooleanRetorna se a conversa está na lixeira.
isUnread()BooleanRetorna se a conversa tem mensagens não lidas.
markImportant()GmailThreadMarca esta conversa como importante.
markRead()GmailThreadMarca esta conversa como lida.
markUnimportant()GmailThreadMarca esta conversa como não importante.
markUnread()GmailThreadMarca esta conversa como não lida.
moveToArchive()GmailThreadMove esta conversa para o arquivo.
moveToInbox()GmailThreadMove esta conversa para a caixa de entrada.
moveToSpam()GmailThreadMove esta conversa para a caixa de spam.
moveToTrash()GmailThreadMove a conversa para a lixeira.
refresh()GmailThreadRecarrega essa conversa e o estado associado do Gmail (útil caso os marcadores, o estado de leitura etc. tenham sido alterados).
removeLabel(label)GmailThreadRemove o marcador da conversa.
reply(body)GmailThreadResponda ao remetente da última mensagem desta conversa usando o endereço "replyTo".
reply(body, options)GmailThreadResponda ao remetente da última mensagem nesta conversa usando o endereço "replyTo" com argumentos opcionais.
replyAll(body)GmailThreadResponda ao remetente usando o endereço "replyTo" e a todos os destinatários da última mensagem nesta conversa.
replyAll(body, options)GmailThreadResponda ao remetente (usando o endereço replyTo) e a todos os destinatários da última mensagem nesta conversa, com argumentos opcionais.