com.ozacc.mail.SendMailPro Maven / Gradle / Ivy

package com.ozacc.mail;

import javax.mail.internet.MimeMessage;

/**
 * SMTPサーバとの接続、切断を任意のタイミングで行いたい場合に使用するSendMailインターフェース。
 * 
 * 大量メール配信で、MailやMimeMessageの配列を用意するとメモリを圧迫してしまう場合などに使用します。

 * 接続のクローズを忘れないように注意してください。
 * 
 * このインターフェース実装クラスのインスタンスは、メールサーバとの接続を保持するため、
 * スレッドセーフではありません。

 * DIコンテナでの使用の際はシングルトンでインスタンスを取得しないように注意してください。
 * 
 * @since 1.0
 * @author Tomohiro Otsuka
 * @version $Id: SendMailPro.java,v 1.2.2.1 2004/11/25 08:02:27 otsuka Exp $
 */
public interface SendMailPro {

	/**
	 * SMTPサーバに接続します。
	 * 
	 * @throws MailException
	 */
	void connect() throws MailException;

	/**
	 * SMTPサーバとの接続をクローズします。
	 * 接続していない時にこのメソッドを呼んでも何も行いません。
	 * 
	 * @throws MailException
	 */
	void disconnect() throws MailException;

	/**
	 * 指定されたMimeMessageを送信します。SMTPサーバに接続していない場合は例外をスローします。
	 * 
	 * @param mimeMessage
	 * @throws MailException
	 */
	void send(MimeMessage mimeMessage) throws MailException;

	/**
	 * 指定されたMailを送信します。SMTPサーバに接続していない場合は例外をスローします。
	 * 
	 * @param mail
	 * @throws MailException
	 */
	void send(Mail mail) throws MailException;

}