Package nablarch.common.mail

Class TemplateMailContext

java.lang.Object
nablarch.common.mail.MailContext
nablarch.common.mail.TemplateMailContext
public class TemplateMailContext extends MailContext
定型メール送信要求を表すクラス。

  • Constructor Details

  • Method Details

    • getTemplateId

      @Published(tag="architect") public String getTemplateId()
      テンプレートIDを取得する。
      Returns:
      テンプレートID

    • setTemplateId

      @Published public void setTemplateId(String templateId)
      テンプレートIDを設定する。
      Parameters:
      templateId - テンプレートID

    • getLang

      @Published(tag="architect") public String getLang()
      言語を取得する。
      Returns:
      言語

    • setLang

      @Published public void setLang(String lang)
      言語を設定する。
      Parameters:
      lang - 言語

    • getReplaceKeyValue

      @Published(tag="architect") @Deprecated public Map<String,String> getReplaceKeyValue()
      Deprecated.
      当メソッドは5u13より前から存在する定型メール機能のためにある。 当メソッドの仕様を満たしつつより柔軟な機能をもつgetVariables()が追加されたので今後はそちらを使用すること。
      プレースホルダのキーと置換文字列のマップを取得する。
      Returns:
      プレースホルダと置換文字列のマップ

    • getVariables

      @Published(tag="architect") public Map<String,Object> getVariables()
      テンプレートとマージする変数を取得する。
      Returns:
      テンプレートとマージする変数

    • setReplaceKeyValue

      @Published @Deprecated public void setReplaceKeyValue(String key, String value)
      Deprecated.
      当メソッドは5u13より前から存在する定型メール機能のためにある。 当メソッドの仕様を満たしつつより柔軟な機能をもつsetVariable(String, Object)が追加されたので今後はそちらを使用すること。
      メールテンプレート中のプレースホルダのキーと置換文字列を追加する。

      プレースホルダは、指定したkeyをもとにvalueで置換される。
      プレースホルダの記述形式は、{キー名} と記載する。
      プレースホルダがあるにも関わらず置換文字列が渡されない場合は、変換されずメールが送信される。
      ただし、テンプレートエンジンを使用したメール送信処理ではプレースホルダがあるにも関わらず 置換文字列が渡されない場合の動作はテンプレートエンジンの仕様に準ずる。

      Parameters:
      key - プレースホルダのキー
      value - 置換文字列(null不可)

    • setVariable

      @Published public void setVariable(String name, Object value)
      テンプレートとマージする変数を追加する。
      Parameters:
      name - 変数名
      value - 値