Gmail API

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Com a API Gmail, você pode ver e gerenciar os dados da caixa de e-mails, como conversas, mensagens e marcadores.

Serviço: gmail.googleapis.com

Para chamar esse serviço, use as bibliotecas de cliente fornecidas pelo Google. Se o aplicativo precisar usar bibliotecas próprias para chamar esse serviço, utilize as informações a seguir ao fazer as solicitações de API.

Documento de descoberta

Um Documento de descoberta é uma especificação legível por máquina para descrever e consumir APIs REST. Ele é usado para criar bibliotecas de cliente, plug-ins IDE e outras ferramentas que interagem com as APIs do Google. Um serviço pode fornecer vários documentos de descoberta. O serviço fornece o seguinte documento de detecção:

Endpoint de serviço

Um endpoint de serviço é um URL base que especifica o endereço de rede de um serviço de API. Um serviço pode ter vários endpoints de serviço. Este serviço tem o endpoint a seguir e todos os URIs abaixo são relativos a ele:

  • https://gmail.googleapis.com

Recurso REST: v1.users

Métodos
getProfile GET /gmail/v1/users/{userId}/profile
Recebe o perfil do Gmail do usuário atual.
stop POST /gmail/v1/users/{userId}/stop
Parar de receber notificações push da caixa de e-mails do usuário.
watch POST /gmail/v1/users/{userId}/watch
Configure ou atualize um smartwatch para notificações na caixa de e-mails de usuários específica.

Recurso REST: v1.users.drafts

Métodos
create POST /gmail/v1/users/{userId}/drafts
POST /upload/gmail/v1/users/{userId}/drafts
Cria um novo rascunho com o rótulo DRAFT.
delete DELETE /gmail/v1/users/{userId}/drafts/{id}
Exclui o rascunho especificado de maneira imediata e permanente.
get GET /gmail/v1/users/{userId}/drafts/{id}
Recebe o rascunho especificado.
list GET /gmail/v1/users/{userId}/drafts
Lista os rascunhos na caixa de e-mails do usuário.
send POST /gmail/v1/users/{userId}/drafts/send
POST /upload/gmail/v1/users/{userId}/drafts/send
Envia o rascunho existente especificado para os destinatários nos cabeçalhos To, Cc e Bcc.
update PUT /gmail/v1/users/{userId}/drafts/{id}
PUT /upload/gmail/v1/users/{userId}/drafts/{id}
Substitui o conteúdo de um rascunho.

Recurso REST: v1.users.history

Métodos
list GET /gmail/v1/users/{userId}/history
Lista o histórico de todas as alterações na caixa de e-mails determinada.

Recurso REST: v1.users.labels

Métodos
create POST /gmail/v1/users/{userId}/labels
Cria um novo rótulo.
delete DELETE /gmail/v1/users/{userId}/labels/{id}
O marcador especificado é excluído de forma imediata e permanente, e é removido de qualquer mensagem ou conversa em que ele seja aplicado.
get GET /gmail/v1/users/{userId}/labels/{id}
Recebe o rótulo especificado.
list GET /gmail/v1/users/{userId}/labels
Lista todos os marcadores na caixa de e-mails do usuário.
patch PATCH /gmail/v1/users/{userId}/labels/{id}
Faça patch do rótulo especificado.
update PUT /gmail/v1/users/{userId}/labels/{id}
Atualiza o rótulo especificado.

Recurso REST: v1.users.messages

Métodos
batchDelete POST /gmail/v1/users/{userId}/messages/batchDelete
Exclui muitas mensagens pelo ID.
batchModify POST /gmail/v1/users/{userId}/messages/batchModify
Modifica os marcadores nas mensagens especificadas.
delete DELETE /gmail/v1/users/{userId}/messages/{id}
Exclui a mensagem especificada de forma imediata e permanente.
get GET /gmail/v1/users/{userId}/messages/{id}
Recebe a mensagem especificada.
import POST /gmail/v1/users/{userId}/messages/import
POST /upload/gmail/v1/users/{userId}/messages/import
Importa uma mensagem apenas para a caixa de e-mails desse usuário, com verificação e entrega de e-mail padrão semelhantes às recebidas por SMTP.
insert POST /gmail/v1/users/{userId}/messages
POST /upload/gmail/v1/users/{userId}/messages
Insere uma mensagem diretamente na caixa de e-mails do usuário, semelhante a IMAP APPEND, ignorando a maioria das verificações e classificações.
list GET /gmail/v1/users/{userId}/messages
Lista as mensagens na caixa de e-mails do usuário.
modify POST /gmail/v1/users/{userId}/messages/{id}/modify
Modifica os rótulos na mensagem especificada.
send POST /gmail/v1/users/{userId}/messages/send
POST /upload/gmail/v1/users/{userId}/messages/send
Envia a mensagem especificada para os destinatários nos cabeçalhos To, Cc e Bcc.
trash POST /gmail/v1/users/{userId}/messages/{id}/trash
Move a mensagem especificada para a lixeira.
untrash POST /gmail/v1/users/{userId}/messages/{id}/untrash
Remove a mensagem especificada da lixeira.

Recurso REST: v1.users.messages.attachments

Métodos
get GET /gmail/v1/users/{userId}/messages/{messageId}/attachments/{id}
Recebe o anexo de mensagem especificado.

Recurso REST: v1.users.settings

