Lettr Transactional Email Api Mcp

Lettr MCP 服务

重要

此软件包不再更新。请改用 Lettr 托管的 MCP 服务： https://app.lettr.com/mcp

托管服务与 Lettr API 一同维护，因此新工具和修复都会发布到那里，而不是这里。此软件包仍可使用，但不会再添加任何新内容。

使用你登录的 Lettr 账号切换（OAuth）：

claude mcp add --transport http lettr https://app.lettr.com/mcp

然后在客户端提示时完成身份验证——无需管理 API 密钥。

使用 API 密钥切换，适用于 CI、定时任务以及其他无法使用浏览器的场景：

claude mcp add --transport http lettr https://app.lettr.com/mcp \
  --header "Authorization: Bearer lttr_xxxxxxxxx"

请参阅使用 API 密钥连接和远程服务设置指南，了解如何为 Cursor、Claude Desktop 和其他客户端进行设置。

切换前，有几点差异值得了解：那里的工具名称使用 snake_case（send_email，而不是 send-email），部分参数名称有所不同（使用 contact_id，而不是 contactId），并且托管服务还提供了此软件包从未支持过的工具，包括分析、电子邮件事件和 API 日志。

Lettr 的官方 Model Context Protocol（MCP）服务——面向开发者的电子邮件 API。可通过 Claude Desktop、Cursor 或 Claude Code 等 MCP 客户端，直接发送事务性电子邮件、管理带合并标签的模板、配置域名并监控 Webhook。

为什么选择 Lettr？

Lettr 是一个面向开发者的现代电子邮件发送平台。它提供简洁的 REST API、功能强大的拖放式模板编辑器、合并标签个性化功能、打开和点击跟踪，以及一流的送达率。无论是发送密码重置邮件、订单确认邮件，还是用户引导邮件序列，Lettr 都能让这一切变得简单可靠。

• API 参考 — 完整的 REST API 文档
• 模板 — 支持合并标签的可视化电子邮件编辑器
• 域名 — 域名验证和 DNS 设置
• Webhook — 实时事件通知
• 快速入门指南 — Node.js、PHP、Laravel、Python、Go、Rust 等

功能

• 发送邮件 — 发送事务性邮件，支持 HTML、纯文本、抄送/密送、附件、跟踪选项、元数据和标签。支持基于模板发送，可替换合并标签、安排发送时间，并检查已发送的邮件和事件。
• 模板 — 列出、创建、获取、更新和删除事务性或营销活动邮件模板。获取渲染后的 HTML 和合并标签，以便在发送前了解模板所需的变量。
• 域名 — 列出、创建、获取、删除和验证发送域名。查看 SPF、DKIM 和 DMARC 身份验证所需的 DNS 记录。
• Webhook — 列出、创建、获取、更新和删除Webhook 配置，以实时接收邮件事件通知。
• 项目 — 列出团队可用的项目，以便将模板和邮件工具用于特定项目。
• 受众 — 管理联系人、列表、订阅主题、自定义属性和细分。创建和更新联系人（支持双重确认订阅），将联系人添加到列表和主题，批量导入联系人，并根据匹配条件创建细分。
• 系统 — 提供运行状况检查和 API 密钥验证，用于客户端设置和诊断。

设置

1. 创建一个免费的 Lettr 账户
2. 在控制面板中创建 API 密钥
3. 验证你的域名，即可向任意收件人发送邮件

用法

Claude Code

claude mcp add lettr -e LETTR_API_KEY=lttr_xxxxxxxxx -- npx -y lettr-mcp

Cursor

打开命令面板，选择“Cursor Settings” > “MCP” > “Add new global MCP server”。

{
  "mcpServers": {
    "lettr": {
      "command": "npx",
      "args": ["-y", "lettr-mcp"],
      "env": {
        "LETTR_API_KEY": "lttr_xxxxxxxxx"
      }
    }
  }
}

Claude Desktop

打开 Claude Desktop 设置 > “Developer”选项卡 > “Edit Config”。

{
  "mcpServers": {
    "lettr": {
      "command": "npx",
      "args": ["-y", "lettr-mcp"],
      "env": {
        "LETTR_API_KEY": "lttr_xxxxxxxxx"
      }
    }
  }
}

选项

你可以传入其他参数来配置服务：

• --key：你的 Lettr API 密钥（可替代 LETTR_API_KEY 环境变量）
• --sender：来自已验证域名的默认发件人电子邮件地址
• --reply-to：默认回复地址

环境变量：

• LETTR_API_KEY：你的 Lettr API 密钥（必需）
• SENDER_EMAIL_ADDRESS：来自已验证域名的默认发件人电子邮件地址（可选）
• REPLY_TO_EMAIL_ADDRESS：默认回复地址（可选）

注意： 如果你未提供发件人电子邮件地址，MCP 服务会在每次发送邮件时向你询问。

可用工具

邮件

工具	描述
send-email	发送事务性邮件，支持 HTML、纯文本、模板、附件、跟踪和个性化
list-emails	列出最近发送的邮件（使用游标分页，可按收件人和日期筛选）
list-email-events	列出邮件事件（送达、退信、点击、打开等），可按类型、收件人、传输记录和日期范围筛选
get-email-detail	根据请求 ID 获取单次传输的完整送达时间线
schedule-email	安排在未来发送事务性邮件（至少提前 5 分钟，且不超过 30 天）
list-scheduled-emails	列出等待发送的邮件，可按状态筛选
get-scheduled-email	获取已安排邮件的状态和事件
cancel-scheduled-email	在邮件发送前取消已安排的邮件

模板

