{"_id":"mcp-email","name":"mcp-email","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"mcp-email","version":"1.0.0","description":"通用邮箱MCP服务器 - 支持QQ、163、Gmail（由于谷歌政策不支持OAuth2.0，所以无法使用）、Outlook、企业邮箱等多种邮箱服务商的自动配置和邮件发送功能","main":"index.js","type":"module","bin":{"universal-email-mcp":"index.js"},"scripts":{"start":"node index.js","dev":"node --watch index.js","test":"node test-auto-config.js","test:all":"node test-auto-config.js","test:gmail":"node -e \"import('./test-auto-config.js').then(m => m.testGmailConfig().catch(console.error))\"","test:qq":"node -e \"import('./test-auto-config.js').then(m => m.testQQAutoConfig().catch(console.error))\"","test:163":"node -e \"import('./test-auto-config.js').then(m => m.testAutoConfig().catch(console.error))\"","publish-check":"node scripts/publish-check.js","prepublishOnly":"npm run publish-check"},"keywords":["mcp","model-context-protocol","email","smtp","imap","qq-mail","163-mail","gmail","outlook","enterprise-email","email-client","email-server","auto-config","nodejs","claude-desktop","universal-email"],"author":{"name":"Universal Email MCP Server Team"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/TimeCyber/email-mcp.git"},"bugs":{"url":"https://github.com/TimeCyber/email-mcp/issues"},"homepage":"https://github.com/TimeCyber/email-mcp#readme","engines":{"node":">=16.0.0"},"publishConfig":{"access":"public"},"dependencies":{"@modelcontextprotocol/sdk":"^0.6.0","axios":"^1.6.2","dotenv":"^16.3.1","imap":"^0.8.19","mailparser":"^3.7.3","nodemailer":"^6.9.7","poplib":"^0.1.7"},"devDependencies":{"@types/node":"^20.10.0","@types/nodemailer":"^6.4.14"},"_id":"mcp-email@1.0.0","gitHead":"43a39bd84670855472b4518d44758cd95f4014eb","_nodeVersion":"20.15.1","_npmVersion":"10.7.0","dist":{"integrity":"sha512-8lmvWTYCOWsWiUAEML2gWtG+jMNMOoxhpOQxHPuIKO4FSP+SPIZ9zi+p5ZqQhoWHCNeHSMYR+XwOzI3VcIx/vA==","shasum":"80353543908d64b9d7947679d5f625df9e524cbe","tarball":"https://registry.npmjs.org/mcp-email/-/mcp-email-1.0.0.tgz","fileCount":5,"unpackedSize":70607,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQD1r3/btka7EFMh96h3doVYAH/DyhpwxnHy34rDCQ80aAIhALp1uBxfUSU3EBdeLdq4LvQ1zVOWPDkI4ALoWJKqv0kE"}]},"_npmUser":{"name":"timecyber","email":"business@timecyber.com.cn"},"directories":{},"maintainers":[{"name":"timecyber","email":"business@timecyber.com.cn"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/mcp-email_1.0.0_1749455982395_0.37947986125573974"},"_hasShrinkwrap":false}},"time":{"created":"2025-06-09T07:59:42.326Z","1.0.0":"2025-06-09T07:59:42.583Z","modified":"2025-06-09T07:59:42.872Z"},"maintainers":[{"name":"timecyber","email":"business@timecyber.com.cn"}],"description":"通用邮箱MCP服务器 - 支持QQ、163、Gmail（由于谷歌政策不支持OAuth2.0，所以无法使用）、Outlook、企业邮箱等多种邮箱服务商的自动配置和邮件发送功能","homepage":"https://github.com/TimeCyber/email-mcp#readme","keywords":["mcp","model-context-protocol","email","smtp","imap","qq-mail","163-mail","gmail","outlook","enterprise-email","email-client","email-server","auto-config","nodejs","claude-desktop","universal-email"],"repository":{"type":"git","url":"git+https://github.com/TimeCyber/email-mcp.git"},"author":{"name":"Universal Email MCP Server Team"},"bugs":{"url":"https://github.com/TimeCyber/email-mcp/issues"},"license":"MIT","readme":"# 📧 通用邮箱 MCP Server\n\n[![npm version](https://badge.fury.io/js/mcp-email.svg)](https://badge.fury.io/js/mcp-email)\n[![npm downloads](https://img.shields.io/npm/dm/mcp-email.svg)](https://www.npmjs.com/package/mcp-email)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\n一个让AI轻松接管邮箱的通用MCP服务器，基于 Model Context Protocol (MCP) 构建，支持在 MCP-X、Claude Desktop 等 MCP 客户端中使用。\n\n**支持多种邮箱服务商自动配置**：QQ邮箱、163邮箱、Gmail、Outlook、腾讯企业邮箱、网易企业邮箱、阿里云邮箱、新浪邮箱、搜狐邮箱等。\n\n## 📦 快速安装\n\n```bash\n# npm 安装\nnpm install -g mcp-email\n\n# 使用 npx 运行（推荐）\nnpx mcp-email\n```\n\n## ✨ 功能特性\n\n- 📤 **邮件发送**: 支持发送HTML和纯文本邮件\n- 👥 **多收件人**: 支持多个收件人、抄送、密送\n- 📎 **附件支持**: 支持文件附件和Base64编码内容\n- 🔧 **动态配置**: 支持运行时配置邮箱服务器\n- 🔍 **连接测试**: 内置SMTP服务器连接测试\n- 🛡️ **安全认证**: 支持微信企业邮箱授权码认证\n- ⚡ **高性能**: 优化的连接超时和重试机制\n\n## 📚 详细配置指南\n\n项目提供了详细的配置指南，包含各大邮箱服务商的配置说明：\n\n📖 **[CONFIG_GUIDE.md](./CONFIG_GUIDE.md)** - 完整配置指南，包含：\n- 📧 163邮箱详细配置教程\n- 🏢 微信企业邮箱配置指南  \n- 🌐 QQ邮箱、Gmail等主流邮箱配置\n- 🛠️ 故障排除和常见问题解决\n\n## 📋 系统要求\n\n- Node.js 16.x 或更高版本\n- 邮箱账号\n- MCP 客户端 (如 Claude Desktop)\n\n## 🚀 快速开始\n\n### 方式一：直接使用npm包（推荐）\n\n#### 1. 安装npm包\n\n```bash\n# 全局安装\nnpm install -g mcp-email\n\n# 或本地安装\nnpm install mcp-email\n```\n\n#### 2. 在MCP客户端中配置\n\n**MCP-X 配置示例：**\n```json\n{\n  \"mcpServers\": {\n    \"universal-email\": {\n      \"command\": \"npx\",\n      \"args\": [\"mcp-email\"],\n      \"env\": {\n        \"EMAIL_USER\": \"your-email@domain.com\",\n        \"EMAIL_PASSWORD\": \"your-password-or-auth-code\",\n        \"EMAIL_TYPE\": \"auto\"\n      }\n    }\n  }\n}\n```\n\n### 方式二：从源码安装\n\n#### 1. 克隆项目\n\n```bash\ngit clone https://github.com/TimeCyber/email-mcp.git\ncd email-mcp\n```\n\n#### 2. 安装依赖\n\n```bash\nnpm install\n```\n\n#### 3. 配置 MCP 客户端（源码安装）\n\n**MCP-X 配置：**\n```json\n{\n  \"mcpServers\": {\n    \"universal-email\": {\n      \"command\": \"node\",\n      \"args\": [\"F:\\\\path\\\\to\\\\email-mcp\\\\index.js\"],\n      \"env\": {\n        \"EMAIL_USER\": \"your-email@domain.com\",\n        \"EMAIL_PASSWORD\": \"your-password-or-auth-code\",\n        \"EMAIL_TYPE\": \"auto\"\n      }\n    }\n  }\n}\n```\n\n**企业邮箱配置：**\n```json\n{\n  \"mcpServers\": {\n    \"enterprise-email\": {\n      \"command\": \"node\",\n      \"args\": [\"F:\\\\path\\\\to\\\\email-mcp\\\\index.js\"],\n      \"env\": {\n        \"EMAIL_USER\": \"user@company.com\",\n        \"EMAIL_PASSWORD\": \"your-enterprise-auth-code\",\n        \"EMAIL_TYPE\": \"exmail\"\n      }\n    }\n  }\n}\n```\n\n#### 4. 测试配置\n\n```bash\n# 测试邮件配置是否成功\nnode test-auto-config.js\n```\n\n## 📧 邮箱配置指南\n\n### 获取授权码\n不同邮箱的授权码获取方式：\n\n**腾讯企业邮箱：**\n1. 访问 [企业邮箱管理后台](https://exmail.qq.com/)\n2. 进入 **\"设置\"** → **\"账户\"** → **\"客户端专用密码\"**\n3. 生成 **客户端专用密码** (授权码)\n4. 进入 **\"设置\"** → **\"收发信设置\"** → **\"设置方法\"**\n5. 开启 **\"POP/IMAP/SMTP服务\"**\n\n**QQ邮箱：**\n1. 登录QQ邮箱，进入**\"设置\"** → **\"账户\"**\n2. 开启**\"POP3/IMAP/SMTP/Exchange/CardDAV/CalDAV服务\"**\n3. 生成授权码\n\n**163邮箱：**\n1. 登录163邮箱，进入**\"设置\"** → **\"POP3/SMTP/IMAP\"**\n2. 开启**\"POP3/SMTP/IMAP服务\"**\n3. 设置客户端授权密码\n\n💡 **关键提示**: \n- 企业邮箱必须设置 `EMAIL_TYPE` 字段！\n- 个人邮箱可以使用 `EMAIL_TYPE: \"auto\"` 自动识别\n\n📖 **[CONFIG_GUIDE.md](./CONFIG_GUIDE.md)** - 完整配置指南，包含所有邮箱类型详细说明\n\n## 🔧 MCP 工具说明\n\n### 1. `send_email` - 发送邮件\n\n发送邮件，支持多种格式和收件人。\n\n#### 参数\n- **`to`** (必需): 收件人邮箱地址数组\n- **`subject`** (必需): 邮件主题\n- **`text`** (必需): 纯文本邮件内容\n- **`cc`** (可选): 抄送邮箱地址数组\n- **`bcc`** (可选): 密送邮箱地址数组\n- **`html`** (可选): HTML格式邮件内容\n- **`attachments`** (可选): 附件数组\n\n#### 使用示例\n\n**基本邮件发送：**\n```json\n{\n  \"to\": [\"recipient@example.com\"],\n  \"subject\": \"测试邮件\",\n  \"text\": \"这是一封测试邮件\"\n}\n```\n\n**带抄送和HTML内容：**\n```json\n{\n  \"to\": [\"recipient1@example.com\", \"recipient2@example.com\"],\n  \"cc\": [\"manager@example.com\"],\n  \"subject\": \"项目报告\",\n  \"text\": \"请查看项目报告\",\n  \"html\": \"<h1>项目报告</h1><p>项目进展顺利。</p>\"\n}\n```\n\n**带附件的邮件：**\n```json\n{\n  \"to\": [\"recipient@example.com\"],\n  \"subject\": \"带附件的邮件\",\n  \"text\": \"请查看附件\",\n  \"attachments\": [\n    {\n      \"filename\": \"report.pdf\",\n      \"path\": \"C:\\\\path\\\\to\\\\report.pdf\"\n    },\n    {\n      \"filename\": \"data.txt\",\n      \"content\": \"SGVsbG8gV29ybGQ=\"\n    }\n  ]\n}\n```\n\n### 2. `get_recent_emails` - 获取最近邮件\n\n获取最近几天的邮件列表，自动选择最佳协议（IMAP/POP3）。\n\n#### 参数\n- **`limit`** (可选): 返回邮件数量限制，默认20\n- **`days`** (可选): 获取最近几天的邮件，默认3天\n\n#### 使用示例\n```json\n{\n  \"limit\": 10,\n  \"days\": 7\n}\n```\n\n### 3. `get_email_content` - 获取邮件内容\n\n获取指定邮件的详细内容。\n\n#### 参数\n- **`uid`** (必需): 邮件唯一标识符（从邮件列表中获取）\n\n#### 使用示例\n```json\n{\n  \"uid\": \"12345\"\n}\n```\n\n### 4. `setup_email_account` - 设置邮箱账号\n\n自动识别邮箱类型并配置服务器，支持8大邮箱服务商。\n\n#### 参数\n- **`email`** (必需): 邮箱地址\n- **`password`** (必需): 邮箱密码或授权码\n- **`provider`** (可选): 邮箱提供商（手动指定，用于企业邮箱）\n\n#### 支持的邮箱类型\n- `qq` - QQ邮箱\n- `163` - 网易邮箱\n- `gmail` - Gmail\n- `outlook` - Outlook/Hotmail\n- `exmail` - 腾讯企业邮箱\n- `netease-enterprise` - 网易企业邮箱\n- `aliyun` - 阿里云邮箱\n- `sina` - 新浪邮箱\n- `sohu` - 搜狐邮箱\n\n#### 使用示例\n\n**个人邮箱（自动识别）：**\n```json\n{\n  \"email\": \"user@qq.com\",\n  \"password\": \"your-auth-code\"\n}\n```\n\n**企业邮箱（手动指定）：**\n```json\n{\n  \"email\": \"user@company.com\",\n  \"password\": \"your-enterprise-auth-code\",\n  \"provider\": \"exmail\"\n}\n```\n\n### 5. `list_supported_providers` - 列出支持的邮箱\n\n查看所有支持的邮箱服务商及其配置信息。\n\n#### 参数\n无需参数\n\n#### 使用示例\n```json\n{}\n```\n\n### 6. `configure_email_server` - 手动配置服务器\n\n手动配置邮箱服务器设置（高级用户使用）。\n\n#### 参数\n- **`user`** (必需): 邮箱账号\n- **`password`** (必需): 邮箱密码或授权码\n- **`smtpHost`** (可选): SMTP服务器地址\n- **`smtpPort`** (可选): SMTP端口\n- **`smtpSecure`** (可选): 是否使用SSL\n- **`imapHost`** (可选): IMAP服务器地址\n- **`imapPort`** (可选): IMAP端口\n- **`imapSecure`** (可选): 是否使用SSL\n\n#### 使用示例\n```json\n{\n  \"user\": \"your-email@domain.com\",\n  \"password\": \"your-password\",\n  \"smtpHost\": \"smtp.domain.com\",\n  \"smtpPort\": 465,\n  \"smtpSecure\": true\n}\n```\n\n### 7. `test_email_connection` - 测试连接\n\n测试邮箱服务器连接状态。\n\n#### 参数\n- **`testType`** (可选): 测试类型\n  - `smtp` - 仅测试发送服务器\n  - `imap` - 仅测试接收服务器\n  - `both` - 测试全部（默认）\n\n#### 使用示例\n```json\n{\n  \"testType\": \"smtp\"\n}\n```\n\n## 📊 支持的邮箱服务商\n\n### 主流邮箱服务器配置\n\n| 邮箱类型 | SMTP服务器 | SMTP端口 | IMAP服务器 | IMAP端口 | 推荐协议 |\n|---------|------------|----------|------------|----------|----------|\n| QQ邮箱 | smtp.qq.com | 587 | imap.qq.com | 993 | IMAP |\n| 网易邮箱 | smtp.163.com | 465 | imap.163.com | 993 | POP3* |\n| Gmail* | smtp.gmail.com | 587 | imap.gmail.com | 993 | IMAP |\n| Outlook | smtp-mail.outlook.com | 587 | outlook.office365.com | 993 | IMAP |\n| 腾讯企业邮箱 | smtp.exmail.qq.com | 465 | imap.exmail.qq.com | 993 | IMAP |\n<!--- | 网易企业邮箱 | smtphz.qiye.163.com | 994 | imaphz.qiye.163.com | 993 | POP3* | --->\n| 阿里云邮箱 | smtp.mxhichina.com | 465 | imap.mxhichina.com | 993 | IMAP |\n\n***网易邮箱（163/126/yeah）自动使用POP3协议以避免\"Unsafe Login\"错误**\n\n***Gmail特殊说明**: 从2025年5月1日起，Google Workspace账号不再支持\"less secure apps\"，必须使用OAuth认证。个人Gmail需要使用应用专用密码。详见[配置指南](CONFIG_GUIDE.md#gmail-详细配置教程)。**\n\n### 🔧 自动配置特性\n\n- ✅ **智能识别**: 根据邮箱域名自动选择服务器配置\n- ✅ **协议优化**: 163邮箱自动使用POP3，其他使用IMAP\n- ✅ **企业邮箱**: 支持通过 `EMAIL_TYPE` 字段手动指定\n- ✅ **错误处理**: IMAP失败时自动尝试POP3协议\n\n## 🔍 故障排除\n\n### 常见错误和解决方案\n\n#### 1. `535 Error: authentication failed`\n**原因**: 认证失败\n**解决方案**:\n- 确认已在邮箱设置中开启SMTP/IMAP/POP3服务\n- 重新生成授权码或应用专用密码\n- 检查邮箱地址和授权码是否正确\n- 对于企业邮箱，确认管理员已允许第三方访问\n\n#### 2. `[IMAP] EXAMINE Unsafe Login` (网易邮箱常见)\n**原因**: 网易邮箱安全限制\n**解决方案**:\n- 系统会自动切换到POP3协议\n- 确认已在网易邮箱中开启POP3/SMTP服务\n- 使用最新生成的16位授权码\n\n#### 3. `ECONNREFUSED` 或连接超时\n**原因**: 网络连接问题\n**解决方案**:\n- 检查网络连接状态\n- 确认防火墙没有阻挡邮件端口 (25, 465, 587, 993, 995)\n- 尝试不同的网络环境或VPN\n\n#### 4. `EMAIL_TYPE` 相关错误\n**原因**: 企业邮箱域名和服务器不匹配\n**解决方案**:\n- 为企业邮箱设置正确的 `EMAIL_TYPE` 字段\n- 腾讯企业邮箱设置为 `\"exmail\"`\n- 网易企业邮箱设置为 `\"netease-enterprise\"`\n\n### 📋 诊断工具\n\n使用内置诊断命令：\n\n```bash\n# 测试邮箱配置\nnode test-auto-config.js\n\n# 测试EMAIL_TYPE功能\nnode test-email-type.js\n\n# 使用MCP工具测试连接\n# 在MCP客户端中调用 test_email_connection\n```\n\n### 🔧 调试技巧\n\n1. **查看详细日志**: 系统会自动输出配置和连接信息\n2. **使用测试工具**: 通过 `test_email_connection` 诊断问题\n3. **检查邮箱类型**: 使用 `list_supported_providers` 确认支持\n4. **逐步配置**: 先使用 `setup_email_account` 自动配置\n\n## 📁 项目结构\n\n```\n├── index.js                     # MCP Server主程序\n├── package.json                # 项目依赖配置\n├── README.md                   # 项目主文档\n├── CONFIG_GUIDE.md            # 详细配置指南\n├── .gitignore                 # Git忽略文件\n├── 📁 配置模板/\n│   ├── mcp-x_config_v2.json      # 通用配置模板\n│   └── mcp-x_config_multi.json   # 多账户配置\n├── 📁 测试工具/\n│   ├── test-auto-config.js       # 自动配置测试\n│   └── test-email-type.js        # EMAIL_TYPE功能测试\n└── LICENSE                     # 开源许可证\n```\n\n### 🔑 核心文件说明\n\n- **`index.js`** - 主要的MCP服务器程序，包含所有邮件功能\n- **`CONFIG_GUIDE.md`** - 详细的配置指南，包含各种邮箱配置说明\n- **`mcp-x_config_v2.json`** - 通用配置模板，支持EMAIL_TYPE字段\n- **`test-auto-config.js`** - 测试自动配置功能的脚本\n- **`test-email-type.js`** - 验证EMAIL_TYPE字段功能的测试脚本\n\n## 🔐 安全注意事项\n\n1. **保护授权码**: 不要将授权码提交到版本控制系统\n2. **使用环境变量**: 推荐使用环境变量存储敏感信息\n3. **定期更新**: 定期更新授权码和检查安全设置\n4. **权限控制**: 确保只有授权用户可以访问MCP服务器\n\n## 📞 技术支持\n\n### 📖 文档资源\n- 📋 **[CONFIG_GUIDE.md](./CONFIG_GUIDE.md)** - 完整配置指南\n- 🔧 **测试工具** - 使用 `test-auto-config.js` 和 `test-email-type.js`\n- 🛠️ **内置诊断** - 使用 `test_email_connection` 工具\n\n### 🌐 官方文档\n- [网易邮箱客户端设置](https://help.mail.163.com/faqDetail.do?code=d7a5dc8471cd0c0e8b4b8f4f8e49998b374173cfe9171305fa1ce630d7f67ac2a5feb28b66796d3b)\n- [腾讯企业邮箱配置](https://open.work.weixin.qq.com/help2/pc/19886?person_id=1)\n- [QQ邮箱帮助中心](https://kf.qq.com/product/tx_mail.html)\n- [Gmail设置指南](https://support.google.com/mail/answer/7126229)\n\n### 🤝 贡献指南\n欢迎提交 Issue 和 Pull Request 来改进这个项目！\n\n- 🐛 **报告Bug**: 请详细描述问题和复现步骤\n- 💡 **功能建议**: 欢迎提出新的邮箱支持需求\n- 📝 **文档改进**: 帮助完善使用文档\n\n### 📊 项目状态\n- ✅ **生产就绪**: 支持8大主流邮箱服务商\n- 🔄 **持续更新**: 根据用户反馈不断改进\n- 🛡️ **安全保障**: 支持SSL/TLS加密和授权码认证\n\n## 📄 许可证\n\nMIT License - 详见 [LICENSE](./LICENSE) 文件\n\n---\n\n## 🎉 快速测试\n\n配置完成后，可以在MCP客户端中测试功能：\n\n**发送测试邮件：**\n```\n请发送一封测试邮件到 test@example.com，主题为\"MCP测试邮件\"，内容为\"Hello from Universal Email MCP!\"\n```\n\n**获取邮件列表：**\n```\n请获取最近3天的邮件列表，限制10封邮件\n```\n\n**测试连接：**\n```\n请测试邮箱连接状态\n```\n\n如果一切配置正确，所有功能都应该正常工作！🚀 ","readmeFilename":"README.md","_rev":"1-b9b8cb8f9d7439f682c8dfaeee36b9cf"}