Inxmail Mcp

inxmail-mcp

用于 Inxmail Commerce Transactional API 的 MCP 服务。直接通过 Claude 管理事件、发送记录、退信、阻止列表、黑名单、互动和投递跟踪。

快速开始

1. 安装

npm install -g inxmail-mcp
# or use npx (no install needed)

2. 获取 API 凭据

在 Inxmail Commerce 管理面板中，于 API Login Data 下创建 API 密钥。你将获得：

• API Key ID（用户名）
• API Secret（密码）

实例名称是 Inxmail Commerce API URL 中的子域名：

• https://your-instance.api.inxmail-commerce.com/ -> 实例 = your-instance

3. 为 Claude Code 配置

claude mcp add inxmail-mcp -e INXMAIL_INSTANCE=your-instance -e INXMAIL_API_KEY_ID=your-key-id -e INXMAIL_API_SECRET=your-secret -- npx -y inxmail-mcp

也可以从源代码运行：

claude mcp add inxmail-mcp -e INXMAIL_INSTANCE=your-instance -e INXMAIL_API_KEY_ID=your-key-id -e INXMAIL_API_SECRET=your-secret -- node /path/to/inxmail-mcp/build/index.js

4. 为 Claude Desktop 配置

添加到 claude_desktop_config.json：

{
  "mcpServers": {
    "inxmail": {
      "command": "npx",
      "args": ["-y", "inxmail-mcp"],
      "env": {
        "INXMAIL_INSTANCE": "your-instance",
        "INXMAIL_API_KEY_ID": "your-key-id",
        "INXMAIL_API_SECRET": "your-secret"
      }
    }
  }
}

可用工具

核心用例

工具	描述
check_email_delivery	检查电子邮件的投递状态 — 发送记录、退信、互动和阻止状态
check_email_blocked	检查电子邮件是否被阻止（阻止列表中的硬退信 + 黑名单中的显式阻止）
get_server_info	获取 API 入口点及所有可用资源的链接

事件

工具	描述
trigger_event	触发事务性电子邮件事件
get_event_state	根据事务 ID 获取已触发事件的状态/结果
list_event_types	列出所有已配置的事件类型
get_event_type	根据 ID 获取单个事件类型

发送记录

工具	描述
list_sendings	根据筛选条件列出已发送的事务性电子邮件
get_sending	根据 ID 获取特定发送记录的详情

互动与跟踪

工具	描述
list_reactions	列出收件人的互动（打开和点击）
list_deliveries	列出投递状态信息

退信与投诉

工具	描述
list_bounces	列出退回的事务性电子邮件
list_complaints	列出反馈循环投诉

阻止列表（硬退信）

工具	描述
list_blocklist	列出因硬退信而被阻止的电子邮件地址
get_blocklist_entry	检查特定电子邮件是否在阻止列表中
remove_from_blocklist	从阻止列表中移除电子邮件

黑名单（显式阻止）

工具	描述
list_blacklist	列出被显式列入黑名单的电子邮件地址
get_blacklist_entry	检查特定电子邮件是否在黑名单中
add_to_blacklist	将电子邮件地址加入黑名单
remove_from_blacklist	从黑名单中移除电子邮件

邮件中继

工具	描述
list_relay_sendings	列出邮件中继发送记录
get_relay_sending	获取特定邮件中继发送记录的详情
list_relay_reactions	列出邮件中继互动（打开、点击）
list_relay_bounces	列出邮件中继退信
list_relay_complaints	列出邮件中继投诉

原始邮件

工具	描述
send_raw_mail	发送完整的 RFC 5322 邮件（Base64 编码）

错误日志

工具	描述
list_error_logs	列出错误日志条目
get_error_log	按 ID 获取单条错误日志条目
mark_error_log_read	将错误日志条目标记为已读

示例提示词

"Is [email protected] blocked or blacklisted?"

"Check the delivery status for [email protected]"

"List all bounces from last week"

"Trigger a welcome email event for [email protected]"

"Show me all event types configured in the system"

"List recent complaints from the last 30 days"

开发

git clone https://github.com/shahabazdev/inxmail-mcp.git
cd inxmail-mcp
npm install
npm run build

测试

npm test          # run all tests
npx vitest        # run in watch mode

使用 Vitest 运行单元测试，覆盖：

• API 客户端（身份验证、请求方法、查询参数、分页、错误处理）
• 工具注册（所有 29 个工具均已注册且无重复项）

环境变量

变量	必需	描述
INXMAIL_INSTANCE	是	实例子域名（例如 your-instance）
INXMAIL_API_KEY_ID	是	API 密钥 ID
INXMAIL_API_SECRET	是	API 密钥

许可证

MIT