5.6 KiB
5.6 KiB
mail +template-create
前置条件: 先阅读
../../lark-shared/SKILL.md了解认证、全局参数和安全规则。
创建一个新的个人邮件模板。适用于需要长期复用的邮件框架,例如周报、客户通知、请假申请等。
不要用此命令发送邮件;模板只是预置内容,实际发信请使用 +send / +draft-create 等 shortcut 配合 --template-id 套用。
如需修改已有模板,使用 lark-cli mail +template-update。
安全约束
- 模板正文也会被当作邮件内容对外发送——所有邮件域的通用安全规则(prompt injection、XSS、敏感信息)同样适用。
- 不要把模板内容以文本形式输出给用户请求最终确认。命令返回
template_id后,引导用户在飞书邮箱 UI 里打开模板核对。 - 用户模板上限 20 个,单模板
template_content上限 3 MB;超限会被后端拒绝。
命令
# 纯 HTML 模板
lark-cli mail +template-create --as user \
--name '周报模板' \
--subject '本周进展' \
--template-content '<p>大家好,请见本周进展:</p><ul><li>……</li></ul>'
# 带 HTML 内嵌图片 + 非 inline 附件
lark-cli mail +template-create --as user \
--name '客户通知模板' \
--subject '产品更新' \
--template-content '<p>新版本上线:</p><img src="./banner.png"><p>附上发版说明。</p>' \
--attach './release-notes.pdf'
# 从文件加载正文
lark-cli mail +template-create --as user \
--name '请假申请' \
--template-content-file './leave.html' \
--to 'manager@example.com,hr@example.com'
# Dry Run
lark-cli mail +template-create --as user \
--name '周报模板' --template-content '<p>x</p>' --dry-run
参数
| 参数 | 必填 | 说明 |
|---|---|---|
--name <text> |
是 | 模板名称,≤100 字符 |
--subject <text> |
否 | 默认主题 |
--template-content <html> |
否* | 模板正文。HTML 首选;支持 <img src="./local.png" /> 相对路径自动上传到 Drive 并改写为 cid: |
--template-content-file <path> |
否* | 从文件加载正文内容;与 --template-content 互斥 |
--plain-text |
否 | 标记为纯文本模式(is_plain_text_mode=true)。仍可带内嵌图片,但 +send --template-id 套用时会走 plain-text 正文拼接 |
--to <emails> |
否 | 默认收件人列表,逗号分隔,支持 Name <email> 格式 |
--cc <emails> |
否 | 默认抄送 |
--bcc <emails> |
否 | 默认密送 |
--attach <paths> |
否 | 非 inline 附件路径,逗号分隔。每个文件按 --attach 书写顺序上传到 Drive |
--mailbox <email> |
否 | 所属邮箱,默认 me(当前用户主邮箱) |
--dry-run |
否 | 仅打印计划中的 API 调用链,不真实执行 |
* --template-content / --template-content-file 二选一;两者都留空则模板正文为空(用户之后可通过 +template-update 补充)。
HTML 内嵌图片自动上传
正文中所有不带 URI scheme 的 <img src="./local.png">(相对路径)会被:
- 上传到 Drive(≤20 MB 走
medias/upload_all;>20 MB 走upload_prepare + upload_part + upload_finish) - 生成 UUIDv4 CID
- HTML 改写为
<img src="cid:<uuid>"> - 在
attachments[]追加{id: <file_key>, cid, is_inline: true, filename, attachment_type}
带 URI scheme 的 <img src="https://..."> 或 <img src="cid:..."> 跳过上传。
SMALL vs LARGE 附件
附件分为 SMALL(attachment_type=1,内嵌到 EML)和 LARGE(attachment_type=2,由服务端渲染成下载链接)。切换阈值:
- 本地单文件大小:≤20 MB 用
upload_all,>20 MB 分块上传(与 SMALL/LARGE 无关,只影响 Drive 上传路径)。 - 累计 EML 投影:
subject + to + cc + bcc + template_content + base64 附件体积;同批次累计超过 25 MB 后,剩余的非 inline 附件标LARGE,inline 图片不能切换到 LARGE(HTMLcid:引用要求 MIME part 存在)。
两套判定相互独立。
顺序约束
- inline 图片按正文中
<img>出现顺序处理 - 非 inline 按
--attach书写顺序处理;重复路径不会去重
返回值
成功返回:
{
"template": {
"template_id": "712345",
"name": "周报模板",
"subject": "本周进展",
"template_content": "<p>...</p>",
"is_plain_text_mode": false,
"tos": [{"mail_address": "alice@example.com"}],
"attachments": [...],
"create_time": "1714000000000"
}
}
template_id为十进制字符串。后续套用模板时--template-id <template_id>。
错误码速查
| errno | HTTP | 触发 |
|---|---|---|
15080201 InvalidTemplateName |
400 | name 为空或超 100 字符 |
15080202 TemplateNumberLimit |
400 | 已达 20 模板上限 |
15080203 TemplateContentSizeLimit |
400 | 单模板 > 3 MB |
15080206 TemplateTotalSizeLimit |
400 | 所有模板总大小 > 50 MB |
15080207 InvalidTemplateParam |
400 | 其他参数错误 |
所需 scope
mail:user_mailbox.message:modify
相关
- 更新模板:
+template-update - 套用模板发信:在
+send/+draft-create/+reply/+reply-all/+forward中使用--template-id - 原生 API:
lark-cli mail user_mailbox.templates list --params '{"user_mailbox_id":"me"}'— 列出模板lark-cli mail user_mailbox.templates get --params '{"user_mailbox_id":"me","template_id":"<id>"}'— 获取完整模板lark-cli mail user_mailbox.templates delete --params '{"user_mailbox_id":"me","template_id":"<id>"}'— 删除