工具	描述
list-templates	列出电子邮件模板，可按用途和文件夹筛选
get-template	获取完整的模板详情，包括 HTML 内容
create-template	使用 HTML 或可视化编辑器 JSON 创建模板，可用于事务性邮件或营销活动
update-template	更新模板名称和／或内容（会创建新版本）
delete-template	永久删除模板及其所有版本
get-merge-tags	查找模板所需的合并标签变量
get-template-html	根据项目 ID 和 slug 获取模板渲染后的 HTML、主题和合并标签

模板用途。 模板用途分为 transactional（默认值——收据、密码重置、提醒）或 campaign（发送给受众列表的营销内容）。营销活动只能发送用途为 campaign 的模板，且创建后无法更改用途，因此，使用默认用途创建的新闻简报必须重新创建。如果邮件是发给受众而非个人，请在调用 create-template 时传入 purpose。

准备状态。 导入的模板会异步渲染，因此模板可能已存在，但尚不可发送。list-templates 和 get-template 会返回 pending、ready 或 failed。更新后，在新版本完成处理前，旧版渲染结果会继续提供服务，因此处于待处理状态的模板仍可发送，只是发送的还不是新内容。

文件夹

工具	描述
list-folders	列出模板所属的文件夹，包括用途和模板数量

只有通过此工具才能找到 folder_id。如果不使用此工具，可以省略 folder_id 并接受 API 选择的文件夹，或者猜测从应用 URL 中读出的整数。文件夹的用途与其中模板的用途相互独立——将模板归入营销活动文件夹，并不会使它成为营销活动模板。

域名

工具	描述
list-domains	列出所有发送域名及其验证状态
create-domain	注册新的发送域名
get-domain	获取包含 DNS 记录的域名详情
delete-domain	移除发送域名
verify-domain	触发域名的 DNS 验证

Webhook

工具	描述
list-webhooks	列出所有 Webhook 配置
get-webhook	获取 Webhook 详情和投递状态
create-webhook	创建新的 Webhook 订阅，并选择身份验证方式和事件类型
update-webhook	更新现有 Webhook（名称、URL、身份验证、事件、启用状态）
delete-webhook	删除 Webhook 订阅

项目

工具	描述
list-projects	列出团队拥有的项目——可用于查找项目 ID

受众

工具	描述
list-audience-lists	分页列出受众（联系人）列表
create-audience-list	创建新的受众列表
get-audience-list	获取单个列表及其联系人数量
update-audience-list	重命名受众列表
delete-audience-list	删除受众列表
bulk-delete-audience-lists	一次调用最多删除 50 个列表
list-audience-contacts	按搜索词、状态、列表和细分条件筛选联系人并列出
get-audience-contact	获取联系人的属性、所属列表和主题
create-audience-contact	创建联系人，可选择启用双重确认订阅
bulk-create-audience-contacts	批量创建联系人，支持使用纯邮箱列表或每个联系人一行的数据
update-audience-contact	更新联系人的邮箱、状态或属性
delete-audience-contact	删除联系人
attach-contact-to-list	将联系人添加到列表
detach-contact-from-list	从列表中移除联系人
subscribe-contact-to-topic	将联系人订阅到主题
unsubscribe-contact-from-topic	取消联系人的主题订阅
bulk-attach-contacts-to-lists	一次性将多个联系人添加到多个列表
bulk-detach-contacts-from-lists	一次性将多个联系人从多个列表中移除
bulk-subscribe-contacts-to-topics	一次性将多个联系人订阅到多个主题
bulk-unsubscribe-contacts-from-topics	一次性取消多个联系人的多个主题订阅
list-audience-topics	分页列出订阅主题
create-audience-topic	创建订阅主题
get-audience-topic	获取单个主题
update-audience-topic	更新主题的名称、描述或可见性
delete-audience-topic	删除订阅主题
list-audience-properties	列出自定义联系人属性
create-audience-property	定义新的自定义属性
get-audience-property	获取单个属性
update-audience-property	更新属性的回退值
delete-audience-property	删除自定义属性
list-audience-segments	列出细分，可选择按列表筛选
create-audience-segment	根据匹配条件创建细分
get-audience-segment	获取单个细分及其条件
update-audience-segment	更新细分的名称、列表或条件
delete-audience-segment	删除细分

系统

工具	描述
health-check	检查 Lettr API 的运行状况
auth-check	验证配置的 API 密钥并返回团队 ID

本地开发

1. 克隆并构建：

git clone https://github.com/nicholasgriffintn/lettr-mcp.git
cd lettr-mcp
pnpm install
pnpm run build

2. 在 MCP 客户端中使用本地构建：

{
  "mcpServers": {
    "lettr": {
      "command": "node",
      "args": ["ABSOLUTE_PATH_TO_PROJECT/dist/index.js"],
      "env": {
        "LETTR_API_KEY": "lttr_xxxxxxxxx"
      }
    }
  }
}

使用 MCP Inspector 进行测试

请先构建项目（参见上方的本地开发）。

1. 设置 API 密钥：

   export LETTR_API_KEY=lttr_your_key_here
   

2. 启动检查器：

   pnpm inspector
   

3. 在浏览器中（Inspector UI）：

   • 选择 stdio（启动一个进程）。
   • 命令： node
   • 参数： dist/index.js
   • 环境变量： LETTR_API_KEY=lttr_your_key_here
   • 点击 Connect，然后使用“List tools”验证服务是否正常运行。

资源

• Lettr 网站
• API 文档
• MCP 配置指南
• MCP 工具参考
• 模板语言
• DNS 配置指南
• 知识库

许可证

MIT