Gmail Service

Gmail

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

Classes

NomeBreve descrição
GmailAppConcede acesso a conversas, mensagens e marcadores do Gmail.
GmailAttachmentUm anexo do Gmail.
GmailDraftUma mensagem de rascunho criada pelo 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 e-mail de rascunho.
createDraft(recipient, subject, body, options)GmailDraftCria um e-mail de rascunho com argumentos opcionais.
createLabel(name)GmailLabelCrie um novo marcador de usuário com o nome fornecido.
deleteLabel(label)GmailAppExclui o rótulo especificado.
getAliases()String[]Recebe uma lista dos e-mails configurados como aliases para essa conta no Gmail.
getDraft(draftId)GmailDraftRecuperar um rascunho de mensagem de e-mail por ID.
getDraftMessages()GmailMessage[]Recupera todas as mensagens de rascunho.
getDrafts()GmailDraft[]Recebe todas as mensagens de rascunho do Gmail.
getInboxThreads()GmailThread[]Recupera todas as linhas de execução da caixa de entrada, independentemente dos marcadores.
getInboxThreads(start, max)GmailThread[]Recupera um intervalo de linhas de execução da caixa de entrada, independentemente dos marcadores.
getInboxUnreadCount()IntegerRecebe o número de conversas não lidas na caixa de entrada.
getMessageById(id)GmailMessageRecebe uma mensagem por ID.
getMessagesForThread(thread)GmailMessage[]Recuperar todas as mensagens da conversa especificada.
getMessagesForThreads(threads)GmailMessage[][]Recuperar todas as mensagens das conversas especificadas.
getPriorityInboxThreads()GmailThread[]Recupera todas as linhas de execução da Caixa prioritária, independentemente dos marcadores.
getPriorityInboxThreads(start, max)GmailThread[]Recupera um intervalo de conversas da Caixa prioritária, independentemente dos marcadores.
getPriorityInboxUnreadCount()IntegerRecebe o número de conversas não lidas na Caixa de entrada prioritária.
getSpamThreads()GmailThread[]Recupera todas as conversas de spam, independentemente dos rótulos.
getSpamThreads(start, max)GmailThread[]Recupera um intervalo de conversas de spam independentemente dos marcadores.
getSpamUnreadCount()IntegerRecebe o número de conversas não lidas que são spam.
getStarredThreads()GmailThread[]Recupera todas as linhas de execução com estrela, independentemente dos rótulos.
getStarredThreads(start, max)GmailThread[]Recupera um intervalo de linhas de execução com estrela, independentemente dos rótulos.
getStarredUnreadCount()IntegerRecebe o número de conversas não lidas com estrela.
getThreadById(id)GmailThreadRecebe uma linha de execução por ID.
getTrashThreads()GmailThread[]Recupera todas as linhas de execução da lixeira, independentemente dos marcadores.
getTrashThreads(start, max)GmailThread[]Recupera um intervalo de conversas da lixeira, independentemente dos rótulos.
getUserLabelByName(name)GmailLabelRecupera o rótulo com base no nome dele.
getUserLabels()GmailLabel[]Recupera uma lista de rótulos criados pelo usuário.
markMessageRead(message)GmailAppMarca esta mensagem como lida e força a atualização da mensagem.
markMessageUnread(message)GmailAppMarca esta mensagem como não lida e força a atualização da mensagem.
markMessagesRead(messages)GmailAppMarca estas mensagens como lidas e força a atualização delas.
markMessagesUnread(messages)GmailAppMarca estas mensagens como não lidas e força a atualização delas.
markThreadImportant(thread)GmailAppMarca esta conversa como importante e força a atualização.
markThreadRead(thread)GmailAppMarca esta conversa como lida e força a atualização.
markThreadUnimportant(thread)GmailAppMarca esta conversa como não importante e força a atualização.
markThreadUnread(thread)GmailAppMarca a conversa como não lida e força a atualização.
markThreadsImportant(threads)GmailAppMarca as conversas como importantes e força as atualizações.
markThreadsRead(threads)GmailAppMarca as linhas de execução como lidas e força a atualização delas.
markThreadsUnimportant(threads)GmailAppMarca as linhas de execução como não importantes e força as atualizações.
markThreadsUnread(threads)GmailAppMarca as conversas como não lidas e força as atualizações.
moveMessageToTrash(message)GmailAppMove a mensagem para a lixeira e força a atualização.
moveMessagesToTrash(messages)GmailAppMove as mensagens especificadas para a lixeira e as força a serem atualizadas.
moveThreadToArchive(thread)GmailAppMove essa linha de execução para o arquivo e força a atualização.
moveThreadToInbox(thread)GmailAppMove essa linha de execução para a Caixa de entrada e força a atualização.
moveThreadToSpam(thread)GmailAppMove essa linha de execução para spam e força a atualização a ela.
moveThreadToTrash(thread)GmailAppMove essa linha para a lixeira e força a atualização.
moveThreadsToArchive(threads)GmailAppMove as linhas de execução para o arquivo e as força a serem atualizadas.
moveThreadsToInbox(threads)GmailAppmove as linhas de execução para a caixa de entrada e as força a serem atualizadas.
moveThreadsToSpam(threads)GmailAppmove as conversas para a pasta "Spam" e as força a serem atualizadas;
moveThreadsToTrash(threads)GmailAppmove as conversas para a lixeira e as força a atualizar.
refreshMessage(message)GmailAppRecarrega a mensagem e o estado associado pelo Gmail (útil se os marcadores, o estado de leitura etc. tiverem mudado).
refreshMessages(messages)GmailAppRecarrega as mensagens e o estado associado pelo Gmail (útil caso os marcadores, o estado de leitura etc. tenham mudado).
refreshThread(thread)GmailAppRecarrega a linha de execução e o estado associado a partir do Gmail (útil caso os marcadores, o estado de leitura etc. tenham mudado).
refreshThreads(threads)GmailAppRecarrega as linhas de execução e o estado associado pelo Gmail (útil caso os rótulos, o estado de leitura etc. tenham mudado).
search(query)GmailThread[]Pesquise no Gmail a consulta fornecida.
search(query, start, max)GmailThread[]Pesquise no Gmail a consulta fornecida.
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 de mensagem atual que permite que o script acesse as propriedades atuais de GmailMessage.
starMessage(message)GmailAppAdiciona uma estrela a esta mensagem e força a mensagem a ser atualizada.
starMessages(messages)GmailAppAdiciona estrelas a essas mensagens e força as mensagens a serem atualizadas.
unstarMessage(message)GmailAppRemove uma estrela desta mensagem e força a mensagem a ser atualizada.
unstarMessages(messages)GmailAppRemove as estrelas dessas mensagens e força as atualizações.

