Esta página foi traduzida pela API Cloud Translation.

Gmail Service

Esse serviço permite enviar e-mails, criar rascunhos, gerenciar marcadores, marcar mensagens e conversas e realizar várias outras tarefas de gerenciamento de contas 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`	Dá 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.
`GmailLabel`	Um marcador criado pelo usuário na conta do Gmail.
`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 de rascunho.
`createDraft(recipient, subject, body, options)`	`GmailDraft`	Cria uma mensagem de e-mail de rascunho com argumentos opcionais.
`createLabel(name)`	`GmailLabel`	Crie um novo rótulo de usuário com o nome fornecido.
`deleteLabel(label)`	`GmailApp`	Exclui o rótulo especificado.
`getAliases()`	`String[]`	Retorna uma lista dos e-mails configurados como aliases para essa conta no Gmail.
`getDraft(draftId)`	`GmailDraft`	Extrair um rascunho de mensagem de e-mail por ID.
`getDraftMessages()`	`GmailMessage[]`	Recupera todos os rascunhos de mensagens.
`getDrafts()`	`GmailDraft[]`	Recebe todas as mensagens de rascunho do Gmail.
`getInboxThreads()`	`GmailThread[]`	Recupera todas as linhas de conversa da caixa de entrada, independentemente dos rótulos.
`getInboxThreads(start, max)`	`GmailThread[]`	Recupera uma série de linhas de assunto da Caixa de entrada, independentemente dos marcadores.
`getInboxUnreadCount()`	`Integer`	Recebe o número de linhas de execução 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[][]`	Recuperar todas as mensagens nas conversas especificadas.
`getPriorityInboxThreads()`	`GmailThread[]`	Recupera todas as linhas de execução da caixa de entrada prioritária, independentemente das etiquetas.
`getPriorityInboxThreads(start, max)`	`GmailThread[]`	Recupera uma variedade de conversas da Caixa prioritária, independentemente dos marcadores.
`getPriorityInboxUnreadCount()`	`Integer`	Recebe o número de linhas não lidas na Caixa prioritária.
`getSpamThreads()`	`GmailThread[]`	Recupera todas as linhas de conversa de spam, independentemente dos rótulos.
`getSpamThreads(start, max)`	`GmailThread[]`	Recupera uma variedade de linhas de conversa de spam, independentemente dos rótulos.
`getSpamUnreadCount()`	`Integer`	Recebe o número de linhas de execução não lidas que são spam.
`getStarredThreads()`	`GmailThread[]`	Recupera todas as conversas marcadas com estrela, independentemente dos rótulos.
`getStarredThreads(start, max)`	`GmailThread[]`	Recupera um intervalo de linhas com estrelas, independentemente dos rótulos.
`getStarredUnreadCount()`	`Integer`	Recebe o número de linhas com estrelas não lidas.
`getThreadById(id)`	`GmailThread`	Recebe uma linha por ID.
`getTrashThreads()`	`GmailThread[]`	Recupera todos os threads de lixo, independentemente dos rótulos.
`getTrashThreads(start, max)`	`GmailThread[]`	Recupera uma variedade de linhas de lixo, independentemente dos rótulos.
`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 esta 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 linha de execução como importante e força a atualização dela.
`markThreadRead(thread)`	`GmailApp`	Marca esta conversa como lida e a força a atualizar.
`markThreadUnimportant(thread)`	`GmailApp`	Marca essa conversa como não importante e a força a atualizar.
`markThreadUnread(thread)`	`GmailApp`	Marca esta conversa como não lida e a força a atualizar.
`markThreadsImportant(threads)`	`GmailApp`	Marca essas linhas de execução como importantes e as força a atualizar.
`markThreadsRead(threads)`	`GmailApp`	Marca essas conversas como lidas e as força a serem atualizadas.
`markThreadsUnimportant(threads)`	`GmailApp`	Marca essas linhas como não importantes e força a atualização delas.
`markThreadsUnread(threads)`	`GmailApp`	Marca essas conversas como não lidas e as força a serem atualizadas.
`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 a linha de execução 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 para o arquivo e força a atualização delas.
`moveThreadsToInbox(threads)`	`GmailApp`	Move essas conversas para a caixa de entrada e as força a atualizar.
`moveThreadsToSpam(threads)`	`GmailApp`	Move essas linhas para spam e força a atualização delas.
`moveThreadsToTrash(threads)`	`GmailApp`	Move essas linhas para a lixeira e força a atualização delas.
`refreshMessage(message)`	`GmailApp`	Recarrega a mensagem e o estado associado do Gmail (útil caso os rótulos, o estado de leitura etc. tenham mudado).
`refreshMessages(messages)`	`GmailApp`	Recarrega as mensagens e o estado associado do Gmail (útil caso os rótulos, o estado de leitura etc. tenham mudado).
`refreshThread(thread)`	`GmailApp`	Recarrega a conversa e o estado associado do Gmail (útil caso os rótulos, o estado de leitura etc. tenham mudado).
`refreshThreads(threads)`	`GmailApp`	Recarrega as linhas de execução e o estado associado do Gmail. Isso é útil se os rótulos, o estado de leitura etc. tiverem mudado.
`search(query)`	`GmailThread[]`	Pesquisar o Gmail com a consulta indicada.
`search(query, start, max)`	`GmailThread[]`	Pesquisar o Gmail com a consulta indicada.
`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 à mensagem atual que permite que o script acesse as propriedades `GmailMessage` atuais.
`starMessage(message)`	`GmailApp`	Adiciona uma estrela a esta 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 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`	Retorna os dados dentro deste objeto como um blob convertido para o tipo de conteúdo especificado.
`getBytes()`	`Byte[]`	Consegue os dados armazenados neste 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`	Consegue os dados desse blob como uma string com a codificação especificada.
`getHash()`	`String`	Extrai o hash de conteúdo SHA1 para este anexo.
`getName()`	`String`	Extrai o nome desse blob.
`getSize()`	`Integer`	Extrai o tamanho do anexo.
`isGoogleType()`	`Boolean`	Retorna 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 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 do blob.

