|
||||||||||
| 前のクラス 次のクラス | フレームあり フレームなし | |||||||||
| 概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド | |||||||||
java.lang.Objectjavax.mail.Folder
com.sun.mail.pop3.POP3Folder
public final class POP3Folder
POP3 のフォルダです("INBOX" フォルダだけです)。 POP3 プロトコルプロバイダの詳細に関しては、 jp.sourceforge.livez.mail.pop3 パッケージのドキュメントを参照して下さい。
| フィールドの概要 |
|---|
| クラス javax.mail.Folder から継承されたフィールド |
|---|
HOLDS_FOLDERS, HOLDS_MESSAGES, mode, READ_ONLY, READ_WRITE, store |
| メソッドの概要 | |
|---|---|
void |
appendMessages(Message[] msgs)
Always throws MethodNotSupportedException
because the POP3 protocol doesn't support appending messages. |
void |
close(boolean expunge)
この Folder を閉じます。 |
boolean |
create(int type)
常に false を返します。 |
protected POP3Message |
createMessage(Folder f,
int msgno)
|
boolean |
delete(boolean recurse)
POP3 プロトコルは、INBOX が削除されるのを許可しないので、 常に MethodNotSupportedException をスローします。 |
boolean |
exists()
"INBOX" フォルダでは常に true です。 |
Message[] |
expunge()
Always throws MethodNotSupportedException
because the POP3 protocol doesn't support expunging messages
without closing the folder; call the close method
with the expunge argument set to true
instead. |
void |
fetch(Message[] msgs,
FetchProfile fp)
Prefetch information about POP3 messages. |
protected void |
finalize()
Close the folder when we're finalized. |
Folder |
getFolder(String name)
POP3 フォルダはサブフォルダを含む事ができないので常に MessagingException をスローします。 |
String |
getFullName()
この Folder の完全な名前を返します。 |
Message |
getMessage(int msgno)
指定されたメッセージ番号に対応する Message オブジェクトを取得します。 |
int |
getMessageCount()
Will not change while the folder is open because the POP3 protocol doesn't support notification of new messages arriving in open folders. |
String |
getName()
この Folder の名前を返します。 |
Folder |
getParent()
このフォルダの親フォルダを返します。 |
Flags |
getPermanentFlags()
POP3 プロトコルはどの様な永久フラグもサポートしないので、 常に空の Flags オブジェクトを返します。 |
char |
getSeparator()
POP3 では階層構造をサポートしないので常に NUL 文字を返します。 |
int |
getSize()
Return the size of this folder, as was returned by the POP3 STAT command when this folder was opened. |
int[] |
getSizes()
POP3 LIST コマンドによって返される、このフォルダの全てのメッセージのサイズを返します。 |
int |
getType()
常に Folder.HOLDS_MESSAGES を返します。 |
String |
getUID(Message msg)
Return the unique ID string for this message, or null if not available. |
boolean |
hasNewMessages()
常に false を返します。 |
boolean |
isOpen()
この Folder が 'open' 状態にあるかどうかを示します。 |
Folder[] |
list(String pattern)
POP3 フォルダはサブフォルダを含む事ができないので、 常に MessagingException を投げます。 |
InputStream |
listCommand()
Return the raw results of the POP3 LIST command with no arguments. |
protected void |
notifyMessageChangedListeners(int type,
Message m)
全ての MessageChangedListener に通知します。 |
void |
open(int mode)
このフォルダが "INBOX" と命名されない場合、 FolderNotFoundException をスローします。 |
boolean |
renameTo(Folder f)
POP3 プロトコルは、複数フォルダをサポートしないので、 常に MethodNotSupportedException をスローします。 |
| クラス java.lang.Object から継承されたメソッド |
|---|
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| メソッドの詳細 |
|---|
public String getName()
Folder の記述: このメソッドは閉じた Folder 上で呼び出すことができます。
Folder 内の getNamepublic String getFullName()
Folder の記述: このメソッドは閉じた Folder 上で呼び出す事ができます。
Folder 内の getFullNamepublic Folder getParent()
Folder の記述: Folder オブジェクトはキャッシュされないので、このメソッドを呼び出すと、 新規の異なる Folder オブジェクトが返されます。
Folder 内の getParentpublic boolean exists()
Folder 内の existsFolder.create(int)
public Folder[] list(String pattern)
throws MessagingException
MessagingException を投げます。
Folder 内の listpattern - 一致パターン
MessagingException - 常にFolder.listSubscribed(java.lang.String)public char getSeparator()
Folder 内の getSeparatorpublic int getType()
Folder 内の getTypeFolder.HOLDS_FOLDERS,
Folder.HOLDS_MESSAGES
public boolean create(int type)
throws MessagingException
Folder 内の createtype - このフォルダの型
MessagingExceptionFolder.HOLDS_FOLDERS,
Folder.HOLDS_MESSAGES,
FolderEvent
public boolean hasNewMessages()
throws MessagingException
Folder 内の hasNewMessagesFolderNotFoundException - このフォルダが存在しない場合
MessagingException
public Folder getFolder(String name)
throws MessagingException
MessagingException をスローします。
Folder 内の getFoldername - Folder の名前
MessagingException - 常に
public boolean delete(boolean recurse)
throws MessagingException
MethodNotSupportedException をスローします。
Folder 内の deleteMethodNotSupportedException - 常に
FolderNotFoundException - このフォルダが存在しない場合
MessagingExceptionFolderEvent
public boolean renameTo(Folder f)
throws MessagingException
MethodNotSupportedException をスローします。
Folder 内の renameTof - この Folder の新しい名前を表すフォルダ
MethodNotSupportedException - 常に
FolderNotFoundException - このフォルダが存在しない場合
MessagingExceptionFolderEvent
public void open(int mode)
throws MessagingException
FolderNotFoundException をスローします。
Folder 内の openmode - Folder READ_ONLY または READ_WRITE を開く
FolderNotFoundException - INBOX がない場合
AuthenticationException - 認証に失敗した場合
MessagingException - その他の場合Folder.READ_ONLY,
Folder.READ_WRITE,
Folder.getType(),
ConnectionEvent
public void close(boolean expunge)
throws MessagingException
Folder の記述: この Folder 上に登録されている全ての ConnectionListener に CLOSED ConnectionEvent が配信されます。 MessagingException のスローにより、このメソッドが異常終了した場合でもフォルダは閉じられます。
Folder 内の closeexpunge - このフラグが true の場合、全ての削除メッセージを消去します。
MessagingExceptionConnectionEventpublic boolean isOpen()
Folder の記述:
Folder 内の isOpenpublic Flags getPermanentFlags()
Flags オブジェクトを返します。
Folder 内の getPermanentFlags
public int getMessageCount()
throws MessagingException
Folder 内の getMessageCountFolderNotFoundException - このフォルダが存在しない場合
MessagingException
public Message getMessage(int msgno)
throws MessagingException
Folder の記述: Message オブジェクトは、オンデマンドで満たされる実際のメッセージへの軽量な参照です。 従って、Folder 実装は軽量な Message オブジェクトを提供する必要があります。
Folder オブジェクトと異なり、同じメッセージ番号を使用して繰り返し getMessage を呼び出した場合、 このフォルダで消去されたメッセージがない限り、同じ Message オブジェクトが返されます。
フォルダが消去されると、セッション中にメッセージ番号が変更になる事がある為、 クライアントはメッセージへの参照としてメッセージ番号を使用するべきではありません。 代わりに Message オブジェクトを使用して下さい。
Folder 内の getMessagemsgno - メッセージ番号
FolderNotFoundException - このフォルダが存在しない場合
MessagingExceptionFolder.getMessageCount(),
Folder.fetch(javax.mail.Message[], javax.mail.FetchProfile)
protected POP3Message createMessage(Folder f,
int msgno)
public void appendMessages(Message[] msgs)
throws MessagingException
MethodNotSupportedException
because the POP3 protocol doesn't support appending messages.
Folder 内の appendMessagesmsgs - 追加される Message の配列
MethodNotSupportedException - 常に
FolderNotFoundException - このフォルダが存在しない場合
MessagingException - 追加が失敗した場合
public Message[] expunge()
throws MessagingException
MethodNotSupportedException
because the POP3 protocol doesn't support expunging messages
without closing the folder; call the close method
with the expunge argument set to true
instead.
Folder 内の expungeMethodNotSupportedException - 常に
FolderNotFoundException - このフォルダが存在しない場合
MessagingExceptionMessage.isExpunged(),
MessageCountEvent
public void fetch(Message[] msgs,
FetchProfile fp)
throws MessagingException
UIDFolder.FetchProfileItem.UID,
POP3 UIDs for all messages in the folder are fetched using the POP3
UIDL command.
If the FetchProfile contains FetchProfile.Item.ENVELOPE,
the headers and size of all messages are fetched using the POP3 TOP
and LIST commands.
Folder 内の fetchmsgs - これらのメッセージのフェッチ項目fp - FetchProfile
MessagingException
public String getUID(Message msg)
throws MessagingException
MessagingExceptionpublic int getSize()
IllegalStateException - フォルダが開かれていない場合
public int[] getSizes()
throws MessagingException
IllegalStateException - if the folder isn't open
MessagingException
public InputStream listCommand()
throws MessagingException,
IOException
IllegalStateException - if the folder isn't open
MessagingException
IOException
protected void finalize()
throws Throwable
Folder 内の finalizeThrowable
protected void notifyMessageChangedListeners(int type,
Message m)
Folder の記述: 提供される実装は、イベントを内部イベントキューに入れます。 イベントディスパッチャスレッドはキューからイベントを出し、 登録された MessageChangedListener にディスパッチします。 イベントディスパッチは別個のスレッドで起こる為、デッドロック問題を防ぎます。
Folder 内の notifyMessageChangedListeners
|
||||||||||
| 前のクラス 次のクラス | フレームあり フレームなし | |||||||||
| 概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド | |||||||||