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

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

public interface FetchMailPro

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

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

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

導入されたバージョン:
1.2
バージョン:
$Id: FetchMailPro.java,v 1.1.2.7 2005/04/10 05:22:24 otsuka Exp $
作成者:
Tomohiro Otsuka
関連項目:
FetchMail

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

メソッドの詳細

connect

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

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

disconnect

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

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

getMailCount

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

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

getMail

ReceivedMail getMail(int num)
                     throws MailException
現在のフォルダにある指定されたメッセージ番号のメールをReceivedMailに変換して返します。 メッセージ番号は1始まりです。

メッセージはサーバから削除されません。

パラメータ:
num - メッセージ番号。1始まり。
戻り値:
指定されたメッセージ番号のReceivedMailインスタンス
例外:
MailException - メール取得に失敗した場合

getMail

ReceivedMail getMail(int num,
                     boolean delete)
                     throws MailException
現在のフォルダにある指定されたメッセージ番号のメールをReceivedMailに変換して返します。 メッセージ番号は1始まりです。 指定した番号のメッセージをサーバから削除するかどうかを指定できます。

パラメータ:
num - メッセージ番号。1始まり。
delete - 指定された番号のメッセージをサーバから削除する場合 true を指定
戻り値:
指定されたメッセージ番号のReceivedMailインスタンス
例外:
MailException - メール取得に失敗した場合

getMails

ReceivedMail[] getMails(boolean delete)
                        throws MailException
現在のフォルダにある全メールをReceivedMailに変換して返します。

パラメータ:
delete - メール取得後にサーバからメールを削除する場合 true
戻り値:
現在のフォルダにある全メールのReceivedMailインスタンス
例外:
MailException - メール取得に失敗した場合

getMessage

javax.mail.internet.MimeMessage getMessage(int num)
                                           throws MailException
現在のフォルダにある指定されたメッセージ番号のメールを返します。 メッセージ番号は1始まりです。

パラメータ:
num - メッセージ番号。1始まり。
戻り値:
指定された番号のMimeMessageインスタンス
例外:
MailException - メール取得に失敗した場合
関連項目:
Folder.getMessage(int)

getMessages

javax.mail.internet.MimeMessage[] getMessages(boolean delete)
                                              throws MailException
現在のフォルダにある全メールを返します。

パラメータ:
delete - メール取得後にサーバからメールを削除する場合 true
戻り値:
現在のフォルダにある全メールのMimeMessageインスタンス
例外:
MailException - メール取得に失敗した場合

changeFolder

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

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

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

isConnected

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

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


Copyright © 2004-2006 OZACC. All Rights Reserved.