MepMail Docs

Introdução

O que é o MepMail e como as peças se encaixam.

MepMail é a plataforma de e-mail open source para pessoas, agentes de IA e aplicações.

Escolha um produto ou use os dois na mesma conta:

  • Correio dá caixas no seu domínio a pessoas e agentes de IA. Leia, rascunhe e responda com as permissões que você definir. Veja Caixas de e-mail e acesso por MCP.
  • Envio entrega os e-mails da sua aplicação por API compatível com o Resend, SMTP ou MCP. Comece pelo início rápido.

Use de duas formas, com o mesmo código nas duas:

  • MepMail Cloud — o serviço hospedado em mepmail.dev. Crie uma conta Free do Envio sem cartão; planos pagos e o teste do Correio têm condições próprias em Preços. Comece com um teste pelo painel antes de verificar o domínio no início rápido. API em api.mepmail.dev.
  • Auto-hospedado — rode na sua própria infraestrutura com Docker Compose, enviando pela sua própria conta AWS SES. Veja Auto-hospedagem.

As duas formas compartilham o mesmo painel, a mesma API HTTP e os mesmos SDKs oficiais do Resend — esta documentação cobre ambas, e as abas Nuvem / Auto-hospedado que você verá em algumas páginas lembram sua escolha. Em volta do núcleo de envio você tem um painel, uma API HTTP, webhooks, contatos, broadcasts e um relay SMTP.

Saia do Resend com um comando

npx @mepmail/cli migrate --from resend

A CLI lê sua conta do Resend (só requisições GET), mostra o plano e, depois da sua confirmação, copia contatos, segmentos, tópicos, propriedades, templates, webhooks, supressões e domínios para o MepMail. migrate plan mostra a prévia sem gravar nada; migrate rollback apaga só o que a ferramenta criou. Nas chamadas de envio suportadas, o seu código muda em duas variáveis:

Antes: Resend
RESEND_API_KEY=re_...
Depois: MepMail
RESEND_API_KEY=ms_...
RESEND_BASE_URL=https://api.mepmail.dev

Migrar do Resend tem o guia completo.

API compatível com Resend

A API HTTP segue o formato da API do Resend: mesmos formatos de requisição e resposta, mesmo formato de erro. Os SDKs oficiais do Resend respeitam uma URL base configurável, então migrar uma integração existente significa trocar duas variáveis de ambiente — a chave de API e a URL base — sem reescrever seu código. Não há SDK nosso para instalar: a página de SDKs cobre os SDKs oficiais do Resend para nove linguagens, com as regras de base URL de cada um.

Uma diferença deliberada: contatos são globais ao time. Não existe o conceito de "audiences" — cada contato pertence diretamente ao seu time, e você segmenta com segmentos (filtros salvos) e tópicos (categorias de inscrição). Veja Contatos.

O que está incluído

ÁreaNotas
API de emailsEnviar, lote, consultar, cancelar envios agendados. Idempotência via header Idempotency-Key.
ContatosContatos do time inteiro, com estado de inscrição, propriedades customizadas e importação CSV.
SegmentosFiltros salvos sobre os contatos, usáveis como alvo de broadcasts.
TópicosCategorias granulares de inscrição, integradas à página de descadastro hospedada.
BroadcastsComponha, agende e envie para todos os contatos, um segmento ou um tópico.
TemplatesTemplates reutilizáveis com campos de mesclagem por contato.
DomíniosVerificação de DNS guiada, BYODKIM, rastreamento e TLS por domínio.
WebhooksAssinaturas Standard Webhooks, seleção de eventos por endpoint, log de entregas.
SupressõesHard bounces e reclamações suprimidos automaticamente.
Descadastro em um cliqueHeaders List-Unsubscribe (RFC 8058) e página de descadastro hospedada.
Relay SMTPSMTP na porta 2587, com STARTTLS, autenticado com chave de API.
MétricasEnvios diários com taxas de bounce e reclamação acompanhadas contra os limites do SES.
PainelPainel completo em inglês e português do Brasil.

Arquitetura em resumo

O MepMail envia pelo AWS SES — na Nuvem isso é gerenciado para você; em uma implantação auto-hospedada é a sua própria conta SES, então você mantém a entregabilidade e o preço do SES. Uma implantação auto-hospedada são dois contêineres:

  • Postgres — o único banco de dados. A fila de jobs (pg-boss) também roda nele; não há Redis.
  • Contêiner do app — roda a API (porta 3001), o worker em segundo plano e o painel web (porta 3000). Um terceiro contêiner opcional roda o relay SMTP (porta 2587). Os processos também podem ser separados um por contêiner com a variável de ambiente PROCESS.

Os corpos dos emails são criptografados em repouso (criptografia de envelope AES-256-GCM) e expurgados após uma janela de retenção. Eventos de entrega (bounces, reclamações, entregas) voltam do SES — na Nuvem automaticamente; auto-hospedado via SNS para uma fila SQS que o worker consome por long polling, mais push para o seu host quando ele tem uma URL HTTPS pública.

Próximos passos

  • Início rápido — do zero ao primeiro email em poucos minutos, na Nuvem ou na sua própria instância.
  • Auto-hospedagem — a referência completa de implantação.
  • Referência da API — gerada a partir do código do servidor, sempre em sincronia.

Para agentes de IA

Toda página desta documentação está disponível como markdown puro acrescentando .md à sua URL (ou enviando Accept: text/markdown). /llms.txt é um índice legível por máquina, /llms-full.txt é a documentação inteira em um arquivo, e /openapi.json é a especificação OpenAPI 3.1 gerada a partir do código da API.

Licença

Baixe gratuitamente o código-fonte correspondente à versão em execução no MepMail Cloud, incluindo suas modificações. O nome do arquivo e o cabeçalho da resposta identificam a revisão.

A plataforma é AGPL-3.0. Os dois pacotes npm — @mepmail/mcp e @mepmail/cli — são publicados separadamente sob MIT. Nenhum dos dois é um SDK.

Nesta página