GmailAttachment

Métodos

MétodoTipo de retornoBreve descrição
copyBlob()BlobRetorna uma cópia desse blob.
getAs(contentType)BlobRetorna os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado.
getBytes()Byte[]Recebe os dados armazenados nesse blob.
getContentType()StringRecebe 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 para este anexo.
getName()StringRecebe o nome desse blob.
getSize()IntegerRecebe o tamanho desse anexo.
isGoogleType()BooleanRetorna se este 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 de bytes neste 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 deste blob.

GmailDraft

Métodos

MétodoTipo de retornoBreve descrição
deleteDraft()voidExclui o rascunho desta mensagem.
getId()StringRecebe o ID desta mensagem de rascunho.
getMessage()GmailMessageRetorna uma mensagem do Gmail que representa esse rascunho.
getMessageId()StringRetorna o ID do GmailMessage que representa esse rascunho.
send()GmailMessageEnvia este e-mail de rascunho.
update(recipient, subject, body)GmailDraftSubstitui o conteúdo deste 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 este marcador à linha de execução especificada e força a atualização (GmailThread.refresh()).
addToThreads(threads)GmailLabelAdiciona esse marcador às linhas de execução fornecidas e força as linhas de execução a serem atualizadas.
deleteLabel()voidExclui o marcador.
getName()StringRecebe o nome do rótulo.
getThreads()GmailThread[]Recebe as conversas marcadas com esse rótulo.
getThreads(start, max)GmailThread[]Recebe um intervalo de linhas de execução marcadas com este rótulo.
getUnreadCount()IntegerRecebe o número de conversas não lidas marcadas com esse marcador.
removeFromThread(thread)GmailLabelRemove este marcador da linha de execução especificada e força a linha de execução a ser atualizada.
removeFromThreads(threads)GmailLabelRemove este marcador das linhas de execução fornecidas e força as linhas de execução a serem atualizadas.

GmailMessage

Métodos

