com.ozacc.mail.fetch.FetchMail Maven / Gradle / Ivy
Show all versions of ozacc-mail Show documentation
package com.ozacc.mail.fetch;
import com.ozacc.mail.MailException;
/**
* メールサーバからメールを取得するインターフェース。
* このインターフェースの実装クラスでメールサーバの情報を設定します。
*
* getMails()メソッドはスレッドセーフです。メソッドを呼び出すとメールサーバに接続し、
* メソッド終了時にサーバとの接続を切断します。
*
* @since 1.2
* @author Tomohiro Otsuka
* @version $Id: FetchMail.java,v 1.1.2.5 2004/10/27 19:41:35 otsuka Exp $
*/
public interface FetchMail {
/**
* メールサーバからメールを受信し、ReceivedMailインスタンスに変換して返します。
* 受信したメールは、メールサーバに残されます。
*
* このメソッドを呼び出すとメールサーバに接続します。メールを受信した後、メールサーバとの接続を切断します。
*
* メールサーバがimapサーバの場合、一度受信したメールには既読フラグ(SEENフラグ)が付けられます。
*
* @return 受信したメールのReceivedMailインスタンス配列
* @throws MailException
*/
ReceivedMail[] getMails() throws MailException;
/**
* メールサーバからメールを受信し、ReceivedMailインスタンスに変換して返します。
* deleteパラメータで、受信時にメールサーバからメールを削除するか残すかを指定します。
*
* このメソッドを呼び出すとメールサーバに接続します。メールを受信した後、メールサーバとの接続を切断します。
*
* メールサーバがimapサーバの場合、一度受信したメールには既読フラグ(SEENフラグ)が付けられます。
*
* @param delete 受信時にメールサーバからメールを削除する場合 true
* @return 受信したメールのReceivedMailインスタンス配列
* @throws MailException
*/
ReceivedMail[] getMails(boolean delete) throws MailException;
}