Receber e-mails
Leia e-mails com a API
Leia os e-mails que chegam no seu domínio a partir do seu próprio código. Liste conversas, abra mensagens, busque, marque, organize, envie e responda, tudo por um único endpoint.
- REST
- JSON
- Threads e busca
- Marcadores e pastas
- Enviar e responder
https://g.sendcorex.comComo funciona
Um token, uma caixa de correio
Seu token pertence a um remetente, e um remetente é uma caixa de correio. Nenhum argumento escolhe de quem são os e-mails que você lê: o token decide.
Um endpoint para tudo
Listar, ler, buscar, marcar, mover, enviar e responder são comandos enviados para POST /v1. Envie até 20 por requisição.
Tokens de curta duração
O access token dura 1 hora e o refresh token 15 dias. O refresh token é trocado a cada uso.
Configure sua caixa de correio
Faça isto uma vez. Depois, cada requisição só precisa do seu token.
- 1
Adicione um domínio ou use um compartilhado
Verifique seu próprio domínio, ou pule a configuração de DNS e use um domínio compartilhado.
- 2
Crie um remetente
Um remetente é uma caixa de correio. Crie um no seu domínio verificado ou em um domínio compartilhado: em um domínio compartilhado, criar o remetente cria a caixa de correio.
Se você registrou seu próprio domínio e já enviou um e-mail, o remetente foi criado automaticamente para você.
- 3
Aponte seu registro MX
Só é necessário se você quiser receber e-mails no seu próprio domínio. Aponte o registro MX para o host de entrada da Sendcorex.
- 4
Gere seus tokens
Abra o webmail, vá em Configurações e gere um access token e um refresh token para o remetente.
- 5
Chame a API
Envie seu token no header Authorization e seu primeiro comando para POST /v1.
Registro MX
Para receber e-mails no seu próprio domínio, o registro MX dele precisa apontar para o host de entrada da Sendcorex. Adicione este registro no seu provedor de DNS.
- Tipo
MX - Aponta para
bounce.emailsbit.com
O registro MX serve só para receber no seu próprio domínio. Sem ele, você ainda pode enviar e ler os bounces e reclamações que voltam para sua caixa de correio.
O que chega na caixa de correio
E-mails comuns
Tudo o que é enviado para o endereço do seu remetente, como em qualquer caixa de correio.
Mensagens do return path
Bounces e outras mensagens que voltam para o return path também são salvos na caixa de correio, então você pode lê-los pela API.
Reclamações
Reclamações de spam também são salvas na caixa de correio. Elas só vêm do Microsoft 365 e dos serviços da Microsoft em geral.
Sua primeira requisição
Liste as conversas não lidas da sua INBOX. Substitua SENDCOREX_TOKEN pelo access token das configurações do webmail.
curl -X POST 'https://g.sendcorex.com/v1' \
-H "Authorization: $SENDCOREX_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"commands": [
{ "command": "list_threads", "args": { "folder": "INBOX", "is_read": false, "limit": 10 } }
]
}'Cada thread tem um last_message_uid. Passe-o para Obter mensagens para ler o e-mail, ou para Responder para respondê-lo.
Referência completa
Tudo o que está marcado como CMD é um comando enviado por POST /v1, até 20 por requisição. As rotas usam seus próprios caminhos.
Rotas
4Identidade
1Pastas e contadores
5Leitura
5Flags e marcadores
8- CMDDefinir flagsLida, com estrela, importante
- CMDAdicionar marcadoresMarcadores sem diferenciar maiúsculas
- CMDRemover marcadoresMarcadores sem diferenciar maiúsculas
- CMDMarcar imagens como carregadasLimpa a flag de imagens externas
- CMDListar marcadoresNomes e cores
- CMDCriar marcadorNovo marcador
- CMDDefinir cor do marcadorAltera a cor
- CMDExcluir marcadorDe todas as mensagens
Organizar
4Envio e confiança
9- CMDEnviar e-mailNova mensagem, salva em Enviados
- CMDResponderMesma conversa, mantém os marcadores
- CMDObter confiançaStatus de confiança de um remetente
- CMDDefinir confiançaPadrão, confiável ou não confiável
- CMDListar confiançaRemetentes com uma decisão
- CMDEncaminharAnexos originais incluídos
- CMDObter rastreamentoAberturas e cliques dos e-mails enviados
- CMDListar atividadeQuem abriu, clicou ou se descadastrou
- CMDContadores de atividadeBadges das pastas de Atividade
Anexos
4Agendamento
3Rascunhos
5Regras
10- CMDListar regrasEm ordem de execução, com hits
- CMDObter regraUma regra
- CMDCriar regraFiltros para todo e-mail novo
- CMDAtualizar regraSubstitui a regra
- CMDExcluir regraRemove uma regra
- CMDAtivar ou desativar regraLigada ou desligada
- CMDReordenar regrasOrdem de execução
- CMDOpções de regraCampos, operadores, ações
- CMDTestar regraTeste nos e-mails recentes
- CMDAplicar regraRoda nos e-mails que já estão lá
Templates
6Contato e follow-up
5Contatos e público
12- CMDListar contatosPessoas que conversam com esta caixa
- CMDContar contatosQuantas pessoas batem com um filtro
- CMDVer contato da caixaUm contato com contagens e confiança
- CMDAtualizar nome do contatoMudar o nome de um contato
- CMDMarcar contato com tagAdicionar ou remover tags
- CMDVer histórico do contatoAberturas, cliques e emails de um contato
- CMDListar segmentosSegmentos salvos da caixa
- CMDSalvar segmentoCriar ou editar um segmento
- CMDApagar segmentoApagar um segmento
- CMDVer públicoTamanho de um público antes de enviar
- CMDVerificar destinatáriosQuem se descadastrou, antes de enviar
- CMDVer status de entregaEntrega por destinatário de um email enviado