メールテンプレート - ABBYY Documentation

Vantage が送信する既定のメール文面には、ABBYY のカスタマーサポート用メールアドレス、ABBYY からの GDPR 通知、ABBYY の著作権表示を含むフッターなど、ABBYY 固有の情報が含まれています。これらのメールテンプレートは変更できるため、自社の情報を追加して、自社向けの内容にすることができます。

利用可能なメールテンプレート

Vantage では、次のメールテンプレートを利用できます。

Email Template	ID	Culture	Subject テンプレートパラメーター	Body テンプレートパラメーター
新規作成されたテナントのテナント管理者に送信される招待メール	`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 メールサービスへのアクセス権を取得する
メールテンプレートの詳細を取得する
メールテンプレートを更新する

Vantage メールサービスへのアクセス

メールサービスにアクセスするには:

http://localhost:8080 または別のポート経由で、メールサービス 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": "Your invitation to {{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"
    }
  ]
}

テンプレート要素

Field	Type	Description
`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メールテンプレートには、以下の4つの画像が添付されています。

CID	MIME 型	画像
`logo-vantage-logo-normal.png`	image/png
`600-px-copy-6.png`	image/png
`16-headset-16@2x.png`	image/png
`16-global-outline-16@2x.png`	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": "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"))

​利用可能なメールテンプレート

​メールテンプレートを変更する

​Vantage メールサービス へのアクセス

​メールテンプレートの詳細を取得する

​メールテンプレートの更新

​テンプレート要素

​既定の添付ファイル

​リクエスト例

​ファイルをBase64に変換する

利用可能なメールテンプレート

メールテンプレートを変更する

Vantage メールサービスへのアクセス

メールテンプレートの詳細を取得する

メールテンプレートの更新

テンプレート要素

既定の添付ファイル

リクエスト例

ファイルをBase64に変換する