使用说明

项目简介

SMTP Email Manager 是一个基于 Model Context Protocol (MCP) 构建的邮件服务器,旨在为 Claude 等兼容 MCP 协议的 AI 助手提供邮件发送能力。通过此服务器,AI 助手可以安全、可控地发送邮件,并支持邮件模板和批量发送等高级功能。

主要功能点

  • 多 SMTP 服务器配置: 支持配置和管理多个 SMTP 服务器,方便用户根据不同场景选择合适的邮件发送服务。
  • 邮件模板: 允许创建、更新和使用可复用的邮件模板,提高邮件内容生成效率和一致性。
  • 批量邮件发送: 支持向多个收件人批量发送邮件,并具备批量大小和发送间隔控制,避免触发邮件服务商的限制。
  • HTML 邮件支持: 完全支持 HTML 格式的邮件内容,可以创建丰富的邮件视觉效果。
  • 邮件发送日志: 详细记录所有邮件发送活动,方便追踪和审计。
  • 模板变量: 邮件模板支持动态变量,允许根据具体数据定制邮件内容。

安装步骤

  1. 克隆仓库:
    git clone https://github.com/samihalawa/mcp-server-smtp.git
    cd mcp-server-smtp
  2. 安装依赖:
    npm install
  3. 构建项目:
    npm run build

服务器配置

要将此 MCP 服务器集成到 MCP 客户端,您需要在客户端的配置文件中添加服务器配置信息。以下是一个示例配置,请根据您的实际环境进行调整:

{
  "servers": {
    "smtp-email-server": {
      "command": "/path/to/node",
      "args": ["/path/to/mcp-server-smtp/build/index.js"],
      "enabled": true,
      "port": 3007,
      "environment": {
        "NODE_PATH": "/path/to/node_modules",
        "PATH": "/usr/local/bin:/usr/bin:/bin"
      }
    }
  }
}

配置参数说明

  • 'server name': 'smtp-email-server' - 服务器名称,在 MCP 客户端配置中用于唯一标识此邮件服务器。
  • 'command': '/path/to/node' - Node.js 解释器的绝对路径。请将 '/path/to/node' 替换为您系统中 Node.js 可执行文件的实际路径。例如,在某些系统中可能是 '/usr/bin/node' 或 '/usr/local/bin/node'。
  • 'args': '["/path/to/mcp-server-smtp/build/index.js"]' - 启动服务器的参数,指向编译后的 'index.js' 文件。请将 '/path/to/mcp-server-smtp/build/index.js' 替换为 'mcp-server-smtp' 仓库 'build/index.js' 文件的绝对路径。
  • 'enabled': 'true' - 设置为 'true' 以启用此服务器。
  • 'port': '3007' - 服务器监听的端口号。虽然当前配置中包含 'port' 字段,但根据仓库信息,此服务器使用 Stdio 传输协议,可能不直接使用端口进行网络通信。此端口配置可能为未来扩展或其他传输协议预留。
  • 'environment': 环境变量配置。
    • 'NODE_PATH': 指定 Node.js 模块的搜索路径。'/path/to/node_modules' 应替换为 'node_modules' 文件夹的绝对路径,如果您的 'node_modules' 目录不在标准位置,则需要配置此项。
    • 'PATH': 系统环境变量路径,用于确保服务器进程可以找到必要的系统命令。'/usr/local/bin:/usr/bin:/bin' 是一个常见的 Linux/macOS 路径配置,请根据您的操作系统环境进行调整。

请注意: MCP 客户端需要根据以上配置信息,正确启动和连接到此 SMTP Email Manager 服务器,才能使用其提供的邮件发送功能。请务必根据您的实际环境替换 'command' 和 'args' 中的路径。

基本使用方法

  1. 启动服务器: 在 'mcp-server-smtp' 仓库目录下,运行命令 'npm start' 启动 SMTP Email MCP 服务器。服务器将开始监听 MCP 客户端的请求。
  2. 配置 SMTP 服务器: 使用客户端调用 'add-smtp-config' 工具添加和配置 SMTP 服务器连接信息,例如 Gmail, AWS SES 等。您可以配置多个 SMTP 服务器,并设置默认服务器。
  3. 创建邮件模板 (可选): 使用 'add-email-template' 工具创建邮件模板,定义邮件主题和正文的模板,支持使用变量。
  4. 发送邮件: 使用 'send-email' 工具发送单封邮件,或使用 'send-bulk-emails' 工具批量发送邮件。在调用发送邮件工具时,可以指定收件人、邮件主题、正文内容,也可以指定使用的 SMTP 服务器配置和邮件模板 ID。
  5. 查看邮件发送日志: 使用 'get-email-logs' 工具查看邮件发送日志,了解邮件发送状态和历史记录。

详细的工具参数和使用示例请参考仓库 README.md 文件。

信息

分类

通信与社交