com.sun.mail.pop3
クラス POP3Store

java.lang.Object
  上位を拡張 javax.mail.Service
      上位を拡張 javax.mail.Store
          上位を拡張 com.sun.mail.pop3.POP3Store
直系の既知のサブクラス:
POP3SSLStore

public class POP3Store
extends Store

POP3 Message Store です。 一つの "INBOX" フォルダだけを含んでいます。 POP3 プロトコルプロバイダの詳細については、 jp.sourceforge.livez.mail.pop3 パッケージドキュメンテーションを参照して下さい。


フィールドの概要
 
クラス javax.mail.Service から継承されたフィールド
debug, session, url
 
コンストラクタの概要
POP3Store(Session session, URLName url)
          コンストラクタです。
POP3Store(Session session, URLName url, String name, int port, boolean isSSL)
          コンストラクタです。
 
メソッドの概要
 void close()
          このサービスを閉じ、接続を終了させます。
protected  void finalize()
          キューがガベージコレクト可能になるように、イベントディスパッチャスレッドを停止します。
 Folder getDefaultFolder()
          Store によりユーザに提示されるデフォルトの名前空間の 'root' を表す Folder オブジェクトを返します。
 Folder getFolder(String name)
          "INBOX" という名前のみサポートします。
 Folder getFolder(URLName url)
          指定された URLName に対応する、閉じた Folder オブジェクトを返します。
 boolean isConnected()
          Check whether this store is connected.
protected  boolean protocolConnect(String host, int portNum, String user, String passwd)
          サービス実装はこのメソッドをオーバーライドし、 実際のプロトコル固有の接続を試行しなければなりません。
 
クラス javax.mail.Store から継承されたメソッド
addFolderListener, addStoreListener, getPersonalNamespaces, getSharedNamespaces, getUserNamespaces, notifyFolderListeners, notifyFolderRenamedListeners, notifyStoreListeners, removeFolderListener, removeStoreListener
 
クラス javax.mail.Service から継承されたメソッド
addConnectionListener, connect, connect, connect, connect, getURLName, notifyConnectionListeners, queueEvent, removeConnectionListener, setConnected, setURLName, toString
 
クラス java.lang.Object から継承されたメソッド
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

コンストラクタの詳細

POP3Store

public POP3Store(Session session,
                 URLName url)
コンストラクタです。


POP3Store

public POP3Store(Session session,
                 URLName url,
                 String name,
                 int port,
                 boolean isSSL)
コンストラクタです。

メソッドの詳細

protocolConnect

protected boolean protocolConnect(String host,
                                  int portNum,
                                  String user,
                                  String passwd)
                           throws MessagingException
クラス Service の記述:
サービス実装はこのメソッドをオーバーライドし、 実際のプロトコル固有の接続を試行しなければなりません。 connect メソッドのデフォルトの実装は、 必要に応じてこのメソッドを呼び出します。

認証の為にユーザ名またはパスワードが必要だが、 対応するパラメータが null の場合、protocolConnect メソッドは false を返さなければなりません。 connect メソッドは必要に応じてユーザに入力を要求し、 不足した情報を供給します。 又、供給されたユーザ名又はパスワードの為に認証が失敗した場合、 このメソッドは false を返すことがあります。 認証の障害時に、このメソッドは AuthenticationFailedException をスローする事もあります。 この例外には、障害に関する詳細記述した String メッセージが含まれる事があります。

protocolConnect メソッドは例外をスローし、 認証に関連しない障害を報告しなければなりません。 例として、無効なホスト名又はポート番号、認証処理中の接続切断、 サーバの停止等があります。

オーバーライド:
クラス Service 内の protocolConnect
パラメータ:
host - 接続先のホスト名
portNum - 使用するポート (-1 はデフォルトポートの使用を意味する)
user - ログインするユーザ名
passwd - ユーザのパスワード
戻り値:
接続が成功した場合は true、認証が失敗した場合は false
例外:
AuthenticationFailedException - 認証の障害の場合
MessagingException - 認証以外の障害の場合

isConnected

public boolean isConnected()
Check whether this store is connected. Override superclass method, to actually ping our server connection.

オーバーライド:
クラス Service 内の isConnected
戻り値:
サービスが接続されている場合は true、接続されていない場合は false

close

public void close()
           throws MessagingException
クラス Service の記述:
このサービスを閉じ、接続を終了させます。 クローズの ConnectionEvent は全ての ConnectionListener に配信されます。 このサービスに属する全ての Messaging コンポーネント (Folder、Message 等) は、 このサービスが閉じた後無効になります。 このメソッドが MessagingException のスローにより異常終了した場合でも、 このサービスは閉じられます。

この実装は setConnected(false) を使用して、 このサービスの接続状態を false に設定します。 その後、クローズの ConnectionEvent を全ての登録済み ConnectionListener に送信します。 実装固有の終了処理を行う為にこのメソッドをオーバーライドするサブクラスは、 最後の手順としてこのメソッドを呼び出し、イベント通知を確実にしなければなりません。 恐らく finally 節に super.close() への呼び出しを含める事が考えられます。

オーバーライド:
クラス Service 内の close
例外:
MessagingException - クローズ中のエラーの場合
関連項目:
ConnectionEvent

getDefaultFolder

public Folder getDefaultFolder()
                        throws MessagingException
クラス Store の記述:
Store によりユーザに提示されるデフォルトの名前空間の 'root' を表す Folder オブジェクトを返します。

定義:
クラス Store 内の getDefaultFolder
戻り値:
ルート Folder
例外:
MessagingException

getFolder

public Folder getFolder(String name)
                 throws MessagingException
"INBOX" という名前のみサポートします。

定義:
クラス Store 内の getFolder
パラメータ:
name - Folder の名前。 一部の Store において、名前が階層区切り文字で始まる場合、絶対パスとなることがあります。 そうでない場合は、名前はこの名前空間の 'ルート' への相対名と解釈されます。
戻り値:
Folder オブジェクト
例外:
MessagingException
関連項目:
Folder.exists(), Folder.create(int)

getFolder

public Folder getFolder(URLName url)
                 throws MessagingException
クラス Store の記述:
指定された URLName に対応する、閉じた Folder オブジェクトを返します。 指定された URLName 中に指定されたストアは、この Store オブジェクトを参照する必要があります。

このメソッドの実装は、URLName 上で getFile() メソッドを使用して 実際のフォルダの名前を取得し、その名前を使用してフォルダを作成する事ができます。

定義:
クラス Store 内の getFolder
パラメータ:
url - フォルダを示す URLName
戻り値:
Folder オブジェクト
例外:
MessagingException
関連項目:
URLName

finalize

protected void finalize()
                 throws Throwable
クラス Service の記述:
キューがガベージコレクト可能になるように、イベントディスパッチャスレッドを停止します。

オーバーライド:
クラス Service 内の finalize
例外:
Throwable