跳轉到主要內容
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 — 連結到期前的有效小時數
關於成功將 skill 匯出到共用資料夾的電子郵件B5A03F64-B982-49C6-B336-251CA6C45FFEenN/AuserName — 使用者的電子郵件地址,skillName — 正在匯出的 skill,folderPath — 共用資料夾的路徑
關於未能將 skill 匯出到共用資料夾的電子郵件F3C4BD68-B9FF-439F-A719-5B4F62263C4EenN/AuserName — 使用者的電子郵件地址,skillName — 正在匯出的 skill,errorMessage — 錯誤訊息內容

修改電子郵件範本

若要修改電子郵件範本,請依照下列步驟操作:
  1. 取得 Vantage 郵件服務的存取權限
  2. 取得電子郵件範本詳細資料
  3. 更新電子郵件範本

取得 Vantage Mail Service 的存取權限

若要取得 Mail service 的存取權限:
  1. 透過 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"
    }
  ]
}

範本元素

欄位類型說明
templateIdGUID要修改的電子郵件範本識別碼
culturestring範本語言。目前僅支援英文 (en)
subjectTemplatestring電子郵件主旨文字範本。如需取得目前值的相關資訊,請參閱前一節
bodyTemplatestring電子郵件內文範本。如需取得目前值的相關資訊,請參閱前一節
attachments[].contentTypestring附件的 MIME 類型(例如,image/png
attachments[].contentIdstring附件的唯一識別碼
attachments[].fileNamestring附件檔案名稱,可在內文中作為 CID 使用
attachments[].contentbase64string以 base64 格式編碼的附件檔案
主旨與內文的範本參數必須保持不變。請勿新增、移除或修改它們。
請務必包含所有附件,即使你並不打算修改它們。此請求會完全取代整個電子郵件範本。

預設附件

每個 Vantage 電子郵件範本都預設包含下列四個圖片附件:
CIDMIME TypeImage
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"))