Visão geral da API Gmail

A API Gmail é uma API RESTful que pode ser usada para acessar caixas de e-mail do Gmail e enviar e-mails. Para a maioria dos aplicativos da Web, a API Gmail é a melhor opção para acesso autorizado aos dados do Gmail de um usuário e é adequada para vários aplicativos, como:

  • Extração, indexação e backup de e-mails somente leitura
  • Envio de mensagens automatizado ou programático
  • Migração de contas de e-mail
  • Organização de e-mails, incluindo filtragem e classificação de mensagens
  • Padronização de assinaturas de e-mail em uma organização

Termos comuns

Confira a seguir uma lista de termos comuns usados nesta API:

Delegador e delegado
Um delegador é um usuário do Gmail que concede acesso à caixa de e-mails a outro usuário na mesma organização do Google Workspace. O usuário que recebe esse acesso é o delegado. Os delegados podem ler, enviar e excluir mensagens, além de visualizar e adicionar contatos em nome da conta do delegador. Para mais informações, consulte Gerenciar delegados.
Rascunho
Uma mensagem não enviada. Uma mensagem contida no rascunho pode ser substituída. O envio de um rascunho exclui automaticamente o rascunho e cria uma mensagem com o marcador de sistema SENT. Um rascunho é representado pelo drafts recurso. Para mais informações, consulte Trabalhar com rascunhos.
Filtros
Regras avançadas configuradas para uma conta que avaliam mensagens recebidas em relação a critérios de correspondência específicos (como remetente, assunto ou tamanho). Quando uma mensagem corresponde, os filtros acionam automaticamente ações como adicionar ou remover marcadores ou encaminhar o e-mail para um endereço especificado. Para mais informações, consulte Gerenciar filtros.
Endereços de encaminhamento
Endereços de e-mail específicos e verificados configurados para receber mensagens encaminhadas automaticamente da conta de um usuário. Antes que um endereço possa ser usado em uma regra de encaminhamento ou filtro, ele precisa ser registrado e verificado oficialmente para comprovar a propriedade. Para mais informações, consulte Gerenciar encaminhamento.
Rótulo

Um mecanismo para organizar mensagens e threads. Por exemplo, o rótulo "impostos" pode ser criado e aplicado a todas as mensagens e threads relacionados aos impostos de um usuário. Para mais informações, consulte Gerenciar rótulos.

Há dois tipos de rótulos:

Marcadores do sistema
Marcadores criados internamente, como INBOX, TRASH ou SPAM. Esses marcadores não podem ser excluídos ou modificados. No entanto, alguns marcadores do sistema, como INBOX, podem ser aplicados ou removidos de mensagens e threads.
Marcadores do usuário
Marcadores criados por um usuário. Esses marcadores podem ser excluídos ou modificados pelo usuário ou por um aplicativo. Um marcador do usuário é representado pelo labels recurso.
Mensagem

Uma mensagem de e-mail que contém o remetente, os destinatários, o assunto e o corpo. Depois que uma mensagem é criada, ela não pode ser alterada. Uma mensagem é representada pelo messages recurso.

Notificações push

Um sistema de notificação do lado do servidor que se integra ao Google Cloud Pub/Sub. Os aplicativos podem "observar" uma caixa de e-mails, e a API Gmail envia webhooks ou alertas automáticos sempre que ocorre uma mudança (como a chegada de um novo e-mail), eliminando a necessidade de o app consultar continuamente o servidor para atualizações. Para mais informações, consulte Notificações push.

Certificados S/MIME

Certificados digitais enviados para aliases específicos de "Enviar como" que permitem que um usuário envie e-mails criptografados e assinados digitalmente, garantindo a segurança da mensagem e a autenticidade do remetente. Para mais informações, consulte Gerenciar S/MIME certificados.

Aliases de "Enviar como"

Eles representam os vários endereços de e-mail de que uma conta está autorizada a enviar e-mails. Cada conta tem pelo menos um alias que representa o endereço de e-mail principal. Os aliases correspondem ao recurso "Enviar e-mail como" na interface da Web do Gmail e também são a base para configurar assinaturas de e-mail por endereço. Para mais informações, consulte Gerenciar aliases.

Thread

Uma coleção de mensagens relacionadas que formam uma conversa. Em um app cliente de e-mail, um thread é formado quando um ou mais destinatários respondem a uma mensagem com a própria mensagem. Para mais informações, consulte Gerenciar threads.