Package nablarch.common.mail
Class TemplateMailContext
java.lang.Object
nablarch.common.mail.MailContext
nablarch.common.mail.TemplateMailContext
定型メール送信要求を表すクラス。
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetLang()
言語を取得する。Deprecated.テンプレートIDを取得する。テンプレートとマージする変数を取得する。void
言語を設定する。void
setReplaceKeyValue
(String key, String value) Deprecated.当メソッドは5u13より前から存在する定型メール機能のためにある。 当メソッドの仕様を満たしつつより柔軟な機能をもつsetVariable(String, Object)
が追加されたので今後はそちらを使用すること。void
setTemplateId
(String templateId) テンプレートIDを設定する。void
setVariable
(String name, Object value) テンプレートとマージする変数を追加する。Methods inherited from class nablarch.common.mail.MailContext
addAttachedFile, addBcc, addCc, addTo, getAttachedFileList, getBccList, getCcList, getCharset, getFrom, getMailBody, getMailSendPatternId, getReplyTo, getReturnPath, getSubject, getToList, setCharset, setFrom, setMailBody, setMailSendPatternId, setReplyTo, setReturnPath, setSubject, validate
-
Constructor Details
-
TemplateMailContext
TemplateMailContext
のインスタンスを生成する。
-
-
Method Details
-
getTemplateId
テンプレートIDを取得する。- Returns:
- テンプレートID
-
setTemplateId
テンプレートIDを設定する。- Parameters:
templateId
- テンプレートID
-
getLang
言語を取得する。- Returns:
- 言語
-
setLang
言語を設定する。- Parameters:
lang
- 言語
-
getReplaceKeyValue
Deprecated.当メソッドは5u13より前から存在する定型メール機能のためにある。 当メソッドの仕様を満たしつつより柔軟な機能をもつgetVariables()
が追加されたので今後はそちらを使用すること。プレースホルダのキーと置換文字列のマップを取得する。- Returns:
- プレースホルダと置換文字列のマップ
-
getVariables
テンプレートとマージする変数を取得する。- Returns:
- テンプレートとマージする変数
-
setReplaceKeyValue
Deprecated.当メソッドは5u13より前から存在する定型メール機能のためにある。 当メソッドの仕様を満たしつつより柔軟な機能をもつsetVariable(String, Object)
が追加されたので今後はそちらを使用すること。メールテンプレート中のプレースホルダのキーと置換文字列を追加する。 プレースホルダは、指定したkey
をもとにvalue
で置換される。
プレースホルダの記述形式は、{キー名} と記載する。
プレースホルダがあるにも関わらず置換文字列が渡されない場合は、変換されずメールが送信される。
ただし、テンプレートエンジンを使用したメール送信処理ではプレースホルダがあるにも関わらず 置換文字列が渡されない場合の動作はテンプレートエンジンの仕様に準ずる。- Parameters:
key
- プレースホルダのキーvalue
- 置換文字列(null不可)
-
setVariable
テンプレートとマージする変数を追加する。- Parameters:
name
- 変数名value
- 値
-
getVariables()
が追加されたので今後はそちらを使用すること。