项目简介
Postmark MCP邮件服务是一个强大的后台应用,它将Postmark的邮件发送、模板管理和统计功能封装成LLM(大型语言模型)可调用的工具。通过遵循Model Context Protocol (MCP),它能安全、高效地响应LLM客户端的请求,实现自动化邮件交互,例如根据LLM指令自动发送欢迎邮件、处理用户查询等。
主要功能点
- 发送普通邮件: LLM可以直接指令发送普通文本或HTML格式的邮件,适用于发送通知、提醒等。
- 发送模板邮件: 利用Postmark预定义的邮件模板,结合动态数据(如用户名、订单号)发送个性化、品牌化的邮件。
- 列出邮件模板: 获取Postmark账户中所有可用的邮件模板列表,方便LLM选择和使用。
- 查询邮件统计: 查看指定日期范围或标签的邮件发送和投递统计数据,例如发送量、邮件打开率和链接点击率,帮助LLM分析邮件效果。
- 自动化配置: 所有通过此服务器发送的邮件都会自动启用打开追踪和链接点击追踪,并使用预设的默认邮件流,简化邮件配置。
- 健壮性与安全: 具备完善的错误处理、优雅关机机制和安全日志实践,确保系统稳定运行且不暴露敏感信息。
安装步骤
- 克隆仓库: 在您的开发环境中打开终端,并执行以下命令来下载项目代码:
git clone https://github.com/ActiveCampaign/postmark-mcp cd postmark-mcp - 安装依赖: 进入项目目录后,安装所需的Node.js模块:
npm install - 配置环境变量:
- 复制 '.env.example' 文件到 '.env' 文件,用于存放您的配置信息:
cp .env.example .env - 使用文本编辑器打开新创建的 '.env' 文件,并根据提示填入您的Postmark凭据和设置:
- 'POSTMARK_SERVER_TOKEN': 您的Postmark服务器API令牌 (必填)。
- 'DEFAULT_SENDER_EMAIL': 默认的发件人邮箱地址 (必填)。
- 'DEFAULT_MESSAGE_STREAM': Postmark消息流 (例如 'outbound',必填)。
- 复制 '.env.example' 文件到 '.env' 文件,用于存放您的配置信息:
- 启动服务器:
配置完成后,执行以下命令来启动Postmark MCP服务器:
服务器启动后,会显示日志信息,表明它已准备好连接MCP客户端。npm start
服务器配置 (供MCP客户端使用)
要将此Postmark MCP服务器与您的MCP客户端(例如Cursor、Claude等)集成,您需要向客户端提供以下配置信息,以便客户端能够正确启动和连接此服务器。请将以下内容添加到您的MCP客户端配置文件中,并根据您的实际路径和凭据进行调整:
{ "mcpServers": { "postmark": { // 这是您在客户端中为此MCP服务器定义的名称,可以自定义 "command": "node", // 启动服务器所使用的命令,这里是Node.js运行时 "args": [ "path/to/postmark-mcp/index.js" // 服务器的入口文件路径。请将 "path/to/postmark-mcp" 替换为您的仓库在本地的实际安装路径 ], "env": { "POSTMARK_SERVER_TOKEN": "您的Postmark服务器API令牌", // 您的Postmark账户API令牌,用于认证 "DEFAULT_SENDER_EMAIL": "您的默认发件人邮箱@example.com", // 邮件默认发件人地址 "DEFAULT_MESSAGE_STREAM": "outbound" // Postmark消息流,例如 'outbound' 或您自定义的流 } } } }
配置说明:
- 'mcpServers': 客户端中用于定义所有MCP服务器的顶级字段。
- 'postmark': 您为此Postmark MCP服务器指定的唯一标识符。
- 'command': 告诉客户端如何启动此服务器进程。在此例中,是使用 'node' 命令。
- 'args': 启动命令 'node' 所需的额外参数,即服务器的JavaScript文件路径。
- 'env': 服务器运行时需要访问的环境变量,用于存储敏感信息(如API令牌)和默认设置。请务必替换示例值。
基本使用方法 (LLM调用示例)
当您的MCP客户端连接并配置好此服务器后,您可以通过LLM发出自然语言请求来使用其功能。以下是一些示例:
- 发送普通邮件: “请使用Postmark向 '[email protected]' 发送一封主题为“会议提醒”的邮件,内容是“明天下午2点,别忘了我们的团队会议。””
- 发送模板邮件: “请使用Postmark的“welcome”模板向 '[email protected]' 发送欢迎邮件,用户名为 John Doe,产品名为 MyApp,登录链接为 'https://myapp.com/login'。”
- 列出模板: “请列出我们Postmark账户中所有可用的邮件模板。”
- 查询统计: “请显示2025年5月1日至2025年5月15日期间,标签为“marketing”的Postmark邮件投递统计数据。”
信息
分类
通信与社交