Gmail Service

Gmail

Com esse Serviço, você pode enviar e-mails, escrever rascunhos, gerenciar marcadores, marcar mensagens e conversas e realizar várias outras tarefas de gerenciamento da conta do Gmail. Consulte também o serviço de e-mail, um serviço mais simples que permite apenas o envio de e-mails.

Classes

Nome	Breve descrição
GmailApp	Fornece acesso a conversas, mensagens e marcadores do Gmail.
GmailAttachment	Um anexo do Gmail.
GmailDraft	Uma mensagem de rascunho criada pelo usuário na conta do Gmail dele.
GmailLabel	Um marcador criado pelo usuário na conta do Gmail dele.
GmailMessage	Uma mensagem na conta do Gmail de um usuário.
GmailThread	Uma conversa na conta do Gmail de um usuário.

GmailApp

Métodos

Método	Tipo de retorno	Breve descrição
createDraft(recipient, subject, body)	GmailDraft	Cria uma mensagem de e-mail em rascunho.
createDraft(recipient, subject, body, options)	GmailDraft	Cria uma mensagem de e-mail em rascunho com argumentos opcionais.
createLabel(name)	GmailLabel	Cria um novo marcador de usuário com o nome especificado.
deleteLabel(label)	GmailApp	Exclui o marcador especificado.
getAliases()	String[]	Recebe uma lista dos e-mails configurados como aliases para essa conta no Gmail.
getDraft(draftId)	GmailDraft	Recupera um rascunho de mensagem de e-mail por ID.
getDraftMessages()	GmailMessage[]	Recupera todas as mensagens em rascunho.
getDrafts()	GmailDraft[]	Recebe todas as mensagens de rascunho do Gmail.
getInboxThreads()	GmailThread[]	Recupera todas as conversas do Inbox, independente dos rótulos.
getInboxThreads(start, max)	GmailThread[]	Recupera um intervalo de conversas da Caixa de entrada, independente 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[]	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 de entrada prioritária, independente dos marcadores.
getPriorityInboxThreads(start, max)	GmailThread[]	Recupera um intervalo de conversas da Caixa prioritária, independente dos marcadores.
getPriorityInboxUnreadCount()	Integer	Recebe o número de conversas não lidas na Caixa prioritária.
getSpamThreads()	GmailThread[]	Recupera todas as conversas de spam, independente dos marcadores.
getSpamThreads(start, max)	GmailThread[]	Recupera um intervalo de conversas de spam, independente dos rótulos.
getSpamUnreadCount()	Integer	Recebe o número de conversas não lidas que são spam.
getStarredThreads()	GmailThread[]	Recupera todas as conversas marcadas com estrela, independente dos rótulos.
getStarredThreads(start, max)	GmailThread[]	Recupera um intervalo de conversas marcadas com estrela, independentemente dos marcadores.
getStarredUnreadCount()	Integer	Recebe o número de conversas não lidas marcadas com estrela.
getThreadById(id)	GmailThread	Recebe uma conversa por ID.
getTrashThreads()	GmailThread[]	Recupera todas as conversas da lixeira, independente dos rótulos.
getTrashThreads(start, max)	GmailThread[]	Recupera um intervalo de conversas da lixeira, independente dos marcadores.
getUserLabelByName(name)	GmailLabel	Recupera um marcador com base no nome dele.
getUserLabels()	GmailLabel[]	Recupera uma lista de rótulos criados pelo usuário.
markMessageRead(message)	GmailApp	Marca a mensagem como lida e força a atualização dela.
markMessageUnread(message)	GmailApp	Marca a 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 conversa como importante e força a atualização dela.
markThreadRead(thread)	GmailApp	Marca esta conversa 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 conversas como importantes e força a atualização delas.
markThreadsRead(threads)	GmailApp	Marca essas conversas como lidas e força a atualização delas.
markThreadsUnimportant(threads)	GmailApp	Marca essas conversas 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 a conversa para o arquivo e força a atualização dela.
moveThreadToInbox(thread)	GmailApp	Move a conversa para a caixa de entrada e força a atualização dela.
moveThreadToSpam(thread)	GmailApp	Move a conversa para o spam e força a atualização dela.
moveThreadToTrash(thread)	GmailApp	Move a conversa para a lixeira e força a atualização dela.
moveThreadsToArchive(threads)	GmailApp	Move essas conversas 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 essas conversas para o spam e força a atualização delas.
moveThreadsToTrash(threads)	GmailApp	Move as conversas para a lixeira e força a atualização delas.
refreshMessage(message)	GmailApp	Recarrega a mensagem e o estado associado do Gmail. Isso é útil caso os rótulos, o estado de leitura etc. tenham mudado.
refreshMessages(messages)	GmailApp	Recarrega as mensagens e o estado associado do Gmail. Isso é útil caso os rótulos, o estado de leitura etc. tenham mudado.
refreshThread(thread)	GmailApp	Recarrega a conversa e o estado associado do Gmail. Isso é útil caso os rótulos, o estado de leitura etc. tenham mudado.
refreshThreads(threads)	GmailApp	Recarrega as conversas e o estado associado do Gmail. Isso é útil caso os rótulos, o estado de leitura etc. tenham mudado.
search(query)	GmailThread[]	Pesquisa no Gmail com a consulta especificada.
search(query, start, max)	GmailThread[]	Pesquisa no Gmail com a consulta especificada.
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 o token de acesso da mensagem atual, que permite que o script acesse as propriedades GmailMessage atuais.
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 da mensagem e força a atualização dela.
unstarMessages(messages)	GmailApp	Remove as estrelas dessas mensagens e força a atualização delas.

