nablarch.common.mail

クラス TemplateMailContext

java.lang.Object

nablarch.common.mail.MailContext

nablarch.common.mail.TemplateMailContext

public class TemplateMailContext
extends MailContext

定型メール送信要求を表すクラス。

作成者:

Shinsuke Yoshio

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
TemplateMailContext() TemplateMailContextのインスタンスを生成する。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
String	getLang() 言語を取得する。
Map	getReplaceKeyValue() プレースホルダのキーと置換文字列のマップを取得する。
String	getTemplateId() テンプレートIDを取得する。
void	setLang(String lang) 言語を設定する。
void	setReplaceKeyValue(String key, String value) メールテンプレート中のプレースホルダのキーと置換文字列を追加する。
void	setTemplateId(String templateId) テンプレートIDを設定する。

クラスから継承されたメソッド 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

コンストラクタの詳細

TemplateMailContext

@Published
public TemplateMailContext()

TemplateMailContextのインスタンスを生成する。

メソッドの詳細

getTemplateId

@Published(tag="architect")
public String getTemplateId()

テンプレートIDを取得する。

戻り値:

テンプレートID

setTemplateId

@Published
public void setTemplateId(String templateId)

テンプレートIDを設定する。

パラメータ:

templateId - テンプレートID

getLang

@Published(tag="architect")
public String getLang()

言語を取得する。

戻り値:

言語

setLang

@Published
public void setLang(String lang)

言語を設定する。

パラメータ:

lang - 言語

getReplaceKeyValue

@Published(tag="architect")
public Map getReplaceKeyValue()

プレースホルダのキーと置換文字列のマップを取得する。

戻り値:

プレースホルダと置換文字列のマップ

setReplaceKeyValue

@Published
public void setReplaceKeyValue(String key,
                                          String value)

メールテンプレート中のプレースホルダのキーと置換文字列を追加する。

プレースホルダは、指定したkeyをもとにvalueで置換される。
プレースホルダの記述形式は、{キー名} と記載する。
プレースホルダがあるにも関わらず置換文字列が渡されない場合は、変換されずメールが送信される。

パラメータ:

key - プレースホルダのキー

value - 置換文字列(null不可)