README
🚀 电邮发送器 MCP
电邮发送器 MCP 是一个模型上下文协议(MCP)服务器,专为发送电子邮件而设计。它完全独立于 SMTP 提供程序,您可以使用任意 SMTP 中继服务(如 Gmail、SendGrid、Mailgun、SMTP2Go 等),只需配置相应的环境变量即可。该服务器提供了一系列工具,支持通过 SMTP 并利用环境变量配置来发送电子邮件。
✨ 主要特性
- 邮件发送:可向指定收件人发送电子邮件。
- 功能测试:支持测试电子邮件功能。
- 灵活配置:通过环境变量进行配置。
- 错误处理:具备正确的错误处理和日志记录机制。
- 类型安全:采用 TypeScript 实现,确保类型安全。
📦 安装指南
- 克隆仓库:
git clone https://github.com/yourusername/mailer-mcp.git
cd mailer-mcp
- 安装依赖项:
npm install
- 构建项目:
npm run build
📚 详细文档
配置
服务器需要在 MCP 配置中设置以下环境变量:
| 属性 | 详情 | 示例 |
|------|------|------|
| SMTP_HOST | SMTP 服务器主机名 | smtp.example.com |
| SMTP_PORT | SMTP 服务器端口 | 587 |
| SMTP_USER | SMTP 用户名 | user@example.com |
| SMTP_PASSWORD | SMTP 密码 | password123 |
| EMAIL_FROM | 发件人电子邮件地址 | sender@example.com |
可选环境变量:
| 属性 | 详情 | 默认值 |
|------|------|------|
| SMTP_SECURE | 使用安全连接(TLS) | false |
| SMTP_REJECT_UNAUTHORIZED | 拒绝未授权的 TLS 证书 | true |
| SMTP_TIMEOUT | 连接超时时间(以毫秒为单位) | 10000 |
MCP 配置
将以下内容添加到您的 Cline MCP 设置配置文件中:
"email-server": {
"autoApprove": [],
"disabled": false,
"timeout": 60,
"command": "node",
"args": [
"path/to/mailer-mcp/dist/index.js"
],
"env": {
"SMTP_HOST": "smtp.example.com",
"SMTP_PORT": "587",
"SMTP_USER": "user@example.com",
"SMTP_PASSWORD": "password123",
"EMAIL_FROM": "sender@example.com"
},
"transportType": "stdio"
}
可用工具
send_email
向指定收件人发送电子邮件。 参数:
recipient(string, 必填):收件人电子邮件地址body(string, 必填):电子邮件正文内容
示例:
{
"recipient": "recipient@example.com",
"body": "你好,这是来自 MCP 服务器的测试邮件。"
}
test_email
发送测试邮件以验证配置。 参数: 无
开发
- 启动 TypeScript 编译器的看门狗模式:
npm run dev
- 对
src目录中的源文件进行更改。 - TypeScript 编译器会在检测到更改时自动重新编译文件。
Scan to contact