GmailAttachment

Métodos

Método	Tipo de retorno	Breve descrição
copyBlob()	Blob	Retorna uma cópia deste blob.
getAs(contentType)	Blob	Retorna 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()	String	Recebe o tipo de conteúdo dos bytes neste blob.
getDataAsString()	String	Recebe os dados deste blob como uma string com codificação UTF-8.
getDataAsString(charset)	String	Recebe os dados deste blob como uma string com a codificação especificada.
getHash()	String	Recebe o hash de conteúdo SHA1 para este anexo.
getName()	String	Recebe o nome deste blob.
getSize()	Integer	Recebe o tamanho deste anexo.
isGoogleType()	Boolean	Retorna se este blob é um arquivo do Google Workspace (Planilhas, Documentos etc.).
setBytes(data)	Blob	Define os dados armazenados neste blob.
setContentType(contentType)	Blob	Define o tipo de conteúdo dos bytes neste blob.
setContentTypeFromExtension()	Blob	Define o tipo de conteúdo dos bytes neste blob com base na extensão do arquivo.
setDataFromString(string)	Blob	Define os dados desse blob com uma string codificada em UTF-8.
setDataFromString(string, charset)	Blob	Define os dados deste blob de uma string com a codificação especificada.
setName(name)	Blob	Define o nome deste blob.

GmailDraft

Métodos

Método	Tipo de retorno	Breve descrição
deleteDraft()	void	Exclui esta mensagem em rascunho.
getId()	String	Recebe o ID desta mensagem em rascunho.
getMessage()	GmailMessage	Retorna um GmailMessage que representa este rascunho.
getMessageId()	String	Retorna o ID do GmailMessage que representa este rascunho.
send()	GmailMessage	Envia esta mensagem de e-mail em rascunho.
update(recipient, subject, body)	GmailDraft	Substitui o conteúdo desta mensagem em rascunho.
update(recipient, subject, body, options)	GmailDraft	Substitui o conteúdo desta mensagem em rascunho usando argumentos opcionais.

GmailLabel

Métodos

