SuperAPI AI 工具集

docyrus-email-template-design

设计与创作

查看项目

更新于 10-16 05:06

技能介绍

用途:设计可复用的 Docyrus 邮件模板,并校验其结构、用真实记录数据测试渲染与发送。模板本身不发送,由自动化 send-email 动作节点或其他发送路径消费。

主要能力:通过 docyrus studio create-email-template 创建模板(--name 与 --subject 必填,--body 为 HTML,可选 --dataSourceSlug/--dataSourceId 绑定数据源);用 list-email-templates、get-email-template、update-email-template、delete-email-template 管理。get 返回完整正文与 __body_html,list 仅返回元数据;update 为 PUT 但表现为部分更新;delete 为软删除(archived=true,204)。

使用方式:先确认应用与鉴权及源记录结构,例如 docyrus auth who --json、docyrus apps list --json、docyrus studio list-data-sources --appSlug crm --json、docyrus studio list-fields --appSlug crm --dataSourceSlug deals --json。设计主题与正文,确定合并字段、展开关系/枚举字段及条件/循环段。创建后读回校验,再通过发送路径测试。

占位符:Handlebars {{field}},基于发送时展开的记录,支持裸字段 {{slug}}、内置 {{name}}/{{autonumber_id}}、展开枚举/关系/用户对象 {{stage.name}},以及子数据源集合 {{#each child.{from}__{using}}}。不是 JSONata,也不是 ${}。

限制:name 与 subject 是唯一必填项;所有权始终为 CUSTOM,由服务端设置,不可作为标志传入也不在响应中返回;数据源绑定对邮件模板可选(打印/PDF 模板则必填);模板没有 from/to/cc/reply_to/fromName,发件人与收件人由发送路径设置;不要直接写 __body_html,它由服务端/UI 派生,get 时视为只读;未知 JSON 键会被静默忽略(白名单关闭),放入 from、html、to、type 等既不报错也不生效,需读回确认;占位符无匹配字段时渲染为空而非报错,因此必须用 list-fields 校验字段 slug;邮件模板没有独立渲染端点,只能通过发送路径测试;每次应校验后再测试,并删除临时模板。

适用场景:为 CRM 等应用创建如“成交通知”类可复用邮件模板,并接入自动化发送流程。详细模板上下文、编写模式、示例、校验清单与发送测试手册见 references/templating.md。