開発者向けサポート

メソッド - HTMLメール専用置換文字列判断(common/mail/should_html_convert_key/{name})

HTMLメール専用置換文字列判断

common/mail/should_html_convert_key/{name}

HTMLメール専用の置換文字列かを判断します。{name}の部分が判定したい置換文字列となります。

必要権限

system,privacy

引数

（なし）

返り値

boolean

HTMLメール専用の置換文字列の場合true
trueを設定した置換文字列はHTMLタグがエスケープされなくなります。

※注意
Appsで利用する置換文字列は標準と重複した場合に正しく動かなくなる可能性があるので、
必ず置換文字列の先頭にAppsコードを追加し、 [APPCD]_[任意の文字列] となるようにしてください。

また、Appsからメールを送信する際、bodyに記載する置換文字列と、本APIの{name}に記載する置換文字列には、
テンプレートに記載している置換文字列に _HTML をつける形で記載してください。
対して、テンプレートに記載している置換文字列そのものには_HTMLの記載はしないでください。

例えば、Appsコードが「TESTAPP」のAppsが、POST /mail_manager.json等でメールを送信する際、
置換文字列を「TESTAPP_TESTTAG」とする場合、設定する値はそれぞれ次のようになります。

・HTML用テンプレートの内容
	メール本文に記載される内容は#TESTAPP_TESTTAG＃となります。
 
・本APIの登録
	common/mail/should_html_convert_key/TESTAPP_TESTTAG_HTML
 	戻り値はtrue
 
・Appsからメール送信する際のbody
	{
		"TESTAPP_TESTTAG_HTML" : "<font color="red">置換したい文字列</font>"
	}

また、上記を送信した場合、送信されるメールの文章は次のような形に置換されます。

・送信される期待値
	メール本文に記載される内容は置換したい文字列となります。