跳转到主要内容
Vantage 发送的默认电子邮件内容包含 ABBYY 专有信息,例如 ABBYY 客户支持邮箱、来自 ABBYY 的 GDPR 通知,以及带有 ABBYY 版权信息的页脚。您可以修改这些电子邮件模板,以加入您自己的信息,使其更契合贵公司。

可用的电子邮件模板

Vantage 提供以下电子邮件模板:
电子邮件模板说明ID区域设置主题模板参数正文模板参数
发送给新建租户的租户管理员的邀请电子邮件E6F03F64-B982-49C6-B336-251CA6C45FFEenproductNameuserName:接收电子邮件的用户名称,productName:产品名称,invitationUri:用于创建账户的邀请链接
发送给新建租户的邀请电子邮件6C5DBE28-0A2C-4EB7-82DC-04173DC75418enproductNameuserName:接收电子邮件的用户名称,productName:产品名称,invitationUri:用于创建账户的邀请链接
用户在 Vantage 登录页面请求的包含密码重置链接的电子邮件701B077A-20EA-42B8-A71E-AB3EA5996039enN/AdisplayName:注册时提供的可选显示用户名,callbackUrl:重置密码的链接,expireHours:链接在多少小时后失效
关于成功将技能导出到共享文件夹的电子邮件B5A03F64-B982-49C6-B336-251CA6C45FFEenN/AuserName:用户的电子邮件地址,skillName:正在导出的技能,folderPath:共享文件夹的路径
关于未能将技能导出到共享文件夹的电子邮件F3C4BD68-B9FF-439F-A719-5B4F62263C4EenN/AuserName:用户的电子邮件地址,skillName:正在导出的技能,errorMessage:错误消息内容

修改电子邮件模板

要修改电子邮件模板,请按以下步骤操作:
  1. 获取 Vantage 邮件服务的访问权限
  2. 获取电子邮件模板的详细信息
  3. 更新电子邮件模板

访问 Vantage 邮件服务

要访问邮件服务:
  1. 通过 http://localhost:8080 或其他端口访问 Mail 服务 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

获取电子邮件模板详细信息

要获取现有电子邮件模板的标记代码,请向模板资源(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"
    }
  ]
}

模板元素

字段类型描述
templateIdGUID要修改的电子邮件模板标识符
culturestring模板语言。目前仅支持英语(en)
subjectTemplatestring电子邮件主题文本模板。有关如何获取当前值的信息,请参见上一节
bodyTemplatestring电子邮件正文模板。有关如何获取当前值的信息,请参见上一节
attachments[].contentTypestring附件的 MIME 类型(例如,image/png
attachments[].contentIdstring附件的唯一标识符
attachments[].fileNamestring附件文件名,可在正文中用作 CID
attachments[].contentbase64string以 base64 格式编码的附件文件
主题和正文模板参数必须保持不变。请勿添加、删除或修改它们。
始终包含所有附件,即使您不打算修改它们。该请求会完全替换电子邮件模板。

默认附件

每个 Vantage 电子邮件模板都包含以下四个附件图片:
CIDMIME Type图片
logo-vantage-logo-normal.pngimage/pngABBYY Vantage 标志
600-px-copy-6.pngimage/png装饰性页眉图片
16-headset-16@2x.pngimage/png
16-global-outline-16@2x.pngimage/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": "16-headset-16@2x.png",
      "content": "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAMAAABEpIrGAAAA..."
    },
    {
      "contentType": "image/png",
      "contentId": "df64ab94-9c7f-49d1-93bf-f7ba48eb2a98",
      "fileName": "16-global-outline-16@2x.png",
      "content": "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAMAAABEpIrGAAAA..."
    }
  ]
}

将文件转换为 Base64

要获取文件的 Base64 字符串表示形式,请执行以下命令:
[Convert]::ToBase64String([IO.File]::ReadAllBytes("full path to file"))