关于 using-email-templates
using-email-templates 是用于集成和测试 Mailtrap 托管邮件模板的技能,涵盖以 UUID 引用模板、Handlebars 变量、不同发送流,以及查阅最新 SDK 和 API 文档。
主要功能
- 01模板 UUID 与请求负载指引
- 02Handlebars 变量与语法
- 03事务性和批量发送流说明
- 04模板 UI 与 API 管理
- 05沙盒预览测试指引
适用场景
- 01使用 Mailtrap 模板发送邮件
- 02在 UI 中创建或编辑模板
- 03通过 Templates API 配置模板
- 04制作或测试 Handlebars 邮件内容
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ mailtrap/ mailtrap-skills --skill using-email-templates安装后在 Claude Code 中输入/using-email-templates确认已加载。
详细介绍
使用 Mailtrap 邮件模板
概述
在 Mailtrap 界面中编辑模板,在应用中通过 UUID 引用模板,并在发送时使用 Handlebars 数据填充模板。同一模板可用于事务型和**批量(促销)**邮件流;集成时选择邮件流。
**生成 SDK 代码前:**请阅读下方链接的相关 SDK 仓库 README,了解当前方法签名。不要依赖记忆。
**生成 API 请求体前:**请使用下方的官方文档和示例——请求结构应以 API 参考为准,不要凭空猜测(包括使用 AI 辅助编码时)。
通过 API 管理模板(在界面外创建/更新/列出模板):Templates API。
相关技能:authorizing-api-requests(令牌、环境变量、身份验证标头)、sending-emails(基础信息和邮件流)、testing-with-sandbox(预览发送,不实际投递)。
适用场景
- 使用托管在 Mailtrap 上的模板发送或测试邮件(在发送负载中使用 UUID)
- 在界面中创建或编辑模板
- 通过 Templates API 执行模板 CRUD 操作(自动化、配置)
- 在 API 请求体中使用
template_uuid和template_variables - Handlebars 条件语句、循环、HTML 转义与非转义
快速参考
API 操作
在开发者文档中打开:
- 事务型 – 发送邮件(包括使用模板)(
https://send.api.mailtrap.io) - 批量 – 发送邮件(包括使用模板)(
https://bulk.api.mailtrap.io)
在交互式参考中,请求体通常使用 EmailFromTemplate 变体。
身份验证
在对应的邮件流主机(send.api.mailtrap.io 或 bulk.api.mailtrap.io)上使用 Authorization: Bearer $MAILTRAP_API_TOKEN 进行发送。令牌范围、存储方式以及备用的 Api-Token 标头,请参阅技能 authorizing-api-requests。
示例(curl)— 使用模板发送
curl -X POST https://send.api.mailtrap.io/api/send \
-H "Authorization: Bearer $MAILTRAP_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"from": {"email": "[email protected]", "name": "Your App"},
"to": [{"email": "[email protected]"}],
"template_uuid": "your-uuid",
"template_variables": {"user_name": "Jane"}
}'
负载结构
将字面量 text/html 替换为模板字段,例如:
template_uuid(来自模板的集成选项卡)template_variables(键与 Handlebars 变量匹配的对象)
确切的必填字段(例如 from、to)遵循该邮件流非模板发送的相同规则。
Handlebars(支持的模式)
{{name}}— 转义输出;{{{html}}}— 原始 HTML{{#if}}/{{#unless}}、{{#each}}、{{#with}}- 嵌套路径,例如
{{order.id}} - 会抑制代码块的假值包括空字符串、
0、false、空集合(参见产品文档)
完整语法和示例:在邮件模板中使用 Handlebars。测试工作流:使用 Handlebars 测试模板。Sandbox 预览发送:发送测试邮件(sandbox)。
模板所在位置
应用侧边栏中的模板。每个模板的 集成选项卡下都有 UUID 和特定邮件流的集成代码片段。
生成模板 HTML
用户创建新模板时,应主动提出生成模板 HTML,不要等用户提出要求。输出必须是真正的邮件模板,而不是任意网页 HTML,并且必须兼容移动设备(具有响应式设计,能在各种邮件客户端和屏幕尺寸上良好呈现)。
SDK
常见错误
| 错误 | 修复 |
|---|---|
将 text/html 与 template_uuid 混用 | 使用符合 API 架构的模板字段发送模板 |
| 对高风险更改跳过沙盒 | 通过沙盒发送 / Testing API 预览(参见 testing-with-sandbox 和发送测试邮件) |