Métodos
getAutoForwarding GET /gmail/v1/users/{userId}/settings/autoForwarding
Recebe a configuração de encaminhamento automático para a conta especificada.
getImap GET /gmail/v1/users/{userId}/settings/imap
Recebe as configurações do IMAP.
getLanguage GET /gmail/v1/users/{userId}/settings/language
Recebe as configurações de idioma.
getPop GET /gmail/v1/users/{userId}/settings/pop
Recebe as configurações POP.
getVacation GET /gmail/v1/users/{userId}/settings/vacation
Recebe as configurações de resposta automática de férias.
updateAutoForwarding PUT /gmail/v1/users/{userId}/settings/autoForwarding
Atualiza a configuração de encaminhamento automático para a conta especificada.
updateImap PUT /gmail/v1/users/{userId}/settings/imap
Atualiza as configurações IMAP.
updateLanguage PUT /gmail/v1/users/{userId}/settings/language
Atualiza as configurações de idioma.
updatePop PUT /gmail/v1/users/{userId}/settings/pop
Atualiza as configurações de POP.
updateVacation PUT /gmail/v1/users/{userId}/settings/vacation
Atualiza as configurações da resposta automática de férias.

Recurso REST: v1.users.settings.cse.identity

Métodos
create POST /gmail/v1/users/{userId}/settings/cse/identities
Cria e configura uma identidade de criptografia do lado do cliente que está autorizada a enviar e-mails da conta de usuário.
delete DELETE /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
Exclui uma identidade de criptografia do lado do cliente.
get GET /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
Recupera uma configuração de identidade da criptografia do lado do cliente.
list GET /gmail/v1/users/{userId}/settings/cse/identities
Lista as identidades criptografadas do lado do cliente para um usuário autenticado.
patch PATCH /gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}
Associa um par de chaves diferente a uma identidade de criptografia do lado do cliente atual.

Recurso REST: v1.users.settings.cse.keypairs

Métodos
create POST /gmail/v1/users/{userId}/settings/cse/keypairs
Cria e faz upload de uma cadeia de certificados de chave pública S/MIME para criptografia do lado do cliente e metadados de chave privada do usuário autenticado.
disable POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable
Desativa um par de chaves de criptografia do lado do cliente.
enable POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enable
Ativa um par de chaves de criptografia do lado do cliente que foi desativado.
get GET /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}
Recupera um par de chaves de criptografia existente do lado do cliente.
list GET /gmail/v1/users/{userId}/settings/cse/keypairs
Lista pares de chaves de criptografia do lado do cliente para um usuário autenticado.
obliterate POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate
Exclui um par de chaves de criptografia do lado do cliente de maneira permanente e imediata.

Recurso REST: v1.users.settings.delegates

Métodos
create POST /gmail/v1/users/{userId}/settings/delegates
Adiciona um delegado com o status de verificação definido diretamente como accepted, sem enviar um e-mail de verificação.
delete DELETE /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
Remove o delegado especificado, que pode ter qualquer status de verificação, e revoga qualquer verificação necessária.
get GET /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
Recebe o delegado especificado.
list GET /gmail/v1/users/{userId}/settings/delegates
Lista os delegados da conta especificada.

Recurso REST: v1.users.settings.filter

Métodos
create POST /gmail/v1/users/{userId}/settings/filters
Cria um filtro.
delete DELETE /gmail/v1/users/{userId}/settings/filters/{id}
Exclui o filtro especificado de maneira imediata e permanente.
get GET /gmail/v1/users/{userId}/settings/filters/{id}
Recebe um filtro.
list GET /gmail/v1/users/{userId}/settings/filters
Lista os filtros de mensagens de um usuário do Gmail.

Recurso REST: v1.users.settings.forwardAddresses

Métodos
create POST /gmail/v1/users/{userId}/settings/forwardingAddresses
Cria um endereço de encaminhamento.
delete DELETE /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
Exclui o endereço de encaminhamento especificado e revoga qualquer verificação necessária.
get GET /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
Recebe o endereço de encaminhamento especificado.
list GET /gmail/v1/users/{userId}/settings/forwardingAddresses
Lista os endereços de encaminhamento para a conta especificada.

Recurso REST: v1.users.settings.sendAs

Métodos
create POST /gmail/v1/users/{userId}/settings/sendAs
Cria um alias "from" personalizado de remetente.
delete DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Exclui o alias "send-as" especificado.
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Recebe o alias "send-as" especificado.
list GET /gmail/v1/users/{userId}/settings/sendAs
Lista os aliases de envio para a conta especificada.
patch PATCH /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Aplicar patch ao alias enviar como especificado.
update PUT /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Atualiza um alias enviar-como.
verify POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify
Envia um e-mail de verificação para o endereço alias de envio especificado.

Recurso REST: v1.users.settings.sendAs.smimeInfo

Métodos
delete DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
Exclui a configuração S/MIME especificada para o alias "send-as" especificado.
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
Recebe a configuração S/MIME especificada para o alias enviar como especificado.
insert POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
Insira (faça upload) a configuração S/MIME especificada para o alias de envio especificado.
list GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
Lista as configurações de S/MIME para o alias de envio especificado.
setDefault POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault
Define a configuração S/MIME padrão para o alias "send-as" especificado.

Recurso REST: v1.users.threads

Métodos
delete DELETE /gmail/v1/users/{userId}/threads/{id}
A conversa especificada será excluída de forma imediata e permanente.
get GET /gmail/v1/users/{userId}/threads/{id}
Recebe a linha de execução especificada.
list GET /gmail/v1/users/{userId}/threads
Lista as linhas de execução na caixa de e-mails do usuário.
modify POST /gmail/v1/users/{userId}/threads/{id}/modify
Modifica as etiquetas aplicadas à linha de execução.
trash POST /gmail/v1/users/{userId}/threads/{id}/trash
Move a linha de execução especificada para a lixeira.
untrash POST /gmail/v1/users/{userId}/threads/{id}/untrash
Remove a linha de execução especificada da lixeira.