Vantage 发送的默认电子邮件内容包含特定于 ABBYY 的信息,例如 ABBYY 客户支持邮箱、来自 ABBYY 的 GDPR 通知,以及带有 ABBYY 版权信息的页脚。您可以修改这些电子邮件的模板,以加入您自己的信息,使其更符合贵公司的需求。
Vantage 提供以下电子邮件模板:
| 电子邮件模板 | ID | 区域设置 | 主题模板参数 | 正文模板参数 |
|---|
| 发送给新建租户租户管理员的邀请电子邮件 | E6F03F64-B982-49C6-B336-251CA6C45FFE | en | productName | userName - 收件用户姓名,productName - 产品名称,invitationUri - 用于创建帐户的邀请链接 |
| 发送给新建租户的邀请电子邮件 | 6C5DBE28-0A2C-4EB7-82DC-04173DC75418 | en | productName | userName - 收件用户姓名,productName - 产品名称,invitationUri - 用于创建帐户的邀请链接 |
| 用户在 Vantage 登录页请求密码重置链接时发送的电子邮件 | 701B077A-20EA-42B8-A71E-AB3EA5996039 | en | N/A | displayName - 注册时提供的可选显示用户名,callbackUrl - 重置密码的链接,expireHours - 链接过期前的小时数 |
| 关于成功将 Skill 导出到共享文件夹的电子邮件 | B5A03F64-B982-49C6-B336-251CA6C45FFE | en | N/A | userName - 用户的电子邮件地址,skillName - 正在导出的 Skill 名称,folderPath - 共享文件夹的路径 |
| 关于未能将 Skill 导出到共享文件夹的电子邮件 | F3C4BD68-B9FF-439F-A719-5B4F62263C4E | en | N/A | userName - 用户的电子邮件地址,skillName - 正在导出的 Skill 名称,errorMessage - 错误消息正文 |
要修改电子邮件模板,请执行以下步骤:
- 获取 Vantage 邮件服务的访问权限
- 获取电子邮件模板详情
- 更新电子邮件模板
要访问邮件服务:
- 通过
http://localhost:8080 或其他端口获取 Mail service API 的访问权限:
kubectl -n abbyy-vantage port-forward $(kubectl get service -n abbyy-vantage --selector='app.kubernetes.io/name=mail' -o name) 8080:80
终端输出示例:
Forwarding from 127.0.0.1:8080 -> 8080
Forwarding from [::1]:8080 -> 8080
要获取现有电子邮件模板的标记内容,请按如下方式向 templates 资源(http://localhost:8080)发送 GET 请求:
GET http://localhost:8080/api/v1/templates/{templateId}
响应示例:
{
"localizedTemplates": {
"en": {
"subjectTemplate": "您的 {{productName}} 邀请",
"bodyTemplate": "<body>...</body>"
}
},
"id": "<templateId>",
"createTime": "2022-04-06T07:23:52.903261+00:00",
"updateTime": "2022-04-06T07:23:53.137142+00:00"
}
响应中不会包含附件,附件会被放置在电子邮件模板中。在更新模板时,必须在模板中指定这些附件,并且可以对其进行修改。
要替换电子邮件模板,请向 templates 资源发送 PUT 请求:
PUT http://localhost:8080/api/v1/templates/{templateId}
请求体:
{
"culture": "en",
"subjectTemplate": "subject template",
"bodyTemplate": "body template",
"attachments": [
{
"contentType": "attachment MIME",
"contentId": "guid",
"fileName": "image name used in body as cid",
"content": "file content in base64 string"
}
]
}
| 字段 | 类型 | 描述 |
|---|
templateId | GUID | 要修改的电子邮件模板的标识符 |
culture | string | 模板语言。目前仅支持英语 (en) |
subjectTemplate | string | 电子邮件主题文本模板。有关如何获取当前值的信息,请参见上一节 |
bodyTemplate | string | 电子邮件正文模板。有关如何获取当前值的信息,请参见上一节 |
attachments[].contentType | string | 附件的 MIME 类型(例如,image/png) |
attachments[].contentId | string | 附件的唯一标识符 |
attachments[].fileName | string | 附件文件名,可在正文中作为 CID 使用 |
attachments[].content | base64string | 以 base64 格式编码的附件文件 |
主题和正文模板参数必须保持不变。请不要添加、删除或修改它们。
请始终包含所有附件,即使您不打算修改它们。该请求会完全替换电子邮件模板。
每个 Vantage 电子邮件模板都包含这四个附件图像:
| CID | MIME Type | 图像 |
|---|
logo-vantage-logo-normal.png | image/png |  |
600-px-copy-6.png | image/png |  |
[email protected] | image/png | |
[email protected] | image/png | |
PUT http://localhost:8080/api/v1/templates/E6F03F64-B982-49C6-B336-251CA6C45FFE
{
"culture": "en",
"subjectTemplate": "Your {{productName}} account information",
"bodyTemplate": "<body><table ...>...<img ... src=\"cid:logo-vantage-logo-normal.png\" alt=\"ABBYY Vantage\" />...Dear {{userName}},...</body>",
"attachments": [
{
"contentType": "image/png",
"contentId": "4dcc3114-b7ff-48b5-902a-8fbd673d6acd",
"fileName": "logo-vantage-logo-normal.png",
"content": "iVBORw0KGgoAAAANSUhEUgAAALoAAAAcCAMAAADhlVUwAAAA..."
},
{
"contentType": "image/png",
"contentId": "e243efa2-55ed-4f07-a1e0-27d55460decc",
"fileName": "600-px-copy-6.png",
"content": "iVBORw0KGgoAAAANSUhEUgAAAlgAAACkCAMAAAB8d6ClAAAA..."
},
{
"contentType": "image/png",
"contentId": "d57f26bb-43b6-41a3-b356-3f53dfbd28d7",
"fileName": "[email protected]",
"content": "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAMAAABEpIrGAAAA..."
},
{
"contentType": "image/png",
"contentId": "df64ab94-9c7f-49d1-93bf-f7ba48eb2a98",
"fileName": "[email protected]",
"content": "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAMAAABEpIrGAAAA..."
}
]
}
若要获取文件的 Base64 字符串表示形式,请执行以下命令:
[Convert]::ToBase64String([IO.File]::ReadAllBytes("文件完整路径"))