nablarch.common.mail

Class MailRequester

java.lang.Object

nablarch.common.mail.MailRequester

@Published(tag="architect")
public class MailRequester
extends java.lang.Object

メール送信要求を行うクラス。

本クラスのメール送信要求メソッドを呼び出すことで、メール送信要求を管理用テーブル群にINSERTできる。

メール送信要求の種類について
メール送信要求は以下の二種類がある。

• 定型メール送信(TemplateMailContext)。 予めデータベースに登録されたテンプレートを元にメールを作成・送信する。
• 非定型メール送信(FreeTextMailContext)。任意の件名・本文でメールを作成・送信する。

メールの送信単位
メール送信要求はメール送信要求APIの呼び出し毎に一つ作成さる。一つのメール送信要求につき一通のメールが送信される。

Author:

Shinsuke Yoshio

See Also:

MailUtil.getMailRequester()

Method Summary

Modifier and Type	Method and Description
java.lang.String	requestToSend(FreeTextMailContext ctx) 非定型メールの送信要求を行う。
java.lang.String	requestToSend(TemplateMailContext ctx) 定型メールの送信要求を行う。
void	setMailAttachedFileTable(MailAttachedFileTable mailAttachedFileTable) 添付ファイル管理テーブルのスキーマ情報を設定する。
void	setMailConfig(MailConfig mailConfig) メール関連のコード値を保持するデータオブジェクトを設定する。
void	setMailRecipientTable(MailRecipientTable mailRecipientTable) メール送信先管理テーブルのスキーマ情報を設定する。
void	setMailRequestConfig(MailRequestConfig mailRequestConfig) メール送信要求共通設定を保持するデータオブジェクトを設定する。
void	setMailRequestIdGenerator(IdGenerator mailRequestIdGenerator) メール送信要求IDジェネレータを設定する。
void	setMailRequestTable(MailRequestTable mailRequestTable) mailSendRequestTable メール送信要求管理テーブルのスキーマ情報を設定する。
void	setMailTransactionManager(SimpleDbTransactionManager mailTransactionManager) メール送信時に利用するトランザクションマネージャを設定する。
void	setTemplateEngineMailProcessor(nablarch.common.mail.TemplateEngineMailProcessor templateEngineMailProcessor) 定型メールの件名と本文を構築するテンプレートエンジン処理クラスを設定する。

Method Detail

requestToSend

@Published
public java.lang.String requestToSend(FreeTextMailContext ctx)
                                          throws AttachedFileSizeOverException,
                                                 RecipientCountException

非定型メールの送信要求を行う。

Parameters:

ctx - 非定型メール送信要求

Returns:

メール送信要求ID

Throws:

AttachedFileSizeOverException - 添付ファイルのサイズが上限値を超えた場合

RecipientCountException - 宛先数が上限値を超えた場合

requestToSend

@Published
public java.lang.String requestToSend(TemplateMailContext ctx)
                                          throws AttachedFileSizeOverException,
                                                 RecipientCountException

定型メールの送信要求を行う。

Parameters:

ctx - 定型メール送信要求

Returns:

メール送信要求ID

Throws:

AttachedFileSizeOverException - 添付ファイルのサイズが上限値を超えた場合

RecipientCountException - 宛先数が上限値を超えた場合

setMailRequestConfig

public void setMailRequestConfig(MailRequestConfig mailRequestConfig)

メール送信要求共通設定を保持するデータオブジェクトを設定する。

Parameters:

mailRequestConfig - メール送信要求共通設定を保持するデータオブジェクト

setMailConfig

public void setMailConfig(MailConfig mailConfig)

メール関連のコード値を保持するデータオブジェクトを設定する。

Parameters:

mailConfig - メール関連のコード値を保持するデータオブジェクト

setMailRequestIdGenerator

public void setMailRequestIdGenerator(IdGenerator mailRequestIdGenerator)

メール送信要求IDジェネレータを設定する。

Parameters:

mailRequestIdGenerator - メール送信要求IDジェネレータ

setMailRequestTable

public void setMailRequestTable(MailRequestTable mailRequestTable)

mailSendRequestTable メール送信要求管理テーブルのスキーマ情報を設定する。

Parameters:

mailRequestTable - メール送信要求管理テーブルのスキーマ。

setMailRecipientTable

public void setMailRecipientTable(MailRecipientTable mailRecipientTable)

メール送信先管理テーブルのスキーマ情報を設定する。

Parameters:

mailRecipientTable - メール送信先管理テーブルのスキーマ情報

setMailAttachedFileTable

public void setMailAttachedFileTable(MailAttachedFileTable mailAttachedFileTable)

添付ファイル管理テーブルのスキーマ情報を設定する。

Parameters:

mailAttachedFileTable - 添付ファイル管理テーブルのスキーマ情報

setMailTransactionManager

public void setMailTransactionManager(SimpleDbTransactionManager mailTransactionManager)

メール送信時に利用するトランザクションマネージャを設定する。

Parameters:

mailTransactionManager - トランザクションマネージャ

setTemplateEngineMailProcessor

public void setTemplateEngineMailProcessor(nablarch.common.mail.TemplateEngineMailProcessor templateEngineMailProcessor)

定型メールの件名と本文を構築するテンプレートエンジン処理クラスを設定する。

Parameters:

templateEngineMailProcessor - 定型メールの件名と本文を構築するテンプレートエンジン処理クラス