7.7. メール送信¶

7.7.1.1. テンプレートを使った定型メールを送信できる。¶

システムのメール送信では、登録完了通知メールのように、同じ文言で、一部の項目のみ異なるメールを送信することが多い。 そこで、本機能では、テンプレートを用意しておき、プレースホルダを変換して、件名と本文を作成する機能を提供している。 機能の詳細は、 メール送信要求を登録する を参照。

7.7.1.2. キャンペーン通知のような大量メールの一斉送信には対応していない¶

本機能では、キャンペーン通知のような一斉送信には対応していない。 下記に当てはまる場合は、プロダクトの利用を推奨する。

• キャンペーン通知やメールマガジンなど、一括で大量のメールを送信する。
• 配信したメールの開封率、クリックカウントの効果を測定する。
• メールアドレスからクライアント(例えば、フィーチャーフォンか否か)を判別し、送信するメールを切り替える。

7.7.3.1. メール送信を使うための設定を行う¶

この機能では、データベースを使用してメール送信に使うデータを管理する。 テーブルのレイアウトは以下となる。

メール送信を使うには、以下の設定を行う。

• メール送信要求とメール送信バッチの共通設定
• メール送信要求の設定
• メール送信バッチの設定

メール送信要求とメール送信バッチの共通設定

共通設定では、以下の設定を行う。

• テーブルスキーマ
• コード値とメッセージ

テーブルスキーマ

次のクラスの設定をコンポーネント定義に追加する。 設定項目の詳細はリンク先のJavadocを参照。

• MailRequestTable (メール送信要求テーブル)
• MailRecipientTable (メール送信先テーブル)
• MailAttachedFileTable (添付ファイルテーブル)
• MailTemplateTable (メールテンプレートテーブル)

設定例を以下に示す。

<!-- メール送信要求テーブルのスキーマ -->
<component name="mailRequestTable" class="nablarch.common.mail.MailRequestTable">
  <!-- テーブル名とカラム名を指定する。ここでは省略する。 -->
</component>

<!-- メール送信先テーブルのスキーマ -->
<component name="mailRecipientTable" class="nablarch.common.mail.MailRecipientTable">
  <!-- テーブル名とカラム名を指定する。ここでは省略する。 -->
</component>

<!-- 添付ファイルテーブルのスキーマ -->
<component name="mailAttachedFileTable" class="nablarch.common.mail.MailAttachedFileTable">
  <!-- テーブル名とカラム名を指定する。ここでは省略する。 -->
</component>

<!-- メールテンプレートテーブルのスキーマ -->
<component name="mailTemplateTable" class="nablarch.common.mail.MailTemplateTable">
  <!-- テーブル名とカラム名を指定する。ここでは省略する。 -->
</component>

<!-- 初期化設定 -->
<component name="initializer"
           class="nablarch.core.repository.initialization.BasicApplicationInitializer">
  <property name="initializeList">
    <list>
      <!-- 他のコンポーネントは省略 -->
      <component-ref name="mailRequestTable" />
      <component-ref name="mailRecipientTable" />
      <component-ref name="mailAttachedFileTable" />
      <component-ref name="mailTemplateTable" />
    </list>
  </property>
</component>

補足

MailRequestTableのmailSendPatternIdColumnNameプロパティ, sendProcessIdColumnNameプロパティは任意項目であり、機能を使用したい場合に設定する。 mailSendPatternIdColumnNameプロパティについては 未送信のデータを抽出する際の条件 を、 sendProcessIdColumnNameプロパティについては メール送信をマルチプロセス化する を参照すること。

コード値とメッセージ

メール送信に使用するコード値、メッセージID、障害コードを設定する。 MailConfig の設定をコンポーネント定義に追加する。 設定項目の詳細は、 MailConfigのJavadoc を参照。

設定例を以下に示す。

<component name="mailConfig" class="nablarch.common.mail.MailConfig">

  <!-- メール送信要求IDの採番対象識別ID -->
  <property name="mailRequestSbnId" value="MAIL_REQUEST_ID" />

  <!-- メールの送信先区分(TO／CC／BCC)を表すコード値 -->
  <property name="recipientTypeTO" value="0" />
  <property name="recipientTypeCC" value="1" />
  <property name="recipientTypeBCC" value="2" />

  <!-- メールの送信状態(未送信／送信済／送信失敗)を表すコード値 -->
  <property name="statusUnsent" value="0" />
  <property name="statusSent" value="1" />
  <property name="statusFailure" value="2" />

  <!-- メール送信要求件数出力時のメッセージID -->
  <property name="mailRequestCountMessageId" value="mail.request.count" />

  <!-- メール送信成功時のメッセージID -->
  <property name="sendSuccessMessageId" value="mail.send.success" />

  <!-- 送信失敗時の障害コード -->
  <property name="sendFailureCode" value="mail.send.failure" />

  <!-- 送信失敗時の終了コード -->
  <property name="abnormalEndExitCode" value="199" />

