|
|||||||||||
| 前のクラス 次のクラス | フレームあり フレームなし | ||||||||||
| 概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド | ||||||||||
java.lang.Objectcom.ozacc.mail.mock.MockSendMail
SendMailImplクラスのMock。
実存するSMTPサーバを設定しても、実際には送信されません。
デバッグモードを有効にすると、メールを送信するタイミングでコンソールに送信メール内容が出力されます。
Mailインスタンスを addExpectedMail() にセットし verify() メソッドを実行すると、send() されたMailインスタンスと全てのプロパティ(XHeader、添付ファイルを除く)が一致しなければAssertionFailedExceptionがスローされます。
例えば、send() されたMailインスタンスのFromアドレスと件名だけチェックし、その他のプロパティはチェックしたくない場合は、MockMailインスタンスを使用します。
Mail sentMail = new Mail();
sentMail.setFrom("from@example.com");
sentMail.setSubject("件名");
sentMail.addTo("to@example.com");
sentMail.setText("動的生成される本文");
Mail expectedMail = new Mail();
expectedMail.setFrom("from@example.com");
expectedMail.setSubject("件名");
MockMail mockMail = new MockMail();
mockMail.setFrom("from@example.com");
mockMail.setSubject("件名");
MockSendMail sendMail = new MockSendMail();
sendMail.addExpectedMail(expectedMail);
sendMail.send(sentMail);
sendMail.verify(); // 失敗 AssertionFailedException
sendMail = new MockSendMail();
sendMail.addExpectedMail(mockMail);
sendMail.send(sentMail);
sendMail.verify(); // 成功
注: 添付ファイルは比較対象になりません。
| フィールドの概要 | |
static String |
DEFAULT_HOST
デフォルトのSMTPサーバ。 |
static int |
DEFAULT_PORT
デフォルトのポート。 |
static String |
DEFAULT_PROTOCOL
デフォルトのプロトコル。 |
static String |
JIS_CHARSET
ISO-2022-JP |
| コンストラクタの概要 | |
MockSendMail()
コンストラクタ。 |
|
| メソッドの概要 | |
void |
addExpectedMail(Mail expectedMail)
|
void |
addExpectedMail(Mail[] expectedMails)
|
void |
checkEquality(Mail expected,
Mail sent,
int num)
|
String |
getCharset()
エンコーディングに使用する文字コードを返します。 |
String |
getHost()
セットされたSMTPサーバのホスト名、またはIPアドレスを返します。 |
MimeMessage[] |
getMimeMessages()
送信されたメールのMimeMessageインスタンスを返します。 |
String |
getPassword()
|
int |
getPort()
|
String |
getProtocol()
|
String |
getReturnPath()
|
Mail[] |
getSentMails()
送信されたMailインスタンスを返します。 |
String |
getUsername()
|
void |
initialize()
MockSendMailインスタンスを初期化します。 |
boolean |
isDebug()
デバッグモードが有効になっているか判定します。 |
void |
send(Mail mail)
指定されたメールを送信します。 |
void |
send(Mail[] mails)
指定されたメールを送信します。 |
void |
send(MimeMessage mimeMessage)
指定されたMimeMessageを送信します。 |
void |
send(MimeMessage[] mimeMessages)
指定されたMimeMessageを送信します。 |
void |
setCharset(String charset)
メールの件名や本文のエンコーディングに使用する文字コードを指定します。 |
void |
setDebug(boolean debug)
デバッグモード(コンソールにログを出力)を有効にします。 |
void |
setHost(String host)
SMTPサーバのホスト名、またはIPアドレスをセットします。 |
void |
setPassword(String password)
SMTPサーバの接続認証が必要な場合にパスワードをセットします。 |
void |
setPort(int port)
SMTPサーバのポート番号をセットします。 |
void |
setProtocol(String protocol)
|
void |
setReturnPath(String returnPath)
Return-Pathアドレスをセットします。 |
void |
setUsername(String username)
SMTPサーバの接続認証が必要な場合にユーザ名をセットします。 |
protected void |
throwExceptioWithMessage(String name,
String expectedValue,
String sentValue,
int num)
引数の値を受けてエラーメッセージを生成し、AssertionFailedErrorをスローします。 |
void |
verify()
|
| クラス java.lang.Object から継承したメソッド |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| フィールドの詳細 |
public static final String DEFAULT_PROTOCOL
public static final int DEFAULT_PORT
public static final String DEFAULT_HOST
public static final String JIS_CHARSET
| コンストラクタの詳細 |
public MockSendMail()
| メソッドの詳細 |
public void initialize()
public MimeMessage[] getMimeMessages()
public Mail[] getSentMails()
public boolean isDebug()
public void setDebug(boolean debug)
debug - デバッグモードを有効にする場合 truepublic void addExpectedMail(Mail expectedMail)
expectedMail - public void addExpectedMail(Mail[] expectedMails)
expectedMails -
public void verify()
throws AssertionFailedException
AssertionFailedException
public void checkEquality(Mail expected,
Mail sent,
int num)
throws AssertionFailedException
expected - sent -
AssertionFailedException
protected void throwExceptioWithMessage(String name,
String expectedValue,
String sentValue,
int num)
throws AssertionFailedException
name - 一致しなかった項目名expectedValue - 期待値sentValue - 実際値num - N番目のメール
AssertionFailedException - 生成された例外
public void send(Mail mail)
throws MailException
SendMail の記述:
SendMail 内の sendmail - 送信するメールのMailインスタンス
MailException - メール送信に失敗した場合SendMail.send(com.ozacc.mail.Mail)
public void send(Mail[] mails)
throws MailException
SendMail の記述:
SendMail 内の sendmails - 送信するメールのMailインスタンス配列
MailException - メール送信に失敗した場合SendMail.send(com.ozacc.mail.Mail[])
public void send(MimeMessage mimeMessage)
throws MailException
SendMail の記述:
SendMail 内の sendmimeMessage - 送信するメールのMimeMessageインスタンス
MailException - メール送信に失敗した場合SendMail.send(javax.mail.internet.MimeMessage)
public void send(MimeMessage[] mimeMessages)
throws MailException
SendMail の記述:
SendMail 内の sendmimeMessages - 送信するメールのMimeMessageインスタンス配列
MailException - メール送信に失敗した場合SendMail.send(javax.mail.internet.MimeMessage[])public String getCharset()
public void setCharset(String charset)
charset - エンコーディングに使用する文字コードpublic String getHost()
public void setHost(String host)
host - SMTPサーバのホスト名、またはIPアドレスpublic String getPassword()
public void setPassword(String password)
password - SMTPサーバ認証パスワードpublic int getPort()
public void setPort(int port)
port - SMTPサーバのポート番号public String getProtocol()
public void setProtocol(String protocol)
protocol - The protocol to set.public String getReturnPath()
public void setReturnPath(String returnPath)
returnPath - Return-Pathアドレスpublic String getUsername()
public void setUsername(String username)
username - SMTPサーバ認証ユーザ名
|
|||||||||||
| 前のクラス 次のクラス | フレームあり フレームなし | ||||||||||
| 概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド | ||||||||||