mxout Docs Documentação f5e7f0e

Comece aqui

  • Introdução
  • O que é o mxout
  • Primeiro envio (5 min)
  • Arquitetura
  • Changelog

Guias

  • Adicionar um domínio
  • Ligar uma aplicação (cliente)
  • Configurar DNS (SPF/DKIM/DMARC/PTR)
  • Deploy com Docker

Referência

  • API — visão geral
  • POST /send
  • POST /send-raw (MIME cru)
  • GET /health
  • GET /check (validação DNS)
  • Clientes (gestão via API)
  • Domínios (gestão via API)
  • Rate limit (controle)
  • Fila (consulta e drenagem)
  • IP allowlist
  • Configuração (mxout.json + env)
  • Ledger (mecanismo de controle)
  • CLI — mxout-keygen
  • CLI — mxout check (validação DNS)
  • CLI — mxout tick (drena a fila)

Conceitos

  • Assinatura DKIM
  • Entrega MX direta
  • Submissão SMTP

Suporte

  • Troubleshooting
  • FAQ
mxout Docs Documentação f5e7f0e

Tag: api

10 documentos encontrados.

API — visão geral

Referência da API HTTP do mxout, com endpoints, autenticação e formato de erros.

api referencia http

POST /send

Referência completa do endpoint de envio de e-mail do mxout.

api send referencia

POST /send-raw

Envia uma mensagem MIME já montada, preservando anexos e headers.

api envio mime anexo dkim

GET /health

Endpoint de liveness do mxout, usado por healthchecks de container e proxy reverso.

api health referencia

GET /check

Valida o DNS (DKIM/SPF/DMARC) dos domínios remetentes via HTTP, em JSON.

api check dns dkim spf dmarc validacao monitoracao

Clientes (gestão via API)

Registro de clientes do mxout — quem pode enviar, por quais domínios, com credencial própria.

api clientes autenticação credenciais

Domínios (gestão via API)

Adiciona, lista e recupera instruções DNS de domínios remetentes gerenciados pelo mxout.

api domains dkim

Rate limit (controle)

Lê e ajusta os limites de envio e de requisições por IP do mxout.

api rate-limit

Fila (consulta e drenagem)

Estado das entregas, retry com backoff e o tick que drena a fila.

api fila retry cron backoff

IP allowlist

Restringe quais IPs podem chamar a API do mxout via lista de endereços e faixas CIDR.

api security allowlist
← Voltar para o início