</component>

メール送信要求の設定

以下のクラスをコンポーネント定義に追加する。 設定項目の詳細はリンク先のJavadocを参照。

• MailRequester (メール送信要求をデータベースに登録するコンポーネント)
• MailRequestConfig (メール送信要求時の設定値を保持するクラス)

MailRequester は、 メール送信要求をデータベースに登録する際、 採番 を使ってメール送信要求IDを生成する。 そのため、 採番 の設定も別途必要となる。

設定例を以下に示す。

ポイント

• MailRequester は名前でルックアップされるため、 コンポーネント名に mailRequester と指定する。

<!-- メール送信要求コンポーネント。 -->
<component name="mailRequester" class="nablarch.common.mail.MailRequester">

  <!-- メール送信要求時の設定値(以下のコンポーネント定義を参照) -->
  <property name="mailRequestConfig" ref="mailRequestConfig" />

  <!-- メール送信要求IDの採番に使用するIdGenerator -->
  <property name="mailRequestIdGenerator" ref="idGenerator" />

  <!-- テーブルのスキーマ -->
  <property name="mailRequestTable" ref="mailRequestTable" />
  <property name="mailRecipientTable" ref="mailRecipientTable" />
  <property name="mailAttachedFileTable" ref="mailAttachedFileTable" />
  <property name="templateEngineMailProcessor">
    <component class="nablarch.common.mail.TinyTemplateEngineMailProcessor">
      <property name="mailTemplateTable" ref="mailTemplateTable" />
    </component>
  </property>

</component>

<!-- メール送信要求時の設定値 -->
<component name="mailRequestConfig" class="nablarch.common.mail.MailRequestConfig">

  <!-- デフォルトの返信先メールアドレス -->
  <property name="defaultReplyTo" value="default.reply.to@nablarch.sample" />

  <!-- デフォルトの差戻し先メールアドレス -->
  <property name="defaultReturnPath" value="default.return.path@nablarch.sample" />

  <!-- デフォルトの文字セット -->
  <property name="defaultCharset" value="ISO-2022-JP" />

  <!-- 最大宛先数 -->
  <property name="maxRecipientCount" value="100" />

  <!-- 最大添付ファイルサイズ(byte数で記述) -->
  <property name="maxAttachedFileSize" value="2097152" />

</component>

※説明のため TinyTemplateEngineMailProcessor を設定しているが限定的な機能しか持たないため、FreeMarkerなどのテンプレートエンジンの使用を推奨する。 詳しくは テンプレートを使った定型メールを送信できる。 を参照。

メール送信バッチの設定

メール送信バッチが使用するSMTPサーバーへの接続情報を設定する。 MailSessionConfig をコンポーネント定義に追加する。 設定項目の詳細は、リンク先のJavadocを参照。

設定例を以下に示す。

<component name="mailSessionConfig" class="nablarch.common.mail.MailSessionConfig">
  <property name="mailSmtpHost" value="localhost" />
  <property name="mailHost" value="localhost" />
  <property name="mailSmtpPort" value="25" />
  <property name="mailSmtpConnectionTimeout" value="100000" />
  <property name="mailSmtpTimeout" value="100000" />
</component>

7.7.3.2. メール送信要求を登録する¶

メール送信要求の登録には、以下のクラスを使用する。

• MailRequester (メール送信要求をデータベースに登録する)
• MailUtil ( MailRequester を取得する)
• FreeTextMailContext (非定型メールの送信要求)
• TemplateMailContext (定型メールの送信要求)
• AttachedFile (添付ファイル)

この機能では、フリーフォーマットの非定型メールと、 予め登録しておいたテンプレートを使用する定型メールに対応しており、 それぞれに対応したクラスを使用して、メール送信要求を作成する。

ここでは、定型メールの実装例を以下に示す。

