JinDaGe - email-mcp-server MCP Details

article

README

🚀 电子邮件 MCP 服务器

本项目是一个运用 IMAP 和 SMTP 协议的电子邮件集成模型上下文协议（MCP）服务器。借助该服务器，模型助手能够访问并与电子邮件账户进行交互，为邮件管理提供便利。

🚀 快速开始

本服务器使用 IMAP 和 SMTP 协议，允许模型助手访问和交互电子邮件账户。以下是快速启动服务器的步骤：

克隆仓库：
```
git clone <repository-url>
cd imap-mcp
```
安装依赖项：
```
npm install
```

在根目录中创建一个 .env 文件，包含以下变量：

EMAIL_USER=your-email@example.com
EMAIL_PASSWORD=your-password
IMAP_HOST=imap.example.com
IMAP_PORT=993
SMTP_HOST=smtp.example.com
SMTP_PORT=465

运行服务器：
- 开发模式：
```
npm run dev
```
  此模式下，服务器会监视更改、重新编译 TypeScript 并自动重启。
- 生产模式：
```
npm run build
npm start
```

✨ 主要特性

📖 从 IMAP 邮箱读取电子邮件
📤 通过 SMTP 发送电子邮件
🔍 搜索电子邮件
📋 列出电子邮件文件夹

📦 安装指南

先决条件

Node.js（v16 或更高版本）
npm 或 yarn
带有 IMAP 和 SMTP 访问权限的电子邮件账户

安装步骤

克隆仓库至本地：
```
git clone <repository-url>
cd imap-mcp
```
使用以下命令安装所需依赖：
```
npm install
```

在项目根目录创建 .env 文件，并按如下格式配置环境变量：

EMAIL_USER=your-email@example.com
EMAIL_PASSWORD=your-password
IMAP_HOST=imap.example.com
IMAP_PORT=993
SMTP_HOST=smtp.example.com
SMTP_PORT=465

💻 使用示例

开发模式

在开发过程中，可使用以下命令以开发模式运行服务器：

npm run dev

此命令会开启监视功能，当代码发生更改时，会自动重新编译 TypeScript 并重启服务器，方便开发调试。

生产模式

在生产环境中，需先构建项目，再启动服务器，命令如下：

npm run build
npm start

📚 详细文档

API 说明

该服务器暴露了以下 MCP 资源和工具：

MCP 资源

mailto:<email-address>/inbox - 获取收件箱中 10 封最近的电子邮件列表。
mailto:<email-address>/folders - 列出所有可用的电子邮件文件夹/邮箱。

MCP 工具

send_email - 用于发送电子邮件消息。
search_emails - 可使用高级查询选项搜索电子邮件。
list_folders - 列出所有可用的电子邮件文件夹/邮箱。

📄 许可证

本项目采用 ISC 许可证，有关详细信息，请参阅 LICENSE。

email-mcp-server