`GmailDraft`

Métodos

Método	Tipo de retorno	Breve descrição
`deleteDraft()`	`void`	Exclui este rascunho de mensagem.
`getId()`	`String`	Recebe o ID do rascunho da mensagem.
`getMessage()`	`GmailMessage`	Retorna uma GmailMessage que representa esse rascunho.
`getMessageId()`	`String`	Retorna o ID do `GmailMessage` que representa esse rascunho.
`send()`	`GmailMessage`	Enviar esta mensagem de e-mail de rascunho.
`update(recipient, subject, body)`	`GmailDraft`	Substitui o conteúdo do rascunho da mensagem.
`update(recipient, subject, body, options)`	`GmailDraft`	Substitui o conteúdo do rascunho da mensagem 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 especificada e força a atualização da linha de execução (`GmailThread.refresh()`).
`addToThreads(threads)`	`GmailLabel`	Adiciona esse rótulo às linhas de execução especificadas e força a atualização delas.
`deleteLabel()`	`void`	Exclui este rótulo.
`getName()`	`String`	Extrai o nome desse marcador.
`getThreads()`	`GmailThread[]`	Recebe as linhas de execução marcadas com esse rótulo.
`getThreads(start, max)`	`GmailThread[]`	Recebe um intervalo de linhas de execução marcadas com esse rótulo.
`getUnreadCount()`	`Integer`	Recebe o número de linhas não lidas marcadas com esse rótulo.
`removeFromThread(thread)`	`GmailLabel`	Remove esse rótulo da linha de execução especificada e força a atualização dela.
`removeFromThreads(threads)`	`GmailLabel`	Remove esse rótulo das linhas de execução 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 que responde ao remetente usando o endereço de resposta.
`createDraftReply(body, options)`	`GmailDraft`	Cria uma mensagem de rascunho que responde ao remetente usando o endereço de resposta, com argumentos opcionais.
`createDraftReplyAll(body)`	`GmailDraft`	Cria um rascunho de mensagem que responde ao remetente usando o endereço de resposta e todos os destinatários da mensagem.
`createDraftReplyAll(body, options)`	`GmailDraft`	Cria uma mensagem de rascunho que responde ao remetente usando o endereço de resposta e todos os destinatários, com argumentos opcionais.
`forward(recipient)`	`GmailMessage`	Encaminha a mensagem para 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`	Recebe os destinatários com cópia oculta separados por vírgulas nesta mensagem.
`getBody()`	`String`	Recebe o conteúdo HTML do corpo desta mensagem.
`getCc()`	`String`	Recebe os destinatários em cópia separados por vírgulas nesta mensagem.
`getDate()`	`Date`	Recebe a data e a hora dessa mensagem.
`getFrom()`	`String`	Extrai o remetente desta mensagem.
`getHeader(name)`	`String`	Extrai o valor de um cabeçalho RFC 2822 com base no nome do cabeçalho.
`getId()`	`String`	Extrai o ID desta mensagem.
`getPlainBody()`	`String`	Recebe o conteúdo do corpo desta mensagem sem formatação HTML.
`getRawContent()`	`String`	Retorna 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 linha de execução que contém esta mensagem.
`getTo()`	`String`	Recebe os destinatários desta mensagem separados por vírgulas.
`isDraft()`	`Boolean`	Verifica se a mensagem é um rascunho.
`isInChats()`	`Boolean`	Verifica se a mensagem é um chat.
`isInInbox()`	`Boolean`	Verifica se a 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`	Verifica se a mensagem está na lixeira.
`isStarred()`	`Boolean`	Verifica se a mensagem está marcada com estrela.
`isUnread()`	`Boolean`	Verifica se a mensagem está 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 rótulos, o estado de leitura etc. tenham mudado).
`reply(body)`	`GmailMessage`	Resposta 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`	Resposta ao remetente usando o endereço de resposta e todos os destinatários desta 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 este rótulo à conversa.
`createDraftReply(body)`	`GmailDraft`	Cria uma mensagem de rascunho que responde ao remetente da última mensagem nesta conversa usando o endereço de resposta.
`createDraftReply(body, options)`	`GmailDraft`	Cria uma mensagem de rascunho que responde ao remetente da última mensagem nesta conversa usando o endereço de resposta, com argumentos opcionais.
`createDraftReplyAll(body)`	`GmailDraft`	Cria um rascunho de mensagem que responde ao remetente da última mensagem nesta conversa, usando o endereço de resposta e todos os destinatários dessa mensagem.
`createDraftReplyAll(body, options)`	`GmailDraft`	Cria uma mensagem de rascunho que responde 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 rótulos criados pelo usuário nesta linha de execução.
`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 desta conversa.
`getPermalink()`	`String`	Recebe um link permanente para essa 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 linha de execução está marcada como uma conversa.
`isInInbox()`	`Boolean`	Retorna se a conversa está na caixa de entrada.
`isInPriorityInbox()`	`Boolean`	Retorna verdadeiro se a linha de execução estiver na caixa de entrada prioritária. Caso contrário, retorna falso.
`isInSpam()`	`Boolean`	Retorna se a conversa está marcada como spam.
`isInTrash()`	`Boolean`	Retorna se a linha de execução 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 essa linha de execução para o arquivo.
`moveToInbox()`	`GmailThread`	Move essa conversa para a caixa de entrada.
`moveToSpam()`	`GmailThread`	Move essa conversa para a caixa de spam.
`moveToTrash()`	`GmailThread`	Move a conversa para a lixeira.
`refresh()`	`GmailThread`	Recarrega esta conversa e o estado associado do Gmail (útil caso os rótulos, o estado de leitura etc. tenham mudado).
`removeLabel(label)`	`GmailThread`	Remove esse rótulo 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 desta conversação.
`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.