src/java/com/ozacc/mail/fetch/FetchMail.java

   1 package com.ozacc.mail.fetch;\r
   2 \r
   3 import com.ozacc.mail.MailException;\r
   4 \r
   5 /**\r
   6  * メールサーバからメールを取得するインターフェース。<br>\r
   7  * このインターフェースの実装クラスでメールサーバの情報を設定します。\r
   8  * <p>\r
   9  * getMails()メソッドはスレッドセーフです。メソッドを呼び出すとメールサーバに接続し、\r
  10  * メソッド終了時にサーバとの接続を切断します。\r
  11  * \r
  12  * @since 1.2\r
  13  * @author Tomohiro Otsuka\r
  14  * @version $Id: FetchMail.java,v 1.1.2.5 2004/10/27 19:41:35 otsuka Exp $\r
  15  */\r
  16 public interface FetchMail {\r
  17 \r
  18         /**\r
  19          * メールサーバからメールを受信し、ReceivedMailインスタンスに変換して返します。<br>\r
  20          * 受信したメールは、メールサーバに残されます。\r
  21          * <p>\r
  22          * このメソッドを呼び出すとメールサーバに接続します。メールを受信した後、メールサーバとの接続を切断します。\r
  23          * <p>\r
  24          * メールサーバがimapサーバの場合、一度受信したメールには既読フラグ(SEENフラグ)が付けられます。\r
  25          * \r
  26          * @return 受信したメールのReceivedMailインスタンス配列\r
  27          * @throws MailException\r
  28          */\r
  29         ReceivedMail[] getMails() throws MailException;\r
  30 \r
  31         /**\r
  32          * メールサーバからメールを受信し、ReceivedMailインスタンスに変換して返します。<br>\r
  33          * deleteパラメータで、受信時にメールサーバからメールを削除するか残すかを指定します。\r
  34          * <p>\r
  35          * このメソッドを呼び出すとメールサーバに接続します。メールを受信した後、メールサーバとの接続を切断します。\r
  36          * <p>\r
  37          * メールサーバがimapサーバの場合、一度受信したメールには既読フラグ(SEENフラグ)が付けられます。\r
  38          * \r
  39          * @param delete 受信時にメールサーバからメールを削除する場合 true\r
  40          * @return 受信したメールのReceivedMailインスタンス配列\r
  41          * @throws MailException\r
  42          */\r
  43         ReceivedMail[] getMails(boolean delete) throws MailException;\r
  44 \r
  45 }