使用说明
Mailpit MCP服务器
独立 模型上下文协议(MCP) 使AI助手能够与之交互的服务器 Mailpit 电子邮件测试环境。
概述
该项目提供了一个MCP服务器,将人工智能助手(Claude、Cursor、VS Code Copilot等)连接到Mailpit的API,实现与您的电子邮件测试工作流程的自然语言交互。
主要特点:
- 使用自然语言浏览、搜索和分析电子邮件
- 检查电子邮件客户端之间的HTML兼容性
- 验证链接并检测损坏的图像
- 对邮件运行垃圾邮件分析(需要SpamAssassin)
- 发送测试电子邮件并管理标签
- 调试电子邮件传递问题
先决条件
- 跑步 Mailpit 实例(MCP服务器通过其HTTP API连接到Mailpit)
- 转到1.24+(如果从源代码构建)
安装
选项1:Docker(推荐)
docker run -d \
--name mailpit-mcp \
-e MAILPIT_URL=http://your-mailpit-host:8025 \
-e MCP_TRANSPORT=http \
-p 3000:3000 \
ghcr.io/amirhmoradi/mailpit-mcp:latest
选项2:Docker编写
创建一个 docker-compose.yml:
services:
mailpit:
image: axllent/mailpit:latest
ports:
- "8025:8025"
- "1025:1025"
mailpit-mcp:
image: ghcr.io/amirhmoradi/mailpit-mcp:latest
environment:
MAILPIT_URL: http://mailpit:8025
MCP_TRANSPORT: http
ports:
- "3000:3000"
depends_on:
- mailpit
运行方式:
docker-compose up -d
选项3:从源代码构建
# Clone the repository
git clone https://github.com/amirhmoradi/mailpit-mcp.git
cd mailpit-mcp
# Build the binary
cd mcp
go build -o mailpit-mcp-server ./cmd/mailpit-mcp-server
# Run the server
MAILPIT_URL=http://localhost:8025 ./mailpit-mcp-server
选项4:去安装
go install github.com/amirhmoradi/mailpit-mcp/cmd/mailpit-mcp-server@latest
配置
使用环境变量配置MCP服务器:
| 变量 | 描述 | 默认值 |
|---|---|---|
MAILPIT_URL |
邮件坑服务器URL | http://localhost:8025 |
MAILPIT_AUTH_USER |
基本身份验证用户名(如果Mailpit需要身份验证) | (无) |
MAILPIT_AUTH_PASS |
基本身份验证密码 | (无) |
MAILPIT_TIMEOUT |
请求超时(秒) | 30 |
MCP_TRANSPORT |
运输方式: stdio 或 http |
stdio |
MCP_HTTP_HOST |
HTTP服务器绑定地址 | 0.0.0.0 |
MCP_HTTP_PORT |
HTTP服务器端口 | 3000 |
MCP_LOG_LEVEL |
日志级别: debug, info, warn, error |
info |
使用AI工具
克劳德桌面版
添加到您的Claude Desktop配置文件中:
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
窗户: %APPDATA%\Claude\claude_desktop_config.json
{
"mcpServers": {
"mailpit": {
"command": "/path/to/mailpit-mcp-server",
"env": {
"MAILPIT_URL": "http://localhost:8025"
}
}
}
}
如果使用Docker:
{
"mcpServers": {
"mailpit": {
"command": "docker",
"args": ["run", "-i", "--rm",
"-e", "MAILPIT_URL=http://host.docker.internal:8025",
"ghcr.io/amirhmoradi/mailpit-mcp:latest"]
}
}
}
光标/VS代码
对于IDE集成,请在HTTP模式下运行MCP服务器:
# Start the server in HTTP mode
MAILPIT_URL=http://localhost:8025 MCP_TRANSPORT=http ./mailpit-mcp-server
然后添加到IDE的MCP配置中:
{
"mcp.servers": {
"mailpit": {
"url": "http://localhost:3000/mcp"
}
}
}
可用工具
| 工具 | 说明 |
|---|---|
list_messages |
按页码列出邮件 |
search_messages |
使用Mailpit查询语法进行搜索 |
get_message |
获取完整的消息详细信息 |
get_message_headers |
获取邮件标题 |
get_message_source |
获取原始RFC 2822源代码 |
get_message_html |
获取渲染的HTML内容 |
get_message_text |
获取纯文本内容 |
get_attachment |
下载附件 |
delete_messages |
按ID删除邮件 |
delete_search |
删除与搜索匹配的邮件 |
set_read_status |
将邮件标记为已读/未读 |
check_html |
检查HTML电子邮件客户端兼容性 |
check_links |
验证电子邮件中的链接 |
check_spam |
获取SpamAssassin分析 |
list_tags |
列出所有标签 |
set_tags |
在邮件上设置标签 |
rename_tag |
重命名标签 |
delete_tag |
删除标签 |
send_message |
发送测试电子邮件 |
release_message |
中继到外部SMTP |
get_chaos |
获取混沌测试配置 |
set_chaos |
配置混沌测试 |
get_info |
获取服务器信息 |
get_webui_config |
获取Mailpit配置 |
可用提示
| 提示 | 描述 |
|---|---|
analyze_latest_email |
对最新电子邮件的全面分析 |
debug_email_delivery |
调试邮件的传递问题 |
check_email_quality |
全面质量检查(HTML、链接、垃圾邮件) |
search_emails |
帮助构建搜索查询 |
compose_test_email |
创建并发送测试电子邮件 |
analyze_email_headers |
深层标头分析 |
compare_emails |
比较两封电子邮件(A/B测试) |
summarize_inbox |
总结收件箱状态 |
搜索语法
搜索工具支持Mailpit的查询语法:
from:email@example.com-发件人地址to:email@example.com-收件人地址subject:keyword-主题包含文本message-id:id-特定消息IDtag:tagname-具有特定标签is:read/is:unread-读取状态has:attachment-有附件before:YYYY-MM-DD-日期之前after:YYYY-MM-DD-日期之后
多个术语与AND逻辑相结合。
发展
# Build
cd mcp
go build ./...
# Test
go test ./...
# Run locally (STDIO mode for Claude Desktop)
MAILPIT_URL=http://localhost:8025 go run ./cmd/mailpit-mcp-server
# Run locally (HTTP mode for IDE integration)
MAILPIT_URL=http://localhost:8025 MCP_TRANSPORT=http go run ./cmd/mailpit-mcp-server
许可证
MIT许可证-请参阅 许可证 了解详情。
