JinDaGe - getmailer-mcp MCP Details

article

README

🚀 GetMailer MCP 服务器

GetMailer MCP 服务器是一个基于 MCP（模型上下文协议）的服务器，专为 GetMailer 服务。它允许像 Claude 这样的 AI 助手发送事务性电子邮件，为用户提供了便捷的邮件发送解决方案。

🚀 快速开始

最快的启动方式是直接通过 MCP 进行注册：

1. 将 MCP 服务器添加到 Claude 桌面端（此时还不需要 API 密钥）

macOS：~/Library/Application Support/Claude/claude_desktop_config.json
Windows：%APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "getmailer": {
      "command": "npx",
      "args": ["getmailer-mcp"]
    }
  }
}

2. 让 Claude 为你注册

"使用电子邮件 user@example.com 和密码 MyPassword123 为我注册 GetMailer"

3. Claude 将返回你的 API 密钥。更新你的配置

{
  "mcpServers": {
    "getmailer": {
      "command": "npx",
      "args": ["getmailer-mcp"],
      "env": {
        "GETMAILER_API_KEY": "gm_your_api_key_here"
      }
    }
  }
}

4. 重启 Claude 桌面端，开始发送电子邮件！

📦 安装指南

npm install -g getmailer-mcp

🛠️ 已有用户使用 Claude 桌面端的设置方法

如果你已经有 API 密钥，将以下内容添加到你的 Claude 桌面端配置文件中：

macOS：~/Library/Application Support/Claude/claude_desktop_config.json
Windows：%APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "getmailer": {
      "command": "npx",
      "args": ["getmailer-mcp"],
      "env": {
        "GETMAILER_API_KEY": "gm_your_api_key_here"
      }
    }
  }
}

或者，如果你是全局安装的：

{
  "mcpServers": {
    "getmailer": {
      "command": "getmailer-mcp",
      "env": {
        "GETMAILER_API_KEY": "gm_your_api_key_here"
      }
    }
  }
}

✨ 主要特性

可用工具

signup

直接通过 Claude 创建一个新的 GetMailer 账户。返回一个 API 密钥并发送一封验证电子邮件。

重要提示：在你可以发送电子邮件之前，必须验证你的电子邮件。注册后请检查你的收件箱！
参数：
- email（必需）：你的电子邮件地址（不能使用一次性电子邮件）
- password（必需）：密码（至少 8 个字符，必须包含大写字母、小写字母和数字）
- name：你的姓名（可选）
示例：

使用我的电子邮件 developer@example.com 为我注册 GetMailer

account_status

检查你的账户状态，包括电子邮件验证、订阅计划和发送限制。

参数：无
返回值：
- 电子邮件验证状态
- 订阅计划和剩余电子邮件数量
- 已验证的域名数量
- 是否可以发送电子邮件
- 任何必需的操作（验证电子邮件、添加域名等）
示例：

检查我的 GetMailer 账户状态

send_email

发送一封事务性电子邮件。

参数：
- from（必需）：发件人电子邮件地址
- to（必需）：收件人地址数组
- subject（必需）：电子邮件主题
- html：HTML 内容
- text：纯文本内容
- cc：抄送收件人
- bcc：密送收件人
- replyTo：回复地址
- templateId：模板 ID（代替 html/text）
- variables：模板变量
示例：

从 hello@myapp.com 向 user@example.com 发送一封主题为 "Welcome!" 且 HTML 内容为 "<h1>Hello!</h1>" 的电子邮件

list_emails

列出已发送的电子邮件及其状态信息。

参数：
- limit：返回的电子邮件数量（默认值：20）
- cursor：分页游标

get_email

获取特定电子邮件的详细信息，包括投递事件。

参数：
- id（必需）：电子邮件 ID

list_templates

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

create_template

创建一个新的电子邮件模板。

参数：
- name（必需）：模板名称
- subject（必需）：主题行（可以包含 {{variables}}）
- html（必需）：HTML 内容（可以包含 {{variables}}）
- text：纯文本内容

list_domains

列出已验证的发送域名。

add_domain

添加一个新的发送域名。

参数：
- domain（必需）：域名（例如，example.com）
返回需要配置的 DNS 记录。

verify_domain

检查一个域名是否已验证。

参数：
- id（必需）：域名 ID

get_analytics

获取电子邮件分析和统计信息。

参数：
- type："summary" 或 "daily"
- days：每日统计的天数

list_suppression

列出被抑制的电子邮件地址。

参数：
- limit：返回的条目数量

add_to_suppression

将电子邮件地址添加到抑制列表中。

参数：
- emails（必需）：电子邮件地址数组
- reason：MANUAL、BOUNCE 或 COMPLAINT

create_batch

创建一个批量电子邮件作业。

参数：
- name（必需）：批量作业名称
- from（必需）：发件人地址
- recipients（必需）：{to, variables} 对象数组
- subject：电子邮件主题
- html：HTML 内容
- text：纯文本内容
- templateId：模板 ID
- replyTo：回复地址

list_batches

列出批量电子邮件作业。

get_batch

获取批量作业的状态和进度。

参数：
- id（必需）：批量作业 ID

💻 使用示例

配置完成后，你可以向 Claude 提出以下请求：

"从 notifications@myapp.com 向 user@example.com 发送一封电子邮件，告知他们的订单已发货"
"列出我最近的电子邮件"
"检查电子邮件 abc123 的状态"
"创建一个用于重置密码的电子邮件模板"
"显示我过去一周的电子邮件分析数据"
"将 user@spam.com 添加到我的抑制列表中"

🔧 技术细节

环境变量

GETMAILER_API_KEY：你的 GetMailer API 密钥（注册时可选，其他工具需要）
GETMAILER_API_URL：自定义 API URL（默认值：https://getmailer.app）

获取你的 API 密钥

选项 1：通过 MCP 注册（推荐）

直接从 Claude 使用 signup 工具，无需使用网页浏览器！

选项 2：通过网页注册

在 getmailer.app 上注册
转到 API 密钥页面
创建一个新的 API 密钥

📚 详细文档

文档：getmailer.app/docs
问题反馈：GitHub 问题

getmailer-mcp