MétodoTipo de retornoBreve descrição
createDraftReply(body)GmailDraftCria um rascunho de mensagem respondendo ao remetente dessa mensagem usando o endereço para resposta.
createDraftReply(body, options)GmailDraftCria um rascunho de mensagem respondendo ao remetente dessa mensagem usando o endereço para resposta, com argumentos opcionais.
createDraftReplyAll(body)GmailDraftCria um rascunho de mensagem respondendo ao remetente usando o endereço para resposta e todos os destinatários da mensagem.
createDraftReplyAll(body, options)GmailDraftCria um rascunho de mensagem respondendo ao remetente dessa mensagem usando o endereço para resposta e todos os destinatários, com argumentos opcionais.
forward(recipient)GmailMessageEncaminhar esta mensagem para novos destinatários.
forward(recipient, options)GmailMessageEncaminha esta mensagem para novos destinatários com argumentos opcionais.
getAttachments()GmailAttachment[]Recebe todos os anexos desta mensagem.
getAttachments(options)GmailAttachment[]Recebe todos os anexos desta mensagem.
getBcc()StringRecebe os destinatários separados por vírgulas como Cco nesta mensagem.
getBody()StringRecebe o conteúdo HTML do corpo desta mensagem.
getCc()StringRecebe os destinatários separados por vírgula cc'd nesta mensagem.
getDate()DateRecebe a data e a hora da mensagem.
getFrom()StringExtrai o remetente desta mensagem.
getHeader(name)StringAcessa o valor de um cabeçalho RFC 2822 de acordo com o nome do cabeçalho.
getId()StringRecebe o ID desta mensagem.
getPlainBody()StringRecebe o conteúdo do corpo da mensagem sem a formatação HTML.
getRawContent()StringRecebe o conteúdo bruto desta mensagem.
getReplyTo()StringRecebe o endereço para resposta desta mensagem (geralmente o remetente).
getSubject()StringExtrai o assunto desta mensagem.
getThread()GmailThreadRecebe a conversa que contém essa mensagem.
getTo()StringRecebe os destinatários separados por vírgula da mensagem.
isDraft()BooleanRecebe se a mensagem é um rascunho.
isInChats()BooleanRecebe se esta mensagem é um chat.
isInInbox()BooleanRecebe se a mensagem está na caixa de entrada.
isInPriorityInbox()BooleanRetornará true se essa mensagem estiver na caixa de entrada prioritária. Caso contrário, retornará false.
isInTrash()BooleanRecebe se a mensagem está na lixeira.
isStarred()BooleanRecebe se a mensagem está marcada com estrela.
isUnread()BooleanRecebe 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 esta mensagem e o estado associado do Gmail (útil caso os marcadores, o estado de leitura etc. tenham mudado).
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)GmailMessageRespostas 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()GmailMessageEstrela removida da mensagem.

GmailThread

Métodos

MétodoTipo de retornoBreve descrição
addLabel(label)GmailThreadAdiciona esse marcador à conversa.
createDraftReply(body)GmailDraftCria um rascunho de mensagem respondendo ao remetente da última mensagem desta conversa usando o endereço para resposta.
createDraftReply(body, options)GmailDraftCria um rascunho de mensagem respondendo ao remetente da última mensagem desta linha de execução usando o endereço para resposta, com argumentos opcionais.
createDraftReplyAll(body)GmailDraftCria um rascunho de mensagem respondendo ao remetente da última mensagem desta conversa usando o endereço para resposta e todos os destinatários.
createDraftReplyAll(body, options)GmailDraftCria um rascunho de mensagem respondendo ao remetente da última mensagem dessa conversa usando o endereço para resposta e todos os destinatários, com argumentos opcionais.
getFirstMessageSubject()StringRecebe o assunto da primeira mensagem na conversa.
getId()StringRecebe o ID desta linha de execução.
getLabels()GmailLabel[]Retorna os rótulos criados pelo usuário nesta conversa.
getLastMessageDate()DateRecebe a data da mensagem mais recente desta conversa.
getMessageCount()IntegerRetorna o número de mensagens na conversa.
getMessages()GmailMessage[]Recebe as mensagens dessa conversa.
getPermalink()StringRecebe um link permanente para essa conversa.
hasStarredMessages()BooleanRetorna se a linha de execução tem mensagens com estrela.
isImportant()BooleanRetorna se a linha de execução foi marcada como importante.
isInChats()BooleanRetorna se a conversa está marcada como um chat.
isInInbox()BooleanRetorna se a thread está na Caixa de entrada.
isInPriorityInbox()BooleanRetorna verdadeiro se essa linha de execução está na caixa de entrada prioritária. Caso contrário, retorna falso.
isInSpam()BooleanRetorna se a conversa foi marcada como spam.
isInTrash()BooleanRetorna se a conversa está na lixeira.
isUnread()BooleanRetorna se a conversa tem mensagens não lidas ou não.
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 essa conversa para a Caixa de entrada.
moveToSpam()GmailThreadMove esta conversa para a pasta "Spam".
moveToTrash()GmailThreadMove essa conversa para a lixeira.
refresh()GmailThreadRecarrega esta conversa e o estado associado do Gmail. Isso é útil caso os marcadores, o estado de leitura etc. tenham mudado.
removeLabel(label)GmailThreadRemove este marcador da conversa.
reply(body)GmailThreadResponda ao remetente da última mensagem desta conversa usando o endereço "ResponderPara".
reply(body, options)GmailThreadResponda ao remetente da última mensagem nesta conversa usando o endereço "ResponderTo", com argumentos opcionais.
replyAll(body)GmailThreadResponda ao remetente (usando o endereço "responder") e a todos os destinatários da última mensagem desta conversa.
replyAll(body, options)GmailThreadResponda ao remetente (usando o endereço replyTo) e a todos os destinatários da última mensagem desta linha de execução, com argumentos opcionais.