Visão geral da API Gmail
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
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 automatizadas ou programáticas
- 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
Confira abaixo uma lista de termos comuns usados na API Gmail:
- Mensagem
- Uma mensagem de e-mail com o remetente, os destinatários, o assunto e o corpo. Depois que uma mensagem é criada, ela não pode ser alterada. Uma mensagem é representada
por um recurso de mensagem.
- Thread
- Uma coleção de mensagens relacionadas que formam uma conversa. Em um app cliente de e-mail, uma conversa é formada quando um ou mais destinatários respondem a uma mensagem com
a própria mensagem.
- Rótulo
Um mecanismo para organizar mensagens e conversas. Por exemplo, o marcador "impostos" pode ser criado e aplicado a todas as mensagens e conversas relacionadas aos tributos de um usuário. 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, alguns marcadores do sistema, como INBOX
, podem ser aplicados ou removidos de mensagens e conversas.
- Marcadores de usuário
- Marcadores criados por um usuário. Esses rótulos podem ser excluídos ou modificados pelo
usuário ou por um aplicativo. Um rótulo de usuário é representado por um
recurso de rótulo.
- 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 do sistema SENT
. Um rascunho é representado por um
recurso de rascunho.
Próximas etapas
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-08-29 UTC.
[null,null,["Última atualização 2025-08-29 UTC."],[],[],null,["# Gmail API Overview\n\nThe Gmail API is a RESTful API that can be used to access Gmail mailboxes and\nsend mail. For most web applications the Gmail API is the best choice for\nauthorized access to a user's Gmail data and is suitable for various\napplications, such as:\n\n- Read-only mail extraction, indexing, and backup\n- Automated or programmatic message sending\n- Email account migration\n- Email organization including filtering and sorting of messages\n- Standardization of email signatures across an organization\n\nFollowing is a list of common terms used in the Gmail API:\n\n*Message*\n: An email message containing the sender, recipients, subject, and body. After a\n message has been created, a message cannot be changed. A message is represented\n by a [message resource](/workspace/gmail/api/reference/rest/v1/users.messages#Message).\n\n*Thread*\n: A collection of related messages forming a conversation. In an email client\n app, a thread is formed when one or more recipients respond to a message with\n their own message.\n\n*Label*\n\n: A mechanism for organizing messages and threads. For example,\n the label \"taxes\" might be created and applied to all messages and threads\n having to do with a user's taxes. There are two types of labels:\n\n *System labels*\n : Internally-created labels, such as `INBOX`, `TRASH`, or `SPAM`. These labels\n cannot be deleted or modified. However, some system labels, such as `INBOX`\n can be applied to, or removed from, messages and threads.\n\n *User labels*\n : Labels created by a user. These labels can be deleted or modified by the\n user or an application. A user label is represented by a\n [label resource](/workspace/gmail/api/reference/rest/v1/users.labels).\n\n*Draft*\n\n: An unsent message. A message contained within the draft can be replaced.\n Sending a draft automatically deletes the draft and creates a message with\n the `SENT` system label. A draft is represented by a\n [draft resource](/workspace/gmail/api/reference/rest/v1/users.drafts).\n\nNext steps\n----------\n\n- To learn about developing with Google Workspace APIs, including handling\n authentication and authorization, refer\n to [Get started as a Google Workspace developer](/workspace/guides/getstarted-overview).\n\n- To learn how to configure and run a simple Gmail API app, read the\n [Quickstarts overview](/workspace/gmail/api/guides/quickstarts-overview)."]]