ozacc-mail libraryは、Spring FrameworkやSeasar2といったDIコンテナに組み込んで使用できるメール送信ライブラリです。DIコンテナ上での使用を想定していますが、DIコンテナ環境外での使用も可能です。
ozacc-mail library 1.0.1を使用する際は、次のJARファイルをクラスパスに含めてください。
com.ozacc.mail.impl.JDomXMLMailBuilder
を使用する場合]com.ozacc.mail.impl.XMLVelocityMailBuilder
、com.ozacc.mail.impl.JDomXMLMailBuilder
を使用する場合]com.ozacc.mail.impl.XMLVelocityMailBuilder
、com.ozacc.mail.impl.JDomXMLMailBuilder
を使用する場合]次のページからozacc-mail libraryの最新リリースをダウンロードできます。
http://sourceforge.jp/projects/spring-ext/
またMaven用のリモートレポジトリも用意しています。URLは「http://spring-ext.sourceforge.jp/maven/
」です。このURLをmaven.repo.remote
プロパティに設定してください。groupId
、artifactId
は共に「ozacc-mail
」です。
SendMail
は、JavaMail APIをラップし、メール送信のための至極シンプルなインターフェースを提供しています。提供しているメソッド名はたった一つ、send()
です。メールデータを表すcom.ozacc.mail.Mail
インスタンスか、JavaMailのMimeMessage
インスタンスを引数に指定すると、それを送信します。(これらの配列も指定可能です。)
SendMail(SendMailImpl)
は、スレッドセーフな設計になっていますが、呼び出すスレッドの数だけSMTPサーバに接続します。通常の使用では問題にならないはずですが、メールサーバやその設定によっては注意が必要です。
SendMail
の使用方法を、Springと連携させる場合を例にとって説明します。
▼applicationContext.xmlでのBean定義
<beans> <bean id="sendMail" class="com.ozacc.mail.impl.SendMailImpl"> <!-- SMTPサーバ --> <property name="host"><value>smtp.example.com</value></property> </bean> </beans>
▼Javaソース
// Mailインスタンスの生成 Mail mail = new Mail(); mail.setFrom("shop@example.com", "XXXオンラインショップ"); mail.addTo("misaki@foo.com", "伊東美咲さま"); mail.addBcc("order@example.com"); mail.setSubject("ご注文の確認"); mail.setText("お買い上げありがとうございました。\n\nご注文明細・・・"); // SendMailインスタンスの取得 SendMail sendMail = (SendMail)applicationContext.getBean("sendMail"); // メールの送信 sendMail.send(mail);
sendMail.send(mail)
で、何らかの原因で送信に失敗すると、com.ozacc.mail.MailException
がスローされます。MailException
は非チェック例外なので、プログラムの要求に応じてキャッチしてください。
MailBuilder
を使用すると、ファイルに記述されたメールデータからMail
インスタンスを生成できます。
さらに、MailBuilder
インターフェースを継承したVelocityMailBuilder
を使用すると、Velocity
と連携して動的にメールデータを生成し、そのデータからMailインスタンスを生成できます。
現バージョンでは、XMLのメールデータを扱うXMLMailBuilderImpl
クラスが提供されています。ここではその使用方法を、Springと連携させる場合を例にとって説明します。
▼applicationContext.xmlでのBean定義
<beans> <bean id="sendMail" class="com.ozacc.mail.impl.SendMailImpl"> <property name="host"><value>smtp.example.com</value></property> </bean> <bean id="mailBuilder" class="com.ozacc.mail.impl.XMLMailBuilderImpl" /> </beans>
▼Javaソース
// MailBuilderインスタンスの取得 MailBuilder mailBuilder = (MailBuilder)applicationContext.getBean("mailBuilder"); // メールデータXMLファイルのパス (クラスパス上) String path = "/com/example/mail/mail-template.xml"; // Mailインスタンスを生成 Mail mail = mailBuilder.buildMail(path); // SendMailインスタンスの取得 SendMail sendMail = (SendMail)applicationContext.getBean("sendMail"); // メールの送信 sendMail.send(mail);
▼mail-template.xml
<?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE mail PUBLIC "-//OZACC//DTD MAIL//EN" "http://www.ozacc.com/library/dtd/ozacc-mail.dtd"> <mail> <returnPath email="return@example.com" /> <from email="from@example.com" name="差出人" /> <recipients> <to email="to1@example.com" name="宛先1" /> <cc email="cc1@example.com" name="CC1" /> <bcc email="bcc@example.com" /> <cc email="cc2@example.com" /> <to email="to2@example.com" /> </recipients> <replyTo email="reply@example.com" /> <!-- subject(件名)の前後のホワイトスペース(半角スペース、タブ、改行)は削除されます。 --> <subject> 件名 </subject> <!-- body(本文)の前後のホワイトスペース(半角スペース、タブ、改行)は削除されます。 --> <body> 本文 </body> </mail>
DTDで定義されているように、ルート要素<mail>
以外の全要素はオプションです。
例えば<from>
要素だけ含んだXMLからは、from
プロパティだけセットされた
Velocityとの連携については、テストケース(src/test/com/ozacc/mail/impl/JDomXMLMailBuilderTest
)を参照してください。
XMLMailFactoryBean
はSpringと連携している場合にのみ使用可能です。
上述したMailBuilder
を使ってXMLメールデータからMail
インスタンスを生成する場合、XMLファイルのロケーションを示すパスがソース内にハードコーディングされています。一般的にはアプリケーション側で、MailBuilder
のインスタンスとXMLファイルのロケーションパスをプロパティとして保持するクラスを作り、DIコンテナでプロパティを設定するようにします。
Springを使用している場合、このようなクラスを作らずともXMLファイルのロケーションパスをソースから追い出し、コンテナ上でMailインスタンスを生成させることができます。
▼applicationContext.xmlでのBean定義
<beans> <bean id="sendMail" class="com.ozacc.mail.impl.SendMailImpl"> <property name="host"><value>smtp.example.com</value></property> </bean> <bean id="mail" class="com.ozacc.mail.spring.XMLMailFactoryBean"> <!-- メールデータXMLファイルのパス (クラスパス上) --> <property name="classPath"><value>/com/example/mail/mail-template.xml</value></property> </bean> </beans>
▼Javaソース
// Mailインスタンスの生成、取得 Mail mail = (Mail)applicationContext.getBean("mail"); // SendMailインスタンスの取得 SendMail sendMail = (SendMail)applicationContext.getBean("sendMail"); // メールの送信 sendMail.send(mail);
XMLMailFactoryBean
から生成されるMail
インスタンスは、prototype
です。つまりシングルトンではなく、呼び出すたびに新しいMail
インスタンスが生成されます。何かの理由でMail
インスタンスをシングルトンにしたい場合は、XMLMailFactoryBean
のsinglton
プロパティにtrue
をセットするだけです。
XMLMailFactoryBean
では、Velocityと連携させてMail
インスタンスを生成することはできません。