Package nablarch.common.mail

Class MailContext

java.lang.Object
nablarch.common.mail.MailContext
Direct Known Subclasses:
FreeTextMailContext, TemplateMailContext
public abstract class MailContext extends Object
メール送信要求を表す抽象クラス。

以下の項目は、指定しない場合デフォルト値が使用される。
  • 返信先メールアドレス：MailRequestConfig.defaultReturnPathの設定値
  • 差し戻し先メールアドレス：MailRequestConfig.defaultReplyToの設定値
  • Content-Typeヘッダに指定する文字セット：MailRequestConfig.defaultCharsetの設定値

  • Constructor Details

    • MailContext

      public MailContext()

  • Method Details

    • validate

      public void validate(MailRequestConfig mailRequestConfig)
      メール送信要求をバリデーションする。
      バリデーション内容は以下の2つ。下記以外は業務アプリにてバリデーション済みの前提。
      • 宛先の数が0でないか、もしくは上限値を超えていないか。
      • 添付ファイルのファイルサイズが上限値を超えていないか。
      Parameters:
      mailRequestConfig - メールのデフォルト設定

    • getFrom

      @Published(tag="architect") public String getFrom()
      送信元メールアドレスを取得する。
      Returns:
      送信元メールアドレス

    • setFrom

      @Published public void setFrom(String from)
      送信元メールアドレスを設定する。
      Parameters:
      from - 送信元メールアドレス

    • getToList

      @Published(tag="architect") public Set<String> getToList()
      送信先(TO)メールアドレスのリストを取得する。
      Returns:
      送信先(TO)メールアドレスのリスト

    • addTo

      @Published public void addTo(String to)
      送信先(TO)メールアドレスを追加する。
      Parameters:
      to - 送信先(TO)メールアドレス

    • getCcList

      @Published(tag="architect") public Set<String> getCcList()
      送信先(CC)メールアドレスのリストを取得する。
      Returns:
      送信先(CC)メールアドレスのリスト

    • addCc

      @Published public void addCc(String cc)
      送信先(CC)メールアドレスを追加する。
      Parameters:
      cc - 送信先(CC)メールアドレス

    • getBccList

      @Published(tag="architect") public Set<String> getBccList()
      送信先(BCC)メールアドレスのリストを取得する。
      Returns:
      送信先(BCC)メールアドレス

    • addBcc

      @Published public void addBcc(String bcc)
      送信先(BCC)メールアドレスを追加する。
      Parameters:
      bcc - 送信先(BCC)メールアドレス

    • getReturnPath

      @Published(tag="architect") public String getReturnPath()
      差し戻し先メールアドレスを取得する。
      Returns:
      差し戻し先メールアドレス

    • setReturnPath

      @Published public void setReturnPath(String returnPath)
      差し戻し先メールアドレスを設定する。
      Parameters:
      returnPath - 差し戻し先メールアドレス

    • getReplyTo

      @Published(tag="architect") public String getReplyTo()
      返信先メールアドレスを取得する。
      Returns:
      返信先メールアドレス

    • setReplyTo

      @Published public void setReplyTo(String replyTo)
      返信先メールアドレスを設定する。
      Parameters:
      replyTo - 返信先メールアドレス

    • getSubject

      @Published(tag="architect") protected String getSubject()
      件名を取得する。
      Returns:
      件名

    • setSubject

      @Published protected void setSubject(String subject)
      件名を設定する。
      Parameters:
      subject - 件名

    • getMailBody

      @Published(tag="architect") protected String getMailBody()
      本文を取得する。
      Returns:
      本文

    • setMailBody

      @Published protected void setMailBody(String mailBody)
      本文を設定する。
      Parameters:
      mailBody - 本文

    • getCharset

      @Published(tag="architect") protected String getCharset()
      Content-Typeヘッダに指定する文字セットを取得する。
      Returns:
      Content-Typeヘッダに指定する文字セット

    • setCharset

      @Published protected void setCharset(String charset)
      Content-Typeヘッダに指定する文字セットを設定する。
      Parameters:
      charset - Content-Typeヘッダに指定する文字セット

    • getAttachedFileList

      @Published(tag="architect") public List<AttachedFile> getAttachedFileList()
      添付ファイルのリストを取得する。
      Returns:
      添付ファイルのリスト

    • addAttachedFile

      @Published public void addAttachedFile(AttachedFile attachedFile)
      添付ファイルを追加する。
      Parameters:
      attachedFile - 添付ファイル

    • getMailSendPatternId

      @Published(tag="architect") public String getMailSendPatternId()
      メール送信パターンIDを取得する。
      Returns:
      メール送信パターンID

    • setMailSendPatternId

      @Published public void setMailSendPatternId(String mailSendPatternId)
      メール送信パターンIDを設定する。

      メール送信パターンIDを指定して未送信データを送信する場合は必須。

      Parameters:
      mailSendPatternId - メール送信パターンID