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

Vantage から送信される既定のメール本文には、ABBYY カスタマーサポートのメールアドレス、ABBYY からの GDPR に関する通知、ABBYY の著作権表記を含むフッターなど、ABBYY 固有の情報が含まれます。これらのメール用テンプレートをカスタマイズして、自社の情報を組み込み、自社専用の内容にすることができます。

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

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

Email Template	ID	Culture	Subject Template Parameters	Body Template Parameters
新しく作成されたテナントのテナント管理者に送信される招待メール	`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 Mail Service へのアクセス

Mail Service にアクセスするには、次の手順を実行します。

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

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

既存のメールテンプレートのマークアップを取得するには、次のようにテンプレートリソース（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"
}

レスポンスには添付ファイルは含まれず、メールテンプレート側で設定されます。これらの添付ファイルはテンプレート内で指定しておく必要があり、テンプレートを更新する際に変更することもできます。

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

メールテンプレートを置き換えるには、PUT リクエストを templates リソースに送信します。

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	説明
`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 形式でエンコードされた添付ファイル

subject および body のテンプレート Parameter は変更せず、そのままにしておく必要があります。追加、削除、変更は行わないでください。

変更する予定がない場合でも、常にすべての添付ファイルを含めてください。リクエストはメールテンプレートを完全に置き換えます。

デフォルトの添付ファイル

すべての Vantage メールテンプレートには、次の 4 つの画像ファイルがデフォルトで添付されています。

CID	MIME Type	画像
`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"))

Documentation Index

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

​メールテンプレートの編集

​Vantage Mail Service へのアクセス

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

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

​テンプレート要素

​デフォルトの添付ファイル

​リクエスト例

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

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

メールテンプレートの編集

Vantage Mail Service へのアクセス

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

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

テンプレート要素

デフォルトの添付ファイル

リクエスト例

ファイルを Base64 に変換する