パッケージ org.opengion.hayabusa.mail

# クラス MailPattern

java.lang.Object
org.opengion.hayabusa.mail.MailPattern

public class MailPattern extends Object
メール定型文及びそれも基づいて各項目の合成を行うクラスです。 コンストラクタには定型文ID及びシステムIDで定型文マスタよりメールの定型文を取得します。 メール各項目のゲッターでは、定型文の内容を元にパラメータ値とマージして各項目を合成します。 宛先について、セットした社員ID、グループIDと定型文の宛先設定に基づき、社員マスタと グループマスタよりメールアドレス情報を取得して宛先マップを作成します。

変更履歴:
  5.6.6.0 (2013/07/05) host指定対応。GE37必須です。
機能分類
  メールモジュール
導入されたバージョン:
  JDK1.6

- ## フィールドの概要

  フィールド
  修飾子とタイプ
  フィールド
  説明
  `static final int`
  `GE35_MAIL`
  GE35のメールアドレス
  `static final int`
  `GE35_NAME`
  GE35のユーザ名称
  `static final int`
  `IDX_DST_ADDR`
  カラム番号(宛先テーブル) 4
  `static final int`
  `IDX_DST_ID`
  カラム番号(宛先テーブル) 0
  `static final int`
  `IDX_DST_KBN`
  カラム番号(宛先テーブル) 5
  `static final int`
  `IDX_DST_NAME`
  カラム番号(宛先テーブル) 3
  `static final int`
  `IDX_FGJ`
  カラム番号(宛先テーブル) 6
  `static final int`
  `IDX_GROUP_ID`
  カラム番号(宛先テーブル) 1
  `static final int`
  `IDX_GROUP_NAME`
  カラム番号(宛先テーブル) 2
  `static final int`
  `KBN_BCC`
  メール送信区分 2
  `static final int`
  `KBN_CC`
  メール送信区分 1
  `static final int`
  `KBN_TO`
  メール送信区分 0
  `static final String`
  `SEL_GE35`
  GE35のメールアドレス検索文

- ## コンストラクタの概要

  コンストラクタ
  コンストラクタ
  説明
  `MailPattern(ConcurrentMap<String,String> params)`
  メール定型文オブジェクトを作成するコンストラクタです。

- ## メソッドの概要

  修飾子とタイプ
  メソッド
  説明
  `String`
  `getAuthPass()`
  メール送信認証パスワードを返します GE31のJOKEN(振り分け条件)を元に、GE37テーブルの AUTHPASS を取得します。
  `String`
  `getAuthPort()`
  メール送信認証ポートを返します。
  `String`
  `getAuthType()`
  メール送信時認証有無を返します GE31のJOKEN(振り分け条件)を元に、GE37テーブルの AUTH を取得します。
  `String`
  `getAuthUser()`
  メール送信認証ユーザを返します GE31のJOKEN(振り分け条件)を元に、GE37テーブルの AUTHUSER を取得します。
  `String`
  `getContent()`
  マージ済のメール本文を返します。
  `ConcurrentMap<String,String[]>`
  `getDstMap()`
  送信先のアドレスをセットします。
  `List<String>`
  `getErrList()`
  アドレスエラーのメッセージリストを返します。
  `String`
  `getFromAddr()`
  定型文の送信者ID欄の設定値とパラメータ{@FROM}を元に送信者アドレスを取得します。
  `String`
  `getHost()`
  メール送信ホストを返します。
  `String`
  `getSmtpPort()`
  メール送信ポート番号を返します GE31のJOKEN(振り分け条件)を元に、GE37テーブルの PORT を取得します。
  `String`
  `getTitle()`
  マージ済のメールタイトルを返します。

  ### クラスから継承されたメソッド java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## フィールド詳細

  - ### SEL_GE35

    public static final String SEL_GE35
    GE35のメールアドレス検索文
    関連項目:
      - 定数フィールド値
    変更履歴:
      6.4.1.1 (2016/01/16) selGE35 → SEL_GE35 refactoring

  - ### GE35_NAME

    public static final int GE35_NAME
    GE35のユーザ名称
    関連項目:
      - 定数フィールド値

  - ### GE35_MAIL

    public static final int GE35_MAIL
    GE35のメールアドレス
    関連項目:
      - 定数フィールド値

  - ### IDX_DST_ID

    public static final int IDX_DST_ID
    カラム番号(宛先テーブル) 0
    関連項目:
      - 定数フィールド値

  - ### IDX_GROUP_ID

    public static final int IDX_GROUP_ID
    カラム番号(宛先テーブル) 1
    関連項目:
      - 定数フィールド値

  - ### IDX_GROUP_NAME

    public static final int IDX_GROUP_NAME
    カラム番号(宛先テーブル) 2
    関連項目:
      - 定数フィールド値

  - ### IDX_DST_NAME

    public static final int IDX_DST_NAME
    カラム番号(宛先テーブル) 3
    関連項目:
      - 定数フィールド値

  - ### IDX_DST_ADDR

    public static final int IDX_DST_ADDR
    カラム番号(宛先テーブル) 4
    関連項目:
      - 定数フィールド値

  - ### IDX_DST_KBN

    public static final int IDX_DST_KBN
    カラム番号(宛先テーブル) 5
    関連項目:
      - 定数フィールド値

  - ### IDX_FGJ

    public static final int IDX_FGJ
    カラム番号(宛先テーブル) 6
    関連項目:
      - 定数フィールド値

  - ### KBN_TO

    public static final int KBN_TO
    メール送信区分 0
    関連項目:
      - 定数フィールド値

  - ### KBN_CC

    public static final int KBN_CC
    メール送信区分 1
    関連項目:
      - 定数フィールド値

  - ### KBN_BCC

    public static final int KBN_BCC
    メール送信区分 2
    関連項目:
      - 定数フィールド値

