Package nablarch.common.mail

Class MailConfig

java.lang.Object
nablarch.common.mail.MailConfig
@Published(tag="architect") public class MailConfig extends Object
出力ライブラリ(メール送信)のコード値を保持するデータオブジェクト。

  • Constructor Details

    • MailConfig

      public MailConfig()

  • Method Details

    • getMailRequestSbnId

      public String getMailRequestSbnId()
      メール送信要求IDの採番対象識別IDを取得する。
      Returns:
      メール送信要求IDの採番対象識別ID

    • setMailRequestSbnId

      public void setMailRequestSbnId(String mailRequestSbnId)
      メール送信要求IDの採番対象識別IDを設定する。
      Parameters:
      mailRequestSbnId - メール送信要求IDの採番対象識別ID

    • getRecipientTypeTO

      public String getRecipientTypeTO()
      メール送信区分(TO)のコード値を取得する。
      Returns:
      メール送信区分(TO)のコード値

    • setRecipientTypeTO

      public void setRecipientTypeTO(String recipientTypeTO)
      メール送信区分(TO)のコード値を設定する。
      Parameters:
      recipientTypeTO - メール送信区分(TO)のコード値

    • getRecipientTypeCC

      public String getRecipientTypeCC()
      メール送信区分(CC)のコード値を取得する。
      Returns:
      メール送信区分(CC)のコード値

    • setRecipientTypeCC

      public void setRecipientTypeCC(String recipientTypeCC)
      メール送信区分(CC)のコード値を設定する。
      Parameters:
      recipientTypeCC - メール送信区分(CC)のコード値

    • getRecipientTypeBCC

      public String getRecipientTypeBCC()
      メール送信区分(BCC)のコード値を取得する。
      Returns:
      メール送信区分(BCC)のコード値

    • setRecipientTypeBCC

      public void setRecipientTypeBCC(String recipientTypeBCC)
      メール送信区分(BCC)のコード値を設定する。
      Parameters:
      recipientTypeBCC - メール送信区分(BCC)のコード値

    • getStatusUnsent

      public String getStatusUnsent()
      メール送信ステータス（未送信）のコード値を取得する。
      Returns:
      メール送信ステータス（未送信）

    • setStatusUnsent

      public void setStatusUnsent(String statusUnsent)
      メール送信ステータス（未送信）のコード値を設定する。
      Parameters:
      statusUnsent - メール送信ステータス（未送信）のコード値

    • getStatusSent

      public String getStatusSent()
      メール送信ステータス（送信済）のコード値を取得する。
      Returns:
      メール送信ステータス（送信済）のコード値

    • setStatusSent

      public void setStatusSent(String statusSent)
      メール送信ステータス（送信済）のコード値を設定する。
      Parameters:
      statusSent - メール送信ステータス（送信済）のコード値

    • getStatusFailure

      public String getStatusFailure()
      メール送信ステータス（送信失敗）のコード値を取得する。
      Returns:
      メール送信ステータス（送信失敗）のコード値

    • setStatusFailure

      public void setStatusFailure(String statusFailure)
      メール送信ステータス（送信失敗）のコード値を設定する。
      Parameters:
      statusFailure - メール送信ステータス（送信失敗）のコード値

    • getSendFailureCode

      public String getSendFailureCode()
      送信失敗時の障害コードを取得する。
      Returns:
      送信失敗時の障害コード

    • getSendSuccessMessageId

      public String getSendSuccessMessageId()
      メール送信成功時のメッセージIDを取得する。
      Returns:
      メール送信成功時のメッセージID

    • setSendSuccessMessageId

      public void setSendSuccessMessageId(String sendSuccessMessageId)
      メール送信成功時のメッセージIDを設定する。 
       ログ出力時に、メール送信要求IDが渡されるため、
 メッセージテーブルにこのメッセージIDに対応する以下のようなメッセージを登録すれば、
 メール送信要求IDをログに含めることが出来る。
 
 メッセージ例）”メールを送信しました。 mailRequestId=[{0}]”
      Parameters:
      sendSuccessMessageId - メール送信成功時のメッセージID

    • getMailRequestCountMessageId

      public String getMailRequestCountMessageId()
      メール送信要求件数出力時のメッセージIDを取得する。
      Returns:
      メール送信要求件数出力時のメッセージID

    • setMailRequestCountMessageId

      public void setMailRequestCountMessageId(String mailRequestCountMessageId)
      メール送信要求件数出力時のメッセージIDを設定する。 * 
       ログ出力時に、メール送信要求の件数が渡されるため、
 メッセージテーブルにこのメッセージIDに対応する以下のようなメッセージを登録すれば、
 メール送信要求の件数をログに含めることが出来る。
 
 メッセージ例）”メール送信要求が {0} 件あります。”
      Parameters:
      mailRequestCountMessageId - メール送信要求件数出力時のメッセージID

    • setSendFailureCode

      public void setSendFailureCode(String sendFailureCode)
      送信失敗時の障害コードを設定する。 
       ログ出力時に、メール送信要求IDが渡されるため、
 メッセージテーブルにこの障害コードに対応する以下のようなメッセージを登録すれば、
 メール送信要求IDをログに含めることが出来る。
 
 メッセージ例）”メール送信に失敗しました。 mailRequestId=[{0}]”
      Parameters:
      sendFailureCode - 送信失敗時の障害コード

    • getAbnormalEndExitCode

      public int getAbnormalEndExitCode()
      送信失敗時の終了コードを取得する。
      Returns:
      送信失敗時の終了コード

    • setAbnormalEndExitCode

      public void setAbnormalEndExitCode(int abnormalEndExitCode)
      送信失敗時の終了コードを設定する。
      Parameters:
      abnormalEndExitCode - 送信失敗時の終了コード