Método	Tipo de retorno	Breve descrição
addToThread(thread)	GmailLabel	Adiciona esse rótulo à conversa especificada e força a atualização dela (GmailThread.refresh()).
addToThreads(threads)	GmailLabel	Adiciona esse rótulo às conversas especificadas e força a atualização delas.
deleteLabel()	void	Exclui o marcador.
getId()	String	Recebe o ID deste rótulo.
getName()	String	Recebe o nome deste marcador.
getThreads()	GmailThread[]	Recebe as linhas de execução marcadas com esse rótulo.
getThreads(start, max)	GmailThread[]	Recebe um intervalo de conversas marcadas com esse rótulo.
getUnreadCount()	Integer	Recebe o número de conversas não lidas marcadas com esse rótulo.
removeFromThread(thread)	GmailLabel	Remove o marcador da conversa especificada e força a atualização dela.
removeFromThreads(threads)	GmailLabel	Remove o rótulo das conversas especificadas e força a atualização delas.

GmailMessage

Métodos

Método	Tipo de retorno	Breve descrição
createDraftReply(body)	GmailDraft	Cria uma mensagem de rascunho respondendo ao remetente da mensagem usando o endereço de resposta.
createDraftReply(body, options)	GmailDraft	Cria um rascunho de mensagem respondendo ao remetente usando o endereço de resposta, com argumentos opcionais.
createDraftReplyAll(body)	GmailDraft	Cria uma mensagem de rascunho respondendo ao remetente usando o endereço de resposta e todos os destinatários desta mensagem.
createDraftReplyAll(body, options)	GmailDraft	Cria uma mensagem de rascunho respondendo ao remetente desta mensagem usando o endereço de resposta e todos os destinatários, com argumentos opcionais.
forward(recipient)	GmailMessage	Encaminha esta mensagem para novos destinatários.
forward(recipient, options)	GmailMessage	Encaminha 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()	String	Recebe os destinatários em cópia oculta separados por vírgulas desta mensagem.
getBody()	String	Recebe o conteúdo HTML do corpo desta mensagem.
getCc()	String	Recebe os destinatários em cópia da mensagem separados por vírgula.
getDate()	Date	Recebe a data e a hora desta mensagem.
getFrom()	String	Extrai o remetente desta mensagem.
getHeader(name)	String	Recebe o valor de um cabeçalho RFC 2822 com base no nome dele.
getId()	String	Recebe o ID desta mensagem.
getPlainBody()	String	Recebe o conteúdo do corpo desta mensagem sem formatação HTML.
getRawContent()	String	Recebe o conteúdo bruto desta mensagem.
getReplyTo()	String	Recebe o endereço de resposta desta mensagem (geralmente o remetente).
getSubject()	String	Extrai o assunto desta mensagem.
getThread()	GmailThread	Recebe a conversa que contém esta mensagem.
getTo()	String	Recebe os destinatários separados por vírgula desta mensagem.
isDraft()	Boolean	Recebe se esta mensagem é um rascunho.
isInChats()	Boolean	Recebe se esta mensagem é um chat.
isInInbox()	Boolean	Recebe se esta mensagem está na caixa de entrada.
isInPriorityInbox()	Boolean	Retorna true se a mensagem estiver na caixa de entrada prioritária. Caso contrário, retorna false.
isInTrash()	Boolean	Recebe se esta mensagem está na lixeira.
isStarred()	Boolean	Recebe se esta mensagem está marcada com estrela.
isUnread()	Boolean	Recebe se esta mensagem não foi lida.
markRead()	GmailMessage	Marca a mensagem como lida.
markUnread()	GmailMessage	Marca a mensagem como não lida.
moveToTrash()	GmailMessage	Move a mensagem para a lixeira.
refresh()	GmailMessage	Recarrega esta mensagem e o estado associado do Gmail. Isso é útil caso os marcadores, o estado de leitura etc. tenham mudado.
reply(body)	GmailMessage	Responde ao remetente desta mensagem usando o endereço de resposta.
reply(body, options)	GmailMessage	Responde ao remetente desta mensagem usando o endereço de resposta, com argumentos opcionais.
replyAll(body)	GmailMessage	Responde ao remetente usando o endereço de resposta e todos os destinatários da mensagem.
replyAll(body, options)	GmailMessage	Responde ao remetente desta mensagem usando o endereço de resposta e todos os destinatários, com argumentos opcionais.
star()	GmailMessage	Marca a mensagem com uma estrela.
unstar()	GmailMessage	Remove a estrela da mensagem.

