Visão geral da API Gmail

A API Gmail é uma API RESTful que permite 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 conta 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:

Delegante e delegado
Um delegante é um usuário do Gmail que concede acesso à caixa de e-mail para 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 ver e adicionar contatos em nome da conta do delegante. Para mais informações, consulte Gerenciar delegados.
Rascunho
Uma mensagem não enviada. Você pode substituir a mensagem contida no rascunho. O envio de um rascunho exclui automaticamente o rascunho e cria uma mensagem com o marcador do sistema SENT. O recurso drafts representa um rascunho. Para mais informações, consulte Trabalhar com rascunhos.
Filtros
Regras avançadas configuradas para uma conta que avaliam as 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 de usar um endereço em uma regra de encaminhamento ou filtro, é necessário registrá-lo e verificá-lo para comprovar a propriedade. Para mais informações, consulte Gerenciar encaminhamento.
Rótulo

Um mecanismo para organizar mensagens e conversas. Por exemplo, você pode criar o marcador "impostos" e aplicá-lo a todas as mensagens e conversas relacionadas a impostos. Para mais informações, consulte Gerenciar rótulos.

Há dois tipos de rótulos:

Marcadores do sistema
Rótulos criados internamente, como INBOX, TRASH ou SPAM. Não é possível excluir ou modificar esses rótulos. No entanto, é possível aplicar ou remover alguns rótulos do sistema, como INBOX, em mensagens e conversas.
Marcadores do usuário
Marcadores criados por um usuário. Um usuário ou um aplicativo pode excluir ou modificar esses marcadores. O recurso labels representa um rótulo de usuário.
Mensagem

Uma mensagem de e-mail com o remetente, os destinatários, o assunto e o corpo. Depois de criar uma mensagem, não é possível mudá-la. O recurso messages representa uma mensagem.

Notificações push

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

Certificados S/MIME

Certificados digitais enviados para aliases de envio como específicos. Com eles, você pode enviar e-mails criptografados e assinados digitalmente, garantindo a segurança das mensagens e a autenticidade do remetente. Para mais informações, consulte Gerenciar certificados S/MIME.

Aliases de envio como

Eles representam os vários endereços de e-mail de que uma conta tem autorização para enviar mensagens. 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

Um conjunto de mensagens relacionadas que formam uma conversa. Em um cliente de e-mail, uma conversa é formada quando um ou mais destinatários respondem a uma mensagem com a própria mensagem. Para mais informações, consulte Gerenciar conversas.

  • Para saber mais sobre o desenvolvimento com as APIs do Google Workspace, incluindo o processamento de autenticação e autorização, consulte Desenvolver no Google Workspace.

  • Para saber como configurar e executar um app da API Gmail, leia os Inícios rápidos.