使用说明

电子邮件mcp

MCP服务器 Inxmail商务交易API.直接从Claude管理事件、发送、反弹、阻止列表、黑名单、反应和交付跟踪。

快速开始

1.安装

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

2.获取API凭据

在您的Inxmail Commerce管理面板中，在下创建一个API键 API登录数据。您将获得：

API密钥ID （用户名）
API秘密 （密码）

您的实例名称是来自Inxmail Commerce API URL的子域：

https://your-instance.api.inxmail-commerce.com/ 例子 your-instance

3.配置Claude代码

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_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 test@example.com blocked or blacklisted?"

"Check the delivery status for user@example.com"

"List all bounces from last week"

"Trigger a welcome email event for new-user@example.com"

"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

使用运行单元测试维测试涵盖：

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

环境变量

变量	必填	描述
`INXMAIL_INSTANCE`	是	实例子域（例如。 `your-instance`)
`INXMAIL_API_KEY_ID`	是	API密钥ID
`INXMAIL_API_SECRET`	是	API机密

许可证

麻省理工学院