差替えキーワード
目次
機能概要
メールの件名や本文に差替えキーワードを設定することで宛先レコードの情報を挿入することができます。
差替えキーワードが使用出来る機能
使用方法
メール本文作成時に以下のような記述をすることで、指定したフィールドの値を動的に表示させることができます。
{{@DB識別名.フィールド識別名}}
指定できるDBは宛先に指定したDBのみになります。また、フィールドタイプによっては利用できません。(後述)
サンキューメールでの例
設定例
{{@customermst.name}}様
ご登録ありがとうございます。
以下の内容にて登録を受け付けました。
登録情報
=============================================
会社名 :{{@customermst.companyname}}
お名前 :{{@customermst.name}}
メールアドレス:{{@customermst.email
実際に配信されるメール文章
スパイラル太郎様
ご登録ありがとうございます。
以下の内容にて登録を受け付けました。
登録情報
=============================================
会社名 :スパイラル株式会社
お名前 :スパイラル太郎
メールアドレス:spiral@example.com
フォーマット
差し替える対象のフィールドタイプによっては、フォーマットを指定できるものがあります。
フォーマットを指定する場合は、指定のフィールドの後ろに |
区切りでフォーマットを指定します。
フォーマットはデフォルトがそれぞれ決まっており、省略することも可能です。詳細は下記フィールドタイプ別対応表をご覧ください。
{{DB名.フィールド名|フォーマット}}
例:日時型フィールドの日付の表示フォーマットを指定する
記述例1:フォーマットにyear、month、day、hour、minute、second、timeZoneを指定
{{@mailmagazine.datetime|year}}年{{@mailmagazine.datetime|month}}月{{@mailmagazine.datetime|day}}日 {{@mailmagazine.datetime|hour}}時{{@mailmagazine.datetime|minute}}分{{@mailmagazine.datetime|second}}秒{{@mailmagazine.datetime|timeZone}} → 2021年12月31日 12時45分30秒+9:00
記述例2:フォーマットにyear、month、dayを指定
{{@mailmagazine.datetime|year}}/{{@mailmagazine.datetime|month}}/{{@mailmagazine.datetime|day}} → 2021/12/31
例:日付型フィールドの日付の表示フォーマットを指定する。
記述例1:フォーマットにdateを指定
{{@member.submitdate|date}} → 2017-01-31
記述例2:フォーマットにyearを指定
{{@member.submitdate|year}} → 2017
記述例3:フォーマット未指定
{{@member.submitdate}} → 2017-01-31T09:15:30Z
※月日時刻が1桁の場合は0が付与されます。1月 → 01
例:英語フォームで表示する英語のセレクト選択肢をサンキューメール内で英語ラベルに差替える
DB>セレクトフィールドのラベル
ラベル1:りんご
ラベル2:みかん
ラベル3:もも
フォーム>セレクトフィールドのフィールド設定内のラベル指定
ラベル1:Apple
ラベル2:Orange
ラベル3:Peaches
{{@inquiry.favoratefruite|form}} → Apple
(※フォームで選択されたラベルが表示されます)
例:レコード番号(ID)を表示させる
{{@member._id}} → 10
※レコード番号(ID)の数字が表示されます)
フィールドタイプ別対応表
※特段記載がないものはAPIのレスポンス値と同じフォーマットとなります。
フィールドタイプ | フィールドタイプ(API上) | 差替え可否 | 指定可能なフォーマット | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
レコード番号 | _id | ◯ | - | ||||||||||||||||||||||
操作元ID | _operationSource | × | - | ||||||||||||||||||||||
作成者 | _createdBy | × | - | ||||||||||||||||||||||
作成日時 | _createdAt | ◯ |
|
||||||||||||||||||||||
最終更新者 | _updatedBy | × | - | ||||||||||||||||||||||
最終更新日時 | _updatedAt | ◯ |
|
||||||||||||||||||||||
テキスト | text | ◯ | - | ||||||||||||||||||||||
テキストエリア | textarea | 〇 | - | ||||||||||||||||||||||
メールアドレス | ◯ | - | |||||||||||||||||||||||
電話番号 | phone | ◯ |
|
||||||||||||||||||||||
整数 | integer | ◯ | - | ||||||||||||||||||||||
数値 | double | ◯ | - | ||||||||||||||||||||||
日付 | date | ◯ |
|
||||||||||||||||||||||
月日 | monthDay | ◯ |
|
||||||||||||||||||||||
時刻 | time | ◯ |
|
||||||||||||||||||||||
日時 | dateTime | ◯ |
|
||||||||||||||||||||||
時間 | interval | ◯ | - | ||||||||||||||||||||||
セレクト | select | ◯ |
|
||||||||||||||||||||||
マルチセレクト | multiselect | ◯ |
|
注意事項
配信設定時と配信時、差替えキーワードに対して、以下の確認が行われます。
設定不備に伴う設定エラーまたは配信失敗
存在しないDBやフィールド、あるいは引数等の不正な変数が文面中に含まれているなどの設定に不備がある場合、配信設定時に設定エラーとなります。
また、配信設定時には不備がなかったが、配信時刻までの間にDBやフィールドが削除されるなど、配信時は問題がある状態になった場合は、配信時のジョブステータスが failed(配信失敗)
になり、配信されません。
サイズ制限
差し替えた後のサイズ制限は差替え前の上限と同等です。(件名128byte、本文のコンテンツ1MB)
差し替え前の上限のバリデーションは設定時にチェックしエラーとなりますが、差し替え後のコンテンツが上限を超えていた場合は、配信エラーとなります。