com.ozacc.mail.fetch
インタフェース FetchMailPro

既知の実装クラスの一覧:
FetchMailProImpl

public interface FetchMailPro

メールサーバからメールを取得する上級インターフェース。
このインターフェースの実装クラスでメールサーバの情報を設定します。

FetchMailインターフェースと異なり、メール取得時に例外が発生しても、 メールサーバとの接続は切断されません。finallyブロックを使用するなりして メールサーバとの接続を確実に切断できるようにすることを推奨します。

このインターフェース実装クラスのインスタンスは、メールサーバとの接続を保持するため、 スレッドセーフではありません。
DIコンテナでの使用の際はシングルトンでインスタンスを取得しないように注意してください。

導入されたバージョン:
1.2
バージョン:
$Id: FetchMailPro.java,v 1.1.2.5 2005/01/29 23:13:37 otsuka Exp $
作成者:
Tomohiro Otsuka
関連項目:
FetchMail

メソッドの概要
 void changeFolder(String folderName)
          指定された名前のフォルダに移動します。
 void connect()
          メールサーバに接続し、「INBOX」フォルダをオープンします。
 void disconnect()
          メールサーバとの接続を切断します。
 ReceivedMail getMail(int num)
          指定されたメッセージ番号のReceivedMailインスタンスを返します。
 int getMailCount()
          現在のフォルダに届いているメール数を返します。
 ReceivedMail[] getMails(boolean delete)
           
 MimeMessage getMessage(int num)
           
 MimeMessage[] getMessages(boolean delete)
           
 boolean isConnected()
          メールサーバと接続しているかどうか判定します。
 

メソッドの詳細

connect

public void connect()
             throws MailException
メールサーバに接続し、「INBOX」フォルダをオープンします。

例外:
MailException - メールサーバとの接続に失敗した場合

disconnect

public void disconnect()
                throws MailException
メールサーバとの接続を切断します。接続されていなければ何も行いません。

例外:
MailException - メールサーバとの接続切断に失敗した場合

getMailCount

public int getMailCount()
                 throws MailException
現在のフォルダに届いているメール数を返します。

戻り値:
現在のフォルダにあるメール数
例外:
MailException

getMail

public ReceivedMail getMail(int num)
                     throws MailException
指定されたメッセージ番号のReceivedMailインスタンスを返します。

パラメータ:
num - メッセージ番号。1始まり。
戻り値:
指定されたメッセージ番号のReceivedMailインスタンス
例外:
MailException

getMails

public ReceivedMail[] getMails(boolean delete)
                        throws MailException
例外:
MailException

getMessage

public MimeMessage getMessage(int num)
                       throws MailException
例外:
MailException

getMessages

public MimeMessage[] getMessages(boolean delete)
                          throws MailException
例外:
MailException

changeFolder

public void changeFolder(String folderName)
                  throws MailException
指定された名前のフォルダに移動します。 フォルダ名は"INBOX/XXXX"のように、INBOXからのパス指定します。

注: このメソッドは、メールサーバがimapサーバの時にのみ使用可能です。

パラメータ:
folderName - 移動先のフォルダ名
例外:
MailException

isConnected

public boolean isConnected()
メールサーバと接続しているかどうか判定します。

戻り値:
接続している場合 true


Copyright © 2004-2005 OZACC. All Rights Reserved.