GmailThread

Métodos

Método	Tipo de retorno	Breve descrição
addLabel(label)	GmailThread	Adiciona esse marcador à conversa.
createDraftReply(body)	GmailDraft	Cria uma mensagem de rascunho respondendo ao remetente da última mensagem nesta conversa usando o endereço de resposta.
createDraftReply(body, options)	GmailDraft	Cria uma mensagem de rascunho respondendo ao remetente da última mensagem nesta conversa usando o endereço de resposta, com argumentos opcionais.
createDraftReplyAll(body)	GmailDraft	Cria uma mensagem de rascunho respondendo ao remetente da última mensagem nesta conversa, usando o endereço de resposta e todos os destinatários da mensagem.
createDraftReplyAll(body, options)	GmailDraft	Cria uma mensagem de rascunho respondendo ao remetente da última mensagem nesta conversa, usando o endereço de resposta e todos os destinatários, com argumentos opcionais.
getFirstMessageSubject()	String	Recebe o assunto da primeira mensagem na conversa.
getId()	String	Recebe o ID desta linha de execução.
getLabels()	GmailLabel[]	Retorna os marcadores criados pelo usuário nesta conversa.
getLastMessageDate()	Date	Recebe a data da mensagem mais recente desta conversa.
getMessageCount()	Integer	Retorna o número de mensagens na conversa.
getMessages()	GmailMessage[]	Recebe as mensagens nesta conversa.
getPermalink()	String	Recebe um link permanente para esta conversa.
hasStarredMessages()	Boolean	Retorna se a conversa tem mensagens marcadas com estrela.
isImportant()	Boolean	Retorna se a conversa está marcada como importante.
isInChats()	Boolean	Retorna se a conversa está marcada como um chat.
isInInbox()	Boolean	Retorna se a conversa está na caixa de entrada.
isInPriorityInbox()	Boolean	Retorna "true" se a conversa estiver na caixa de entrada prioritária. Caso contrário, retorna "false".
isInSpam()	Boolean	Retorna se a conversa está marcada como spam.
isInTrash()	Boolean	Retorna se a conversa está na lixeira.
isUnread()	Boolean	Retorna se a conversa tem mensagens não lidas.
markImportant()	GmailThread	Marca esta conversa como importante.
markRead()	GmailThread	Marca esta conversa como lida.
markUnimportant()	GmailThread	Marca esta conversa como não importante.
markUnread()	GmailThread	Marca esta conversa como não lida.
moveToArchive()	GmailThread	Move a conversa para o arquivo.
moveToInbox()	GmailThread	Move a conversa para a caixa de entrada.
moveToSpam()	GmailThread	Move a conversa para o spam.
moveToTrash()	GmailThread	Move a conversa para a lixeira.
refresh()	GmailThread	Recarrega esta conversa e o estado associado do Gmail. Isso é útil caso os marcadores, o estado de leitura etc. tenham mudado.
removeLabel(label)	GmailThread	Remove o marcador da conversa.
reply(body)	GmailThread	Responda ao remetente da última mensagem nesta conversa usando o endereço "replyTo".
reply(body, options)	GmailThread	Responda ao remetente da última mensagem nesta conversa usando o endereço replyTo, com argumentos opcionais.
replyAll(body)	GmailThread	Responder ao remetente (usando o endereço replyTo) e a todos os destinatários da última mensagem nesta conversa.
replyAll(body, options)	GmailThread	Responda ao remetente (usando o endereço replyTo) e a todos os destinatários da última mensagem nesta conversa, com argumentos opcionais.