Esta página foi traduzida pela API Cloud Translation.

Gmail Service

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

Nome	Breve descrição
`GmailApp`	Dá acesso a conversas, mensagens e marcadores do Gmail.
`GmailAttachment`	Um anexo do Gmail.
`GmailDraft`	Uma mensagem de rascunho criada por um 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 rascunho de mensagem 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 informado.
`deleteLabel(label)`	`GmailApp`	Exclui o rótulo especificado.
`getAliases()`	`String[]`	Extrai uma lista dos e-mails configurados como aliases dessa conta no Gmail.
`getDraft(draftId)`	`GmailDraft`	Recuperar 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()`	`Integer`	Mostra o número de conversas não lidas na caixa de entrada.
`getMessageById(id)`	`GmailMessage`	Recebe 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()`	`Integer`	Mostra 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()`	`Integer`	Mostra 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()`	`Integer`	Extrai o número de conversas não lidas marcadas com estrela.
`getThreadById(id)`	`GmailThread`	Recebe 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)`	`GmailLabel`	Recupera um rótulo de acordo com o 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 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 a linha de execução como importante e força a atualização dela.
`markThreadRead(thread)`	`GmailApp`	Marca a linha de execução como lida e força a atualização dela.
`markThreadUnimportant(thread)`	`GmailApp`	Marca a 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 conversa a ser atualizada.
`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 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 linha de execução 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 esta conversa para "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 essas conversas para "Spam" e força a atualização delas.
`moveThreadsToTrash(threads)`	`GmailApp`	Move essas linhas de execução 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 marcadores, o estado de leitura etc. tenham sido alterados.
`refreshMessages(messages)`	`GmailApp`	Recarrega as mensagens e o estado associado do Gmail (útil caso os marcadores, o estado de leitura etc. tenham sido alterados).
`refreshThread(thread)`	`GmailApp`	Recarrega a conversa e o estado associado do Gmail (útil caso os marcadores, o estado de leitura etc. tenham sido alterados).
`refreshThreads(threads)`	`GmailApp`	Recarrega 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)`	`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 ao script acessar as propriedades `GmailMessage` atuais.
`starMessage(message)`	`GmailApp`	Marca a mensagem com uma estrela 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 desse blob.
`getAs(contentType)`	`Blob`	Retorne 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`	Extrai 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 deste anexo.
`getName()`	`String`	Recebe o nome desse blob.
`getSize()`	`Integer`	Extrai o tamanho deste anexo.
`isGoogleType()`	`Boolean`	Retorna indicando se o 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 nesse 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 desse blob.

`GmailDraft`

Métodos

Método	Tipo de retorno	Breve descrição
`deleteDraft()`	`void`	Exclui esta mensagem de rascunho.
`getId()`	`String`	Extrai o ID desta mensagem de rascunho.
`getMessage()`	`GmailMessage`	Retorna uma GmailMessage que representa este rascunho.
`getMessageId()`	`String`	Retorna o ID da `GmailMessage` que representa esse rascunho.
`send()`	`GmailMessage`	Envia este rascunho de mensagem de e-mail.
`update(recipient, subject, body)`	`GmailDraft`	Substitui o conteúdo desta mensagem de 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 esse rótulo à linha de execução fornecida e força a linha a ser atualizada (`GmailThread.refresh()`).
`addToThreads(threads)`	`GmailLabel`	Adiciona esse rótulo às linhas de execução fornecidas e força a atualização delas.
`deleteLabel()`	`void`	Exclui este marcador.
`getName()`	`String`	Extrai 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()`	`Integer`	Recebe o número de conversas não lidas marcadas com este marcador.
`removeFromThread(thread)`	`GmailLabel`	Remove esse rótulo da linha de execução fornecida e força a linha a ser atualizada.
`removeFromThreads(threads)`	`GmailLabel`	Remove esse rótulo das linhas de execução fornecidas 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 para responder ao remetente usando o endereço para resposta.
`createDraftReply(body, options)`	`GmailDraft`	Cria uma mensagem de rascunho para responder ao remetente usando o endereço para resposta, com argumentos opcionais.
`createDraftReplyAll(body)`	`GmailDraft`	Cria uma mensagem de rascunho para responder ao remetente usando o endereço para resposta e todos os destinatários desta mensagem.
`createDraftReplyAll(body, options)`	`GmailDraft`	Cria 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)`	`GmailMessage`	Encaminha esta mensagem para os novos destinatários.
`forward(recipient, options)`	`GmailMessage`	Encaminha 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()`	`String`	Extrai os destinatários separados por vírgula incluídos em Cco nesta mensagem.
`getBody()`	`String`	Extrai o conteúdo HTML do corpo desta mensagem.
`getCc()`	`String`	Extrai os destinatários separados por vírgula em cópia na mensagem.
`getDate()`	`Date`	Extrai a data e a hora da mensagem.
`getFrom()`	`String`	Extrai o remetente desta mensagem.
`getHeader(name)`	`String`	Recebe o valor de um cabeçalho RFC 2822 com base no nome do cabeçalho.
`getId()`	`String`	Extrai o ID dessa mensagem.
`getPlainBody()`	`String`	Extrai o conteúdo do corpo desta mensagem sem formatação HTML.
`getRawContent()`	`String`	Extrai o conteúdo bruto dessa mensagem.
`getReplyTo()`	`String`	Extrai o endereço para resposta desta mensagem (geralmente o remetente).
`getSubject()`	`String`	Extrai o assunto desta mensagem.
`getThread()`	`GmailThread`	Extrai a conversa que contém essa mensagem.
`getTo()`	`String`	Extrai os destinatários separados por vírgula desta mensagem.
`isDraft()`	`Boolean`	Verifica se esta mensagem é um rascunho.
`isInChats()`	`Boolean`	Descobre se esta mensagem é um chat.
`isInInbox()`	`Boolean`	Verifica se a mensagem está na caixa de entrada.
`isInPriorityInbox()`	`Boolean`	Retorna `true` se esta mensagem estiver na caixa de entrada prioritária. Caso contrário, retorna `false`.
`isInTrash()`	`Boolean`	Verifica se a mensagem está na lixeira.
`isStarred()`	`Boolean`	Verifica se a mensagem está marcada com estrela.
`isUnread()`	`Boolean`	Mostra 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 essa mensagem e o estado associado do Gmail (útil caso os marcadores, o estado de leitura etc. tenham sido alterados).
`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`	Responde 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`	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 um rascunho para responder ao remetente da última mensagem nesta conversa usando o endereço para resposta.
`createDraftReply(body, options)`	`GmailDraft`	Cria uma mensagem de rascunho respondendo ao remetente da última mensagem nesta conversa usando o endereço para resposta, com argumentos opcionais.
`createDraftReplyAll(body)`	`GmailDraft`	Cria 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)`	`GmailDraft`	Cria 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()`	`String`	Extrai o assunto da primeira mensagem da conversa.
`getId()`	`String`	Extrai o ID dessa linha de execução.
`getLabels()`	`GmailLabel[]`	Retorna os rótulos criados pelo usuário nessa linha de execução.
`getLastMessageDate()`	`Date`	Extrai a data da mensagem mais recente dessa 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 linha de execução 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 essa conversa está 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 esta conversa para o arquivo.
`moveToInbox()`	`GmailThread`	Move esta conversa para a caixa de entrada.
`moveToSpam()`	`GmailThread`	Move esta conversa para a caixa de spam.
`moveToTrash()`	`GmailThread`	Move a conversa para a lixeira.
`refresh()`	`GmailThread`	Recarrega essa conversa e o estado associado do Gmail (útil caso os marcadores, o estado de leitura etc. tenham sido alterados).
`removeLabel(label)`	`GmailThread`	Remove o marcador da conversa.
`reply(body)`	`GmailThread`	Responda ao remetente da última mensagem desta 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`	Responda 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.