mailcue-mcp
Dê aos agentes de IA sua própria caixa de correio local para ler, enviar e triar e-mails.
Documentação
Um servidor de e-mail realista para testes em um único contêiner Docker.
O MailCue empacota Postfix, Dovecot, OpenDKIM, OpenDMARC, SpamAssassin, uma API REST FastAPI e uma interface web React em um único contêiner Docker gerenciado pelo s6-overlay. Ele executa uma pilha de e-mail completa com acesso IMAP/POP3, assinatura DKIM, verificação DMARC, filtragem de spam, TLS e criptografia GPG, para que você possa testar e-mail da mesma forma que ele se comporta em produção. Defina MAILCUE_MODE=production e o mesmo contêiner funciona como um servidor de e-mail real.
Recursos · Início rápido · Documentação · Contribuição
Recursos
| Capacidade | O que faz |
|---|---|
| SMTP catch-all | Aceita e-mail para qualquer endereço em qualquer domínio. Nada sai do contêiner. |
| IMAP e POP3 | Leia e-mails capturados com qualquer cliente padrão via STARTTLS ou TLS implícito. |
| Interface web | Aplicativo React com barra lateral de caixa de entrada, navegação por pastas, visualizador de e-mail e diálogo de composição. |
| API REST e SDKs | API JSON para enviar, receber, injetar, pesquisar e excluir e-mail, com SDKs para Python e Node. |
| Injeção de e-mail | Insira mensagens diretamente em uma caixa de entrada via IMAP APPEND para configuração determinística de testes, com cabeçalhos realistas. |
| Teste de entregabilidade | Crie uma caixa de entrada com pontuação com autenticação, SpamAssassin, conteúdo, cabeçalho e diagnósticos de transporte pela interface web, API REST, SDK Node e MCP. |
| DKIM, DMARC, SPF | Assinatura OpenDKIM, verificação OpenDMARC e verificações de política SPF, com cabeçalhos Authentication-Results. |
| Filtragem de spam | SpamAssassin pontua e-mails recebidos com limite configurável, filtragem bayesiana e verificações RBL. |
| TLS em todos os lugares | Certificados gerados automaticamente para SMTP STARTTLS, IMAPS e POP3S. Envie os seus próprios pela interface. |
| GPG / PGP-MIME | Chaves GPG por caixa de entrada. Assine, criptografe, verifique e descriptografe e-mails (RFC 3156). Publique chaves em keys.openpgp.org. |
| Eventos em tempo real | Um fluxo Server-Sent Events envia email.received, email.deleted, mailbox.created e muito mais. |
| Chaves de API com escopo | Autenticação X-API-Key com escopos por chave (leitura, envio, exclusão e mais) e uma lista de permissões opcional de caixas de entrada. |
| Servidor MCP | Um servidor oficial Model Context Protocol dá a um agente de IA sua própria caixa de entrada. |
| Gerenciamento de domínios | Adicione domínios personalizados com DKIM automático e um painel DNS para MX, SPF, DKIM, DMARC, MTA-STS e TLS-RPT. |
| Multiusuário | Cotas de caixa de entrada por usuário e caixas de entrada, e-mails, chaves GPG e chaves de API isolados. |
| Modo de produção | Um servidor de e-mail endurecido com domínios estritos, TLS obrigatório, rejeição DMARC e certificados Let's Encrypt. |
| Sandbox de provedores | Capture tráfego de API de SMS, voz e chat de saída com endpoints idênticos e webhooks assinados. |
| Banco de dados flexível | SQLite sem configuração com criptografia AES-256 opcional, ou PostgreSQL externo para cargas de trabalho de produção concorrentes. |
Início rápido
Docker Compose
git clone https://github.com/Olib-AI/mailcue.git
cd mailcue
docker compose up -d
Abra http://localhost:8088 e faça login com o nome de usuário admin e a senha mailcue.
Docker run
docker run -d \
--name mailcue \
-p 8088:80 \
-p 25:25 \
-p 587:587 \
-p 143:143 \
-p 993:993 \
-v mailcue-data:/var/mail/vhosts \
-v mailcue-db:/var/lib/mailcue \
-e MAILCUE_DOMAIN=mailcue.local \
-e MAILCUE_ADMIN_PASSWORD=mailcue \
ghcr.io/olib-ai/mailcue
Verifique se funciona
curl http://localhost:8088/api/v1/health
Opções de banco de dados
O MailCue usa SQLite por padrão, o que mantém implantações locais e pequenas simples. Instalações de produção com tráfego concorrente de API, sandbox de provedores, HTTP-bin ou aquecimento de e-mail devem usar PostgreSQL. O MailCue suporta um banco de dados PostgreSQL gerenciado ou um contêiner PostgreSQL na mesma rede Docker privada. Pool de conexões, índices de produção, chaves estrangeiras, migrações automáticas de esquema e um comando offline de migração de SQLite para PostgreSQL estão incluídos.
Consulte Implantação em produção para exemplos de Docker Compose e o procedimento de migração. Consulte Configuração para cada variável de ambiente do banco de dados.
Documentação
📖 Leia os guias completos e interativos no Site Oficial de Documentação do MailCue.
| Guia | Aborda |
|---|---|
| Arquitetura | Layout do contêiner, fluxo de solicitações e pilha de tecnologia. |
| Configuração | Variáveis de ambiente e portas expostas. |
| Referência da API | Endpoints REST, autenticação e escopos de chave de API. |
| Implantação em produção | Modo endurecido, implantação e migração PostgreSQL, registros DNS e certificados TLS. |
| Clientes de e-mail e confiança TLS | Configuração IMAP/POP3/SMTP e confiança na CA. |
| Uso em CI/CD | Configuração de pipeline e exemplos de plataformas. |
| Servidor MCP | Dê a um agente de IA sua própria caixa de entrada via MCP. |
| Sandbox de provedores e HTTP bin | Capture tráfego de SMS, voz e chat, e inspecione solicitações HTTP. |
| Compartilhando MailCue entre projetos | Execute um contêiner atrás de uma rede Docker compartilhada. |
| Desenvolvimento e contribuição | Configuração local, linting, testes e processo de PR. |
A API também é servida como interface Swagger interativa em /api/docs, com especificações legíveis por máquina em openapi.json e postman_collection.json. Consulte o guia de teste de entregabilidade para pontuação, testes visuais, posicionamento, provedores, agendamentos e políticas de CI.
Os SDKs e o servidor MCP têm sua própria documentação: SDK Python, SDK Node e servidor MCP.
Contribuição
Contribuições são bem-vindas. Consulte Desenvolvimento e contribuição para configuração local, linting, verificações de tipo, testes e o processo de pull request.
Licença
MIT. Consulte LICENÇA.
Histórico de estrelas
Links
- Olib AI: www.olib.ai
- GitHub: github.com/Olib-AI/mailcue
- Registro de contêineres: ghcr.io/olib-ai/mailcue
- Documentação da API: disponível em
/api/docsquando em execução - Problemas: github.com/Olib-AI/mailcue/issues
- Discussões: github.com/Olib-AI/mailcue/discussions
Se você achar o MailCue útil, considere dar uma estrela no GitHub. Isso ajuda outras pessoas a descobrirem o projeto.
Construído por Olib AI