Gmail API

A API Gmail permite visualizar e gerenciar dados da caixa de e-mails do Gmail, como conversas, mensagens e marcadores.

Serviço: gmail.googleapis.com

Para chamar esse serviço, recomendamos que você use as bibliotecas de cliente fornecidas pelo Google. Caso seu aplicativo precise usar suas próprias bibliotecas para chamar esse serviço, use as informações a seguir quando fizer as solicitações da 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 de 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
Recupera o perfil do Gmail do usuário atual.
stop POST /gmail/v1/users/{userId}/stop
Parar de receber notificações push para a caixa de correio do usuário.
watch POST /gmail/v1/users/{userId}/watch
Configura ou atualiza uma observação de notificação push na caixa de e-mails do usuário.

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 forma 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 entrada do usuário.
send POST /gmail/v1/users/{userId}/drafts/send
POST /upload/gmail/v1/users/{userId}/drafts/send
Envia o rascunho especificado e atual 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 mudanças na caixa de correio especificada.

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}
Exclui o rótulo especificado imediatamente e permanentemente e o remove de todas as mensagens e linhas de conversa em que ele foi 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 correio do usuário.
patch PATCH /gmail/v1/users/{userId}/labels/{id}
Corrige o 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 várias mensagens por ID.
batchModify POST /gmail/v1/users/{userId}/messages/batchModify
Modifica os rótulos das mensagens especificadas.
delete DELETE /gmail/v1/users/{userId}/messages/{id}
Exclui a mensagem especificada imediatamente e permanentemente.
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 correio desse usuário, com a classificação e a verificação de entrega de e-mail padrão, semelhante à recepção por SMTP.
insert POST /gmail/v1/users/{userId}/messages
POST /upload/gmail/v1/users/{userId}/messages
Insere diretamente uma mensagem na caixa de correio desse usuário, semelhante a IMAP APPEND, ignorando a maioria da verificação e classificação.
list GET /gmail/v1/users/{userId}/messages
Lista as mensagens na caixa de entrada do usuário.
modify POST /gmail/v1/users/{userId}/messages/{id}/modify
Modifica os rótulos da mensagem especificada.
send POST /gmail/v1/users/{userId}/messages/send
POST /upload/gmail/v1/users/{userId}/messages/send
Envia a mensagem especificada aos 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 da 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 de POP.
getVacation GET /gmail/v1/users/{userId}/settings/vacation
Recebe as configurações da resposta automática de férias.
updateAutoForwarding PUT /gmail/v1/users/{userId}/settings/autoForwarding
Atualiza a configuração de encaminhamento automático da conta especificada.
updateImap PUT /gmail/v1/users/{userId}/settings/imap
Atualiza as configurações do 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.identities

Métodos
create POST /gmail/v1/users/{userId}/settings/cse/identities
Cria e configura uma identidade de criptografia do lado do cliente autorizada a enviar e-mails da conta do 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 de criptografia do lado do cliente.
list GET /gmail/v1/users/{userId}/settings/cse/identities
Lista as identidades criptografadas do lado do cliente de 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 já existente.

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 de criptografia do lado do cliente e metadados da chave privada para o 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 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 forma 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 que tenha sido necessária para usá-lo.
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.filters

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 forma 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.forwardingAddresses

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 que possa ter sido exigida.
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 da conta especificada.

Recurso REST: v1.users.settings.sendAs

Métodos
create POST /gmail/v1/users/{userId}/settings/sendAs
Cria um alias de envio "de" personalizado.
delete DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Exclui o alias de envio especificado.
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Recebe o alias de envio especificado.
list GET /gmail/v1/users/{userId}/settings/sendAs
Lista os aliases de envio em nome de outra pessoa para a conta especificada.
patch PATCH /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Patch do alias de envio especificado.
update PUT /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Atualiza um alias de envio como.
verify POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify
Envia um e-mail de verificação para o endereço de e-mail de envio como alias 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 de envio especificado.
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
Recupera a configuração S/MIME especificada para o alias de envio especificado.
insert POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
Insira (faça upload) da 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 do 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 de envio especificado.

Recurso REST: v1.users.threads

Métodos
delete DELETE /gmail/v1/users/{userId}/threads/{id}
Exclui a conversa especificada imediatamente e de forma 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 conversa na caixa de entrada do usuário.
modify POST /gmail/v1/users/{userId}/threads/{id}/modify
Modifica os rótulos aplicados à conversa.
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.