|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
public interface UIDFolder
UIDFolder
インタフェースは、"disconnected" モードの操作をサポートする Folder が実装します。
そのような実装では、フォルダ中のメッセージに対して一意の ID を提供します。
このインタフェースは、disconnected 操作をサポートするための IMAP モデルをベースにしています。
UID (一意の ID) は正の long 値で、特定のフォルダ中の各メッセージに割り当てられます。 UID は、メールボックスにおいて必ず昇順に割り当てられます。 つまり、各メッセージがメールボックスに追加される時、既存のメッセージよりも大きな UID が割り当てられます。 UID はセッションをまたがって持続します。これによりクライアントは、 前のセッションの状態をサーバと再度同期を取る事ができます。
全てのメールボックスと関連付けられるのは、UID の妥当性値です。 前のセッションの UID をこのセッションで続けて使用できない場合、 UID 妥当性値は前のセッションで使用された値より大きい必要があります。
詳細については、RFC 2060 を参照して下さい。
入れ子のクラスの概要 | |
---|---|
static class |
UIDFolder.FetchProfileItem
UID を取り出すフェッチプロファイル項目です。 |
フィールドの概要 | |
---|---|
static long |
LASTUID
これは、このフォルダ中の最後の UID を示す為に、 getMessages(start, end) 中の end パラメータとして使用できる特殊な値です。 |
メソッドの概要 | |
---|---|
Message |
getMessageByUID(long uid)
指定された UID に対応する Message を取得します。 |
Message[] |
getMessagesByUID(long[] uids)
UID の配列により指定された Message を取得します。 |
Message[] |
getMessagesByUID(long start,
long end)
範囲が指定された Message を取得します。 |
long |
getUID(Message message)
指定されたメッセージの UID を取得します。 |
long |
getUIDValidity()
このフォルダに関連した UIDValidity 値を返します。 |
フィールドの詳細 |
---|
static final long LASTUID
getMessages(start, end)
中の end
パラメータとして使用できる特殊な値です。
getMessagesByUID(long, long)
,
定数フィールド値メソッドの詳細 |
---|
long getUIDValidity() throws MessagingException
一般にクライアントは、この値を、前のセッションで保存された UIDValidity 値と比較し、 キャッシュされた UID がすべて有効である事を確認します。
MessagingException
Message getMessageByUID(long uid) throws MessagingException
null
が返されます。
uid
- 希望するメッセージの UID
null
が返されます。
MessagingException
Message[] getMessagesByUID(long start, long end) throws MessagingException
end
パラメータとして使用可能です。
start
- 開始 UIDend
- 終了 UID
MessagingException
LASTUID
Message[] getMessagesByUID(long[] uids) throws MessagingException
null
が返されます。
返される配列のサイズは、指定された UID の配列のサイズと同じになります。
又、無効な UID を示す為に、null
エントリが配列中に存在する場合があります。
uids
- UID の配列
MessagingException
long getUID(Message message) throws MessagingException
message
- このフォルダからのメッセージ
NoSuchElementException
- 指定された Message がこの Folder 中にない場合
MessagingException
|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |