API do Email

32 endpoints em 8 recursos. A permissão de cada rota é a que o código exige — conferida linha a linha, não copiada do nome.

34 endpoints

Configurações de provedor

/email/api/v1/email/provider-configs6

POST/email/api/v1/email/provider-configsCadastra credenciais OAuth da organizaçãoEMAIL_ADMIN
GET/email/api/v1/email/provider-configsLista as configuraçõesEMAIL_READ
GET/email/api/v1/email/provider-configs/:idBusca uma configuraçãoEMAIL_READ
PATCH/email/api/v1/email/provider-configs/:idAtualiza nome, credenciais, padrão ou ativaçãoEMAIL_ADMIN
DELETE/email/api/v1/email/provider-configs/:idExclusão lógicaEMAIL_ADMIN
POST/email/api/v1/email/provider-configs/:id/testValida o formato da configuraçãoEMAIL_ADMIN

/email/api/v1/email/connections4

POST/email/api/v1/email/connections/connectDevolve a URL de autorização do provedorEMAIL_WRITE
GET/email/api/v1/email/connections/callbackCallback do OAuth; redireciona ao redirectUrl**Pública** — sem authMiddleware
GET/email/api/v1/email/connectionsLista as conexões **do usuário do token**EMAIL_READ
DELETE/email/api/v1/email/connections/:idDesconecta (marca REVOKED, exclusão lógica)EMAIL_WRITE

/email/api/v1/email/messages9

GET/email/api/v1/email/messagesLista mensagens; filtros por query stringEMAIL_READ
POST/email/api/v1/email/messages/searchBusca com query longa no corpo da requisiçãoEMAIL_READ
POST/email/api/v1/email/messagesEnvia mensagem ou salva rascunhoEMAIL_WRITE
GET/email/api/v1/email/messages/:idBusca uma mensagem; exige ?connectionId=EMAIL_READ
POST/email/api/v1/email/messages/:id/replyResponde, com replyAll opcionalEMAIL_WRITE
POST/email/api/v1/email/messages/:id/forwardEncaminhaEMAIL_WRITE
PATCH/email/api/v1/email/messages/:idMarca lida ou favorita, muda rótulos, move de pastaEMAIL_WRITE
DELETE/email/api/v1/email/messages/:idMove para a lixeira; ?permanent=true apaga de vezEMAIL_WRITE
GET/email/api/v1/email/messages/:id/attachments/:attIdBaixa o anexo em base64; exige ?connectionId=EMAIL_READ

/email/api/v1/email/threads4

GET/email/api/v1/email/threadsLista conversasEMAIL_READ
GET/email/api/v1/email/threads/:idConversa com todas as mensagens; exige ?connectionId=EMAIL_READ
PATCH/email/api/v1/email/threads/:idAplica a alteração a todas as mensagens da conversaEMAIL_WRITE
DELETE/email/api/v1/email/threads/:idApaga todas as mensagens da conversa; exige ?connectionId=EMAIL_WRITE

/email/api/v1/email/folders1

GET/email/api/v1/email/foldersLista pastas e rótulos; exige ?connectionId=EMAIL_READ

/email/api/v1/email/webhooks4

POST/email/api/v1/email/webhooksCria a assinatura de entregaEMAIL_ADMIN
GET/email/api/v1/email/webhooksLista as assinaturasEMAIL_READ
PATCH/email/api/v1/email/webhooks/:idAtualiza URL, eventos, segredo ou ativaçãoEMAIL_ADMIN
DELETE/email/api/v1/email/webhooks/:idExclusão lógicaEMAIL_ADMIN

/email/api/v1/email/provider-subscriptions3

POST/email/api/v1/email/provider-subscriptionsCria subscription no Graph ou watch no GmailEMAIL_ADMIN
POST/email/api/v1/email/provider-subscriptions/:id/renewEstende a validadeEMAIL_ADMIN
DELETE/email/api/v1/email/provider-subscriptions/:idCancela no provedor e apaga a linhaEMAIL_ADMIN

/email3

POST/email/api/v1/email/providers/notificationsRecebe o push do Graph e do Pub/Sub**Pública** — validação é por provedor
GET/email/healthSonda de saúde do serviçoPública
GET/email/connectedPágina de destino padrão pós-OAuth, para desenvolvimentoPública