View Javadoc

    1   package com.ozacc.mail.fetch;
    2
    3   import javax.mail.internet.MimeMessage;
    4
    5   import com.ozacc.mail.MailException;
    6
    7   /***
    8    * メールサーバからメールを取得する上級インターフェース。<br>
    9    * このインターフェースの実装クラスでメールサーバの情報を設定します。
    10   * <p>
    11   * <code>FetchMail</code>インターフェースと異なり、メール取得時に例外が発生しても、
    12   * メールサーバとの接続は切断されません。<code>finally</code>ブロックを使用するなりして
    13   * メールサーバとの接続を確実に切断できるようにすることを推奨します。
    14   * <p>
    15   * このインターフェース実装クラスのインスタンスは、メールサーバとの接続を保持するため、
    16   * スレッドセーフではありません。<br>
    17   * DIコンテナでの使用の際はシングルトンでインスタンスを取得しないように注意してください。
    18   *
    19   * @see FetchMail
    20   * @since 1.2
    21   * @author Tomohiro Otsuka
    22   * @version $Id: FetchMailPro.java,v 1.1.2.4 2004/10/27 19:41:19 otsuka Exp $
    23   */
    24  public interface FetchMailPro {
    25
    26  	/***
    27  	 * メールサーバに接続し、「INBOX」フォルダをオープンします。
    28  	 *
    29  	 * @throws MailException メールサーバとの接続に失敗した場合
    30  	 */
    31  	void connect() throws MailException;
    32
    33  	/***
    34  	 * メールサーバとの接続を切断します。
    35  	 *
    36  	 * @throws MailException メールサーバとの接続切断に失敗した場合
    37  	 */
    38  	void disconnect() throws MailException;
    39
    40  	/***
    41  	 * 現在のフォルダに届いているメール数を返します。
    42  	 *
    43  	 * @return 現在のフォルダにあるメール数
    44  	 * @throws MailException
    45  	 */
    46  	int getMailCount() throws MailException;
    47
    48  	/***
    49  	 * 指定されたメッセージ番号の<code>ReceivedMail</code>インスタンスを返します。
    50  	 *
    51  	 * @param num メッセージ番号。1始まり。
    52  	 * @return 指定されたメッセージ番号のReceivedMailインスタンス
    53  	 * @throws MailException
    54  	 */
    55  	ReceivedMail getMail(int num) throws MailException;
    56
    57  	ReceivedMail[] getMails(boolean delete) throws MailException;
    58
    59  	MimeMessage getMessage(int num) throws MailException;
    60
    61  	MimeMessage[] getMessages(boolean delete) throws MailException;
    62
    63  	/***
    64  	 * 指定された名前のフォルダに移動します。
    65  	 * フォルダ名は"INBOX/XXXX"のように、INBOXからのパス指定します。
    66  	 * <p>
    67  	 * <strong>注:</strong> このメソッドは、メールサーバがimapサーバの時にのみ使用可能です。
    68  	 *
    69  	 * @param folderName 移動先のフォルダ名
    70  	 * @throws MailException
    71  	 */
    72  	void changeFolder(String folderName) throws MailException;
    73
    74  	/***
    75  	 * メールサーバと接続しているかどうか判定します。
    76  	 *
    77  	 * @return 接続している場合 true
    78  	 */
    79  	boolean isConnected();
    80  }