- ## コンストラクタの詳細

  - ### MailPattern

    public MailPattern(ConcurrentMap<String,String> params)
    メール定型文オブジェクトを作成するコンストラクタです。 定型文マスタより取得したデータを各フィルードにセットします。
    パラメータ:
      `params` - パラメータのマップ
    変更履歴:
      5.5.5.1 (2012/08/07) リソース系DBID 付け忘れ対策, 5.6.6.0 (2013/07/05) 振り分け対応, 6.0.3.0 (2014/11/13) Ver6用キーワード変更, 6.4.1.1 (2016/01/16) DefaultMailManager.appInfo → DefaultMailManager.APP_INFO refactoring, 6.4.3.3 (2016/03/04) 戻すMapが、not null制限つきであることを示すため、ConcurrentMap に置き換えます。

- ## メソッドの詳細

  - ### getFromAddr

    public String getFromAddr()
    定型文の送信者ID欄の設定値とパラメータ{@FROM}を元に送信者アドレスを取得します。 定型文には{@FROM}とセットされている場合は、パラメータ｛@FROM｝の値を元に、社員IDをセット されている場合、直接そのIDを元に社員マスタから送信者アドレスを取得します。 送信者アドレス取得できなければ例外を投げます。
    戻り値:
      送信者アドレス
    変更履歴:
      4.3.7.5 (2009/07/08) 送信元名称が設定されていない場合は、アドレスを<>で囲わない

  - ### getTitle

    public String getTitle()
    マージ済のメールタイトルを返します。
    戻り値:
      メールタイトル

  - ### getContent

    public String getContent()
    マージ済のメール本文を返します。
    戻り値:
      メール本文
    変更履歴:
      5.1.0.0 (2009/11/04) HEADER ⇒ H_TXT , FOOTER ⇒ F_TXT カラム名変更
    このﾒｿｯﾄﾞは、nullを返しません

  - ### getDstMap

    public ConcurrentMap<String,String[]> getDstMap()
    送信先のアドレスをセットします。 定型文に定義されている宛先(TO、CC、BCC)を引数として渡します。引数には{@TO}、{@CC}、{@BCC}が含まれています。 {@TO}、{@CC}、{@BCC}を初期設定の値で置換えて、実のメールアドレスマップを作成します。
    戻り値:
      宛先のマップ
    変更履歴:
      6.4.3.1 (2016/02/12) 毎回作成しているので、ローカルに移動する。, 6.4.3.3 (2016/03/04) 戻すMapが、not null制限つきであることを示すため、ConcurrentMap に置き換えます。

  - ### getErrList

    public List<String> getErrList()
    アドレスエラーのメッセージリストを返します。
    戻り値:
      メッセージリスト

  - ### getHost

    public String getHost()
    メール送信ホストを返します。 GE31のJOKEN(振り分け条件)を元に、GE37テーブルの HOST を取得します。 振り分け条件が未設定の場合は、システム定数のCOMMON_MAIL_SERVER を使用します。 (初期値:システム定数のCOMMON_MAIL_SERVER[=])。
    戻り値:
      メール送信ホスト
    変更履歴:
      5.6.6.0 (2013/07/05)

  - ### getSmtpPort

    public String getSmtpPort()
    メール送信ポート番号を返します GE31のJOKEN(振り分け条件)を元に、GE37テーブルの PORT を取得します。 振り分け条件が未設定の場合は、システム定数のSMTP_PORT を使用します。 (初期値:システム定数のSMTP_PORT[=])。
    戻り値:
      メール送信ポート番号
    変更履歴:
      5.6.6.0 (2013/07/05)

  - ### getAuthType

    public String getAuthType()
    メール送信時認証有無を返します GE31のJOKEN(振り分け条件)を元に、GE37テーブルの AUTH を取得します。 振り分け条件が未設定の場合は、システム定数のMAIL_SEND_AUTH を使用します。 (初期値:システム定数のMAIL_SEND_AUTH[=])。
    戻り値:
      メール送信時認証有無
    変更履歴:
      6.0.3.0 (2014/11/13) Ver6用キーワード変更

  - ### getAuthPort

    public String getAuthPort()
    メール送信認証ポートを返します。 「POP_BEFORE_SMTP」認証を行う場合に、POPサーバーに接続するポート番号を返します。 GE37テーブルに指定するカラムはありません。 初期値は、システム定数のMAIL_SEND_AUTH_PORT を使用します。 (初期値:システム定数のMAIL_SEND_AUTH_PORT[=])。
    戻り値:
      メール送信認証ポート
    変更履歴:
      5.8.1.1 (2014/11/14) メール送信時認証「POP_BEFORE_SMTP」追加

  - ### getAuthUser

    public String getAuthUser()
    メール送信認証ユーザを返します GE31のJOKEN(振り分け条件)を元に、GE37テーブルの AUTHUSER を取得します。 振り分け条件が未設定の場合は、システム定数のMAIL_SEND_AUTH_USER を使用します。 (初期値:システム定数のMAIL_SEND_AUTH_USER[=])。
    戻り値:
      メール送信認証ユーザ
    変更履歴:
      5.6.6.0 (2013/07/05)

  - ### getAuthPass

    public String getAuthPass()
    メール送信認証パスワードを返します GE31のJOKEN(振り分け条件)を元に、GE37テーブルの AUTHPASS を取得します。 振り分け条件が未設定の場合は、システム定数のMAIL_SEND_AUTH_PASSWORD を使用します。 (初期値:システム定数のMAIL_SEND_AUTH_PASSWORD[=])。
    戻り値:
      メール送信認証パスワード
    変更履歴:
      5.6.6.0 (2013/07/05)