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
Nome | Breve descrição |
---|---|
GmailApp | Concede 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 de um usuário. |
GmailLabel | Um marcador criado pelo usuário na conta do Gmail de um usuário. |
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 um e-mail de rascunho. |
createDraft(recipient, subject, body, options) | GmailDraft | Cria um e-mail de rascunho com argumentos opcionais. |
createLabel(name) | GmailLabel | Crie um novo marcador 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 para essa conta no Gmail. |
getDraft(draftId) | GmailDraft | Recuperar 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() | 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 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() | Integer | Recebe 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() | Integer | Recebe 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() | Integer | Recebe o número de conversas não lidas com estrela. |
getThreadById(id) | GmailThread | Recebe 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) | GmailLabel | Recupera o rótulo com base no nome dele. |
getUserLabels() | GmailLabel[] | Recupera uma lista de rótulos criados pelo usuário. |
markMessageRead(message) | GmailApp | Marca esta mensagem como lida e força a atualização da mensagem. |
markMessageUnread(message) | GmailApp | Marca esta mensagem como não lida e força a atualização da mensagem. |
markMessagesRead(messages) | GmailApp | Marca estas mensagens como lidas e força a atualização delas. |
markMessagesUnread(messages) | GmailApp | Marca estas 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. |
markThreadRead(thread) | GmailApp | Marca esta conversa como lida e força a atualização. |
markThreadUnimportant(thread) | GmailApp | Marca esta conversa como não importante e força a atualização. |
markThreadUnread(thread) | GmailApp | Marca a conversa como não lida e força a atualização. |
markThreadsImportant(threads) | GmailApp | Marca as conversas como importantes e força as atualizações. |
markThreadsRead(threads) | GmailApp | Marca as linhas de execução como lidas e força a atualização delas. |
markThreadsUnimportant(threads) | GmailApp | Marca as linhas de execução como não importantes e força as atualizações. |
markThreadsUnread(threads) | GmailApp | Marca as conversas como não lidas e força as atualizações. |
moveMessageToTrash(message) | GmailApp | Move a mensagem para a lixeira e força a atualização. |
moveMessagesToTrash(messages) | GmailApp | Move as mensagens especificadas para a lixeira e as força a serem atualizadas. |
moveThreadToArchive(thread) | GmailApp | Move essa linha de execução para o arquivo e força a atualização. |
moveThreadToInbox(thread) | GmailApp | Move essa linha de execução para a Caixa de entrada e força a atualização. |
moveThreadToSpam(thread) | GmailApp | Move essa linha de execução para spam e força a atualização a ela. |
moveThreadToTrash(thread) | GmailApp | Move essa linha para a lixeira e força a atualização. |
moveThreadsToArchive(threads) | GmailApp | Move as linhas de execução para o arquivo e as força a serem atualizadas. |
moveThreadsToInbox(threads) | GmailApp | move as linhas de execução para a caixa de entrada e as força a serem atualizadas. |
moveThreadsToSpam(threads) | GmailApp | move as conversas para a pasta "Spam" e as força a serem atualizadas; |
moveThreadsToTrash(threads) | GmailApp | move as conversas para a lixeira e as força a atualizar. |
refreshMessage(message) | GmailApp | Recarrega a mensagem e o estado associado pelo Gmail (útil se os marcadores, o estado de leitura etc. tiverem mudado). |
refreshMessages(messages) | GmailApp | Recarrega as mensagens e o estado associado pelo Gmail (útil caso os marcadores, o estado de leitura etc. tenham mudado). |
refreshThread(thread) | GmailApp | Recarrega 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) | GmailApp | Recarrega 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) | 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
de mensagem atual que permite que o script acesse as propriedades atuais de GmailMessage . |
starMessage(message) | GmailApp | Adiciona uma estrela a esta mensagem e força a mensagem a ser atualizada. |
starMessages(messages) | GmailApp | Adiciona estrelas a essas mensagens e força as mensagens a serem atualizadas. |
unstarMessage(message) | GmailApp | Remove uma estrela desta mensagem e força a mensagem a ser atualizada. |
unstarMessages(messages) | GmailApp | Remove as estrelas dessas mensagens e força as atualizações. |
GmailAttachment
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
copyBlob() | Blob | Retorna uma cópia desse 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 nesse blob. |
getContentType() | String | Recebe o tipo de conteúdo dos bytes neste blob. |
getDataAsString() | String | Recebe os dados desse blob como uma string com codificação UTF-8. |
getDataAsString(charset) | String | Recebe os dados desse 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 desse blob. |
getSize() | Integer | Recebe o tamanho desse 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 de bytes neste blob com base na extensão do arquivo. |
setDataFromString(string) | Blob | Define os dados desse blob de uma string com codificação UTF-8. |
setDataFromString(string, charset) | Blob | Define os dados desse 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 o rascunho desta mensagem. |
getId() | String | Recebe o ID desta mensagem de rascunho. |
getMessage() | GmailMessage | Retorna uma mensagem do Gmail que representa esse rascunho. |
getMessageId() | String | Retorna o ID do GmailMessage que representa esse rascunho. |
send() | GmailMessage | Envia este e-mail de rascunho. |
update(recipient, subject, body) | GmailDraft | Substitui o conteúdo deste rascunho. |
update(recipient, subject, body, options) | GmailDraft | Substitui o conteúdo desta mensagem de rascunho usando argumentos opcionais. |
GmailLabel
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addToThread(thread) | GmailLabel | Adiciona este marcador à linha de execução especificada e força a atualização (GmailThread.refresh() ). |
addToThreads(threads) | GmailLabel | Adiciona esse marcador às linhas de execução fornecidas e força as linhas de execução a serem atualizadas. |
deleteLabel() | void | Exclui o marcador. |
getName() | String | Recebe 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() | Integer | Recebe o número de conversas não lidas marcadas com esse marcador. |
removeFromThread(thread) | GmailLabel | Remove este marcador da linha de execução especificada e força a linha de execução a ser atualizada. |
removeFromThreads(threads) | GmailLabel | Remove este marcador das linhas de execução fornecidas e força as linhas de execução a serem atualizadas. |
GmailMessage
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
createDraftReply(body) | GmailDraft | Cria um rascunho de mensagem respondendo ao remetente dessa mensagem usando o endereço para resposta. |
createDraftReply(body, options) | GmailDraft | Cria um rascunho de mensagem respondendo ao remetente dessa mensagem usando o endereço para resposta, com argumentos opcionais. |
createDraftReplyAll(body) | GmailDraft | Cria um rascunho de mensagem respondendo ao remetente usando o endereço para resposta e todos os destinatários da mensagem. |
createDraftReplyAll(body, options) | GmailDraft | Cria 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) | GmailMessage | Encaminhar 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 separados por vírgulas como Cco nesta mensagem. |
getBody() | String | Recebe o conteúdo HTML do corpo desta mensagem. |
getCc() | String | Recebe os destinatários separados por vírgula cc'd nesta mensagem. |
getDate() | Date | Recebe a data e a hora da mensagem. |
getFrom() | String | Extrai o remetente desta mensagem. |
getHeader(name) | String | Acessa o valor de um cabeçalho RFC 2822 de acordo com o nome do cabeçalho. |
getId() | String | Recebe o ID desta mensagem. |
getPlainBody() | String | Recebe o conteúdo do corpo da mensagem sem a formatação HTML. |
getRawContent() | String | Recebe o conteúdo bruto desta mensagem. |
getReplyTo() | String | Recebe o endereço para resposta desta mensagem (geralmente o remetente). |
getSubject() | String | Extrai o assunto desta mensagem. |
getThread() | GmailThread | Recebe a conversa que contém essa mensagem. |
getTo() | String | Recebe os destinatários separados por vírgula da mensagem. |
isDraft() | Boolean | Recebe se a mensagem é um rascunho. |
isInChats() | Boolean | Recebe se esta mensagem é um chat. |
isInInbox() | Boolean | Recebe se a mensagem está na caixa de entrada. |
isInPriorityInbox() | Boolean | Retornará true se essa mensagem estiver na caixa de entrada prioritária. Caso contrário, retornará false . |
isInTrash() | Boolean | Recebe se a mensagem está na lixeira. |
isStarred() | Boolean | Recebe se a mensagem está marcada com estrela. |
isUnread() | Boolean | Recebe se a 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 (útil caso os marcadores, o estado de leitura etc. tenham mudado). |
reply(body) | GmailMessage | Responde ao remetente desta mensagem usando o endereço para resposta. |
reply(body, options) | GmailMessage | Responde ao remetente desta mensagem usando o endereço para resposta, com argumentos opcionais. |
replyAll(body) | GmailMessage | Respostas ao remetente usando o endereço para resposta e todos os destinatários desta mensagem. |
replyAll(body, options) | GmailMessage | Responde ao remetente desta mensagem usando o endereço para resposta e todos os destinatários, com argumentos opcionais. |
star() | GmailMessage | Marca a mensagem com estrela. |
unstar() | GmailMessage | Estrela removida da mensagem. |
GmailThread
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addLabel(label) | GmailThread | Adiciona esse marcador à conversa. |
createDraftReply(body) | GmailDraft | Cria um rascunho de mensagem respondendo ao remetente da última mensagem desta conversa usando o endereço para resposta. |
createDraftReply(body, options) | GmailDraft | Cria 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) | GmailDraft | Cria 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) | GmailDraft | Cria 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() | String | Recebe o assunto da primeira mensagem na conversa. |
getId() | String | Recebe o ID desta linha de execução. |
getLabels() | GmailLabel[] | Retorna os rótulos 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 dessa conversa. |
getPermalink() | String | Recebe um link permanente para essa conversa. |
hasStarredMessages() | Boolean | Retorna se a linha de execução tem mensagens com estrela. |
isImportant() | Boolean | Retorna se a linha de execução foi marcada como importante. |
isInChats() | Boolean | Retorna se a conversa está marcada como um chat. |
isInInbox() | Boolean | Retorna se a thread está na Caixa de entrada. |
isInPriorityInbox() | Boolean | Retorna verdadeiro se essa linha de execução está na caixa de entrada prioritária. Caso contrário, retorna falso. |
isInSpam() | Boolean | Retorna se a conversa foi marcada como spam. |
isInTrash() | Boolean | Retorna se a conversa está na lixeira. |
isUnread() | Boolean | Retorna se a conversa tem mensagens não lidas ou não. |
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 esta conversa para o arquivo. |
moveToInbox() | GmailThread | Move essa conversa para a Caixa de entrada. |
moveToSpam() | GmailThread | Move esta conversa para a pasta "Spam". |
moveToTrash() | GmailThread | Move essa 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 este marcador da conversa. |
reply(body) | GmailThread | Responda ao remetente da última mensagem desta conversa usando o endereço "ResponderPara". |
reply(body, options) | GmailThread | Responda ao remetente da última mensagem nesta conversa usando o endereço "ResponderTo", com argumentos opcionais. |
replyAll(body) | GmailThread | Responda ao remetente (usando o endereço "responder") e a todos os destinatários da última mensagem desta conversa. |
replyAll(body, options) | GmailThread | Responda ao remetente (usando o endereço replyTo ) e a todos os destinatários da última mensagem
desta linha de execução, com argumentos opcionais. |