Email MCP Server

🚀 電子郵件 MCP 服務器

本項目是一個運用 IMAP 和 SMTP 協議的電子郵件集成模型上下文協議（MCP）服務器。藉助該服務器，模型助手能夠訪問並與電子郵件賬戶進行交互，為郵件管理提供便利。

🚀 快速開始

本服務器使用 IMAP 和 SMTP 協議，允許模型助手訪問和交互電子郵件賬戶。以下是快速啟動服務器的步驟：

1. 克隆倉庫：

   git clone <repository-url>
   cd imap-mcp
   

2. 安裝依賴項：

   npm install
   

3. 在根目錄中創建一個 .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
   

4. 運行服務器：
   • 開發模式：

     npm run dev
     

     此模式下，服務器會監視更改、重新編譯 TypeScript 並自動重啟。
   • 生產模式：

     npm run build
     npm start
     

✨ 主要特性

• 📖 從 IMAP 郵箱讀取電子郵件
• 📤 通過 SMTP 發送電子郵件
• 🔍 搜索電子郵件
• 📋 列出電子郵件文件夾

📦 安裝指南

先決條件

• Node.js（v16 或更高版本）
• npm 或 yarn
• 帶有 IMAP 和 SMTP 訪問權限的電子郵件賬戶

安裝步驟

1. 克隆倉庫至本地：

   git clone <repository-url>
   cd imap-mcp
   

2. 使用以下命令安裝所需依賴：

   npm install
   

3. 在項目根目錄創建 .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。