// メール送信要求を作成する。
TemplateMailContext mailRequest = new TemplateMailContext();
mailRequest.setFrom("from@tis.co.jp");
mailRequest.addTo("to@tis.co.jp");
mailRequest.addCc("cc@tis.co.jp");
mailRequest.addBcc("bcc@tis.co.jp");
mailRequest.setSubject("件名");
mailRequest.setTemplateId("テンプレートID");
mailRequest.setLang("ja");

// テンプレートのプレースホルダに対する値を設定する。
mailRequest.setVariable("name", "名前");
mailRequest.setVariable("address", "住所");
mailRequest.setVariable("tel", "電話番号");
// 以下のように値にnullを設定した場合、空文字列で置き換えが行われる。
mailRequest.setVariable("opeion", null);

// 添付ファイルを設定する。
AttachedFile attachedFile = new AttachedFile("text/plain", new File("path/to/file"));
mailRequest.addAttachedFile(attachedFile);

// メール送信要求を登録する。
MailRequester requester = MailUtil.getMailRequester();
String mailRequestId = requester.requestToSend(mailRequest);

7.7.3.3. メールを送信する(メール送信バッチを実行する)¶

メール送信バッチには、 MailSender を使用する。 MailSender は、 常駐バッチ を使用して動作させるバッチアクションとして作成している。

メール送信処理では、障害発生時に同一のメールが複数送信されないように、以下のような処理の流れとなっている。 これにより、メール送信成功時にはステータスが確実に送信済みとなっているため、二重送信を防止できる。

メール送信の処理の流れ

以下に実行例を示す。 実行方法の詳細については、 アプリケーションを起動する を参照。

ポイント

• requestPathオプションで MailSender を指定する。

java nablarch.fw.launcher.Main \
  -diConfig file:./mail-batch-config.xml \
  -requestPath nablarch.common.mail.MailSender/SENDMAIL00 \
  -userId mailBatchUser

未送信のデータを抽出する際の条件

MailSender は、 メール送信要求テーブルから未送信のデータを抽出し、メール送信を行う。 未送信のデータを抽出する際の条件は、次の2つから選択可能となっている。

• テーブル全体から未送信のデータを抽出する
• メール送信パターンID毎に未送信のデータを抽出する

メール送信パターンIDを使うケースとしては、 例えば、送信までの時間をできるだけ短くしたい優先度が高いメールと、 1時間に1回程度の間隔で送信すればよい優先度の低いメールを扱うようなシステムが考えられる。

メール送信パターンID毎に未送信のデータを抽出する場合には、 監視対象のメール送信パターンID毎にメール送信バッチのプロセスを起動する。 そのため、プロセス起動時には、処理対象のメール送信パターンID(mailSendPatternId)を起動引数に指定する。

以下に実行例を示す。

ポイント

• mailSendPatternId という名前のオプションでメール送信パターンIDを指定する。

java nablarch.fw.launcher.Main \
  -diConfig file:./mail-batch-config.xml \
  -requestPath nablarch.common.mail.MailSender/SENDMAIL00 \
  -userId mailBatchUser
  -mailSendPatternId 02

7.7.3.4. メール送信時のエラー処理¶

MailSender は、外部からの入力データ(アドレスやヘッダー)に起因する例外やメール送信失敗の例外が発生した場合、 対象のメール送信要求のステータスを送信失敗にして次のメール送信処理を行う。 また、上記以外の例外が発生した場合は、メール送信要求のステータスを送信失敗にしてリトライする。

以下の表に例外の種類とそのエラー処理を示す。

メール送信時の例外と処理¶

例外	処理
送信要求のメールアドレス変換時の JavaMailのAddressException	変換に失敗したアドレスをログ出力(ログレベル: ERROR)する。
メールヘッダインジェクション攻撃への対策 での InvalidCharacterException	ヘッダー文字列をログ出力(ログレベル: ERROR)する。
メール送信失敗時の JavaMailのSendFailureException	送信されたアドレス、送信されなかったアドレス、不正なアドレスをログ出力(ログレベル: ERROR)する。
上記以外のメール送信時の Exception	例外をラップしてリトライ例外を送出する。

なお、ステータスの送信失敗への更新に失敗した場合、または、リトライ上限に達した場合、メール送信バッチは異常終了する。

重要

送信失敗の検知は、別プロセスでログファイルをチェックするなどして対応する必要がある。

ログ出力の処理を変更したい場合や、リトライの処理を変更したい場合は、 拡張例 を参照すること。

7.7.3.5. メール送信をマルチプロセス化する¶

メール送信をマルチプロセス化する場合（例えば冗長構成のサーバで実行する場合）、 メール送信要求テーブルのプロセスIDカラムを使用して悲観ロックを行い、複数のプロセスが同一の送信要求を処理しないようにする。 この機能を利用するには、 次の設定が必要となる。

1. メール送信要求テーブルにメール送信バッチのプロセスIDのカラムを定義する
2. MailRequestTable のsendProcessIdColumnNameのプロパティの値にメール送信バッチのプロセスIDのカラム名を設定し、コンポーネント定義に追加する
3. メール送信バッチのプロセスID更新用のトランザクションを mailMultiProcessTransaction の名前でコンポーネント定義に追加する(トランザクションの設定方法は 現在のトランザクションとは異なるトランザクションでSQLを実行する を参照)

重要

2. の設定がされていない場合、排他制御がされないため１件のメール送信要求を複数プロセスが処理する可能性がある。 しかし、見かけ上メール送信バッチが動作するため、設定漏れを検知しづらい。 メール送信をマルチプロセス化する場合は上記の設定を漏れなく行うこと。

7.7.3.6. メールヘッダインジェクション攻撃への対策¶

メールヘッダインジェクション攻撃への根本的対策として、以下の対策を実施する必要がある。

• メールヘッダは固定値を使用する。外部からの入力値を使用しない。
• プログラミング言語の標準APIを使用してメール送信を行う。Javaの場合は JavaMail API(外部サイト、英語) を使用する。

メールヘッダは固定値を使用する。外部からの入力値を使用しない。

これについては、プロジェクトで対応する。 固定値にできない場合は、改行コードを変換するか、取り除く対応をプロジェクトで行う。

プログラミング言語の標準APIを使用してメール送信を行う。Javaの場合は JavaMail API(外部サイト、英語) を使用する。

本機能では JavaMail API(外部サイト、英語) を利用している。 しかし、 JavaMail API(外部サイト、英語) を利用しても、一部のメールヘッダの項目に改行コードが含まれていてもメール送信可能な項目がある。 そのため、保険的対策として、これらの項目に対して改行コードが含まれている場合にはメール送信を実施しないチェック機能を設けている。 改行コードが含まれていた場合には、 InvalidCharacterException の送出およびログ出力(ログレベル: ERROR)を行い、該当のメールは送信処理を失敗として扱うこととする。

この保険的対策は、脆弱性となる可能性のある以下の項目を対象としている。

• 件名
• 差し戻し先メールアドレス

7.7.4.1. 電子署名を付加したりメール本文を暗号化するなどメール送信処理を変更する¶

MailSender は、 メール送信要求やテンプレートで指定された内容をそのまま送信する。 アプリケーション要件によっては、電子署名を付加したりメール本文を暗号化する必要が出てくる。

そのような場合は、 MailSender を継承したクラスをプロジェクトで作成して対応する。 詳細は、 MailSenderのJavadoc を参照。

7.7.4.2. メール送信に失敗した際の処理を変更する¶

メール送信に失敗した際のエラー処理(詳細は メール送信時のエラー処理 を参照)を、例えば、ログレベルを変更したり、 リトライ対象の例外を変更するなど、アプリケーションの要件によって変更したい場合がある。

そのような場合は、上の例と同様、MailSender を継承したクラスを作成して対応する。

7.7.4.3. メール送信要求時に利用するトランザクションを指定する¶

業務アプリケーションが失敗してもメール送信要求を確実に行いたい場合など、 メール送信要求 MailRequester とメール送信要求IDの 採番 で実行されるトランザクションを、業務アプリケーションのトランザクションとは独立して指定したい場合がある。

その場合の設定例を以下に示す。

ポイント

• トランザクションマネージャとメール送信要求IDの採番で指定するトランザクション名を同じにする。

<!-- メール送信要求コンポーネント -->
<component name="mailRequester" class="nablarch.common.mail.MailRequester">
  <!-- メール送信に用いるトランザクションを指定 -->
  <property name="mailTransactionManager" ref="txManager" />
</component>

<!-- トランザクションマネージャ  -->
<component name="txManager" class="nablarch.core.db.transaction.SimpleDbTransactionManager">
  <property name="dbTransactionName" value="mail-transaction" />
</component>

<!-- メール送信要求IDジェネレータ -->
<component name="mailRequestIdGenerator"
    class="nablarch.common.idgenerator.TableIdGenerator">
    <!-- トランザクションマネージャで指定したトランザクション名を指定 -->
    <property name="dbTransactionName" value="mail-transaction" />
</component>