邮件API服务

一个将Veil Mail API操作作为AI代理工具的Model Context Protocol (MCP)服务器,支持发送邮件、管理模板、处理受众和分析数据。

  • by Resonia-Health
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 Resonia-Health/veilmail-mcp

使用说明

@共振/面纱mcp

A. 模型上下文协议(MCP) 公开Veil Mail API操作作为人工智能代理工具的服务器。这允许像Claude、ChatGPT、Cursor和其他MCP兼容客户端这样的人工智能助手发送电子邮件、管理模板、与受众合作,并通过自然语言检索分析。

Veil Mail是唯一一个拥有一流MCP服务器的电子邮件API。 Resend、SendGrid、Mailgun和Postmark不提供MCP集成——将它们连接到Claude或Cursor需要手工构建服务器。这艘船作为 npx @resonia/veilmail-mcp 只需一个配置条目,即可直接进入Claude Desktop或任何MCP客户端。涵盖电子邮件、域名、模板、受众、活动和分析的十种工具。

相关: 面纱邮件Node.js SDK · 完整的MCP文档 · AI助手集成指南

安装

npm install @resonia/veilmail-mcp

或者直接使用npx运行:

npx @resonia/veilmail-mcp

配置

服务器需要Veil Mail API密钥来验证请求。通过设置 VEILMAIL_API_KEY 环境变量。

变量 必填 默认 描述
VEILMAIL_API_KEY 是 - 您的Veil Mail API密钥(例如。, veil_live_xxxxx)
VEILMAIL_BASE_URL 没有 https://api.veilmail.xyz 自定义API基本URL(适用于自托管实例)

您可以从获取API密钥 面纱邮件仪表板.

使用Claude Desktop

将以下内容添加到您的 claude_desktop_config.json:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json 窗户: %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "veilmail": {
      "command": "npx",
      "args": ["@resonia/veilmail-mcp"],
      "env": {
        "VEILMAIL_API_KEY": "veil_live_xxxxx"
      }
    }
  }
}

更新配置后重新启动Claude Desktop。您应该在工具菜单中看到可用的面纱邮件工具。

与其他MCP客户端一起使用

任何兼容MCP的客户端都可以使用此服务器。将其作为通过stdio进行通信的子进程启动:

VEILMAIL_API_KEY=veil_live_xxxxx npx @resonia/veilmail-mcp

可用工具

send_邮件

通过Veil Mail发送电子邮件。支持HTML内容、模板、附件和日程安排。

参数 类型 必填 说明
from string 是 发件人电子邮件地址(必须来自已验证的域)
to string 是 收件人电子邮件地址
subject string 是 电子邮件主题行
html string 否 电子邮件的HTML内容
text string 否 纯文本回退内容
templateId string 否 要代替html/text使用的模板ID
templateData object 否 要填充模板变量的数据
cc string 否 抄送收件人电子邮件地址
bcc string 否 密件抄送收件人电子邮件地址
replyTo string 否 回复电子邮件地址
scheduledFor string 否 用于安排电子邮件的ISO 8601日期时间

get_email

通过ID获取已发送电子邮件的详细信息。

参数 类型 必填 说明
id string 是 电子邮件ID

list_邮件

使用可选过滤器列出已发送的电子邮件。

参数 类型 必填 说明
limit number 否 要返回的电子邮件数量(最多100封)
status string 否 按状态筛选:排队、已发送、已送达、已退回、失败

validate_email

验证电子邮件地址。检查语法、MX记录、可丢弃域和角色地址。

参数 类型 必填 说明
email string 是 要验证的电子邮件地址

list_templates

列出可用的电子邮件模板。

参数 类型 必填 说明
limit number 否 要返回的模板数

get_template

按ID获取特定的电子邮件模板。

参数 类型 必填 说明
id string 是 模板ID

list_domains

列出已验证的发送域。无需参数。

列表_观众

列出电子邮件受众/联系人列表。无需参数。

add_订阅者

向受众添加订阅者。

参数 类型 必填 说明
audienceId string 是 要将订阅者添加到的受众ID
email string 是 订阅者电子邮件地址
firstName string 否 订阅者名字
lastName string 否 订阅者姓氏

get_analytics

获取电子邮件分析概述,包括投递率、打开次数、点击次数和退回次数。

参数 类型 必填 说明
days number 否 回顾天数(默认值:30)

交互示例

配置后,您可以向AI助手询问以下问题:

  • “发送欢迎电子邮件至user@example.com从hello@mydomain.com"
  • “列出我的所有电子邮件模板”
  • “显示过去7天的电子邮件分析”
  • “验证电子邮件地址test@example.com"
  • “添加john@example.com致我的时事通讯读者”
  • “我最近的电子邮件的投递率是多少?”

安全考虑

  • 切勿在提示或对话历史记录中公开API密钥。 始终使用环境变量。
  • 使用测试模式键(veil_test_xxxxx)在开发过程中 避免发送真实的电子邮件。
  • 发送前检查电子邮件内容。 AI助手将使用 send_email 工具,因此请验证收件人地址和内容是否正确。
  • 适当地范围API键。 创建专门的API密钥供MCP使用,只需具有所需的权限。
  • 定期旋转按键。 如果您怀疑API密钥已被泄露,请立即在Veil Mail仪表板中旋转它。

发展

# Clone the repository
git clone https://github.com/resonia/veil-mail.git
cd veil-mail/packages/mcp-server

# Install dependencies
bun install

# Build
bun run build

# Run locally
VEILMAIL_API_KEY=veil_test_xxxxx node dist/index.js

# Type check
bun run typecheck

# Watch mode
bun run dev

许可证

麻省理工学院