|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A folder that supports permanent references to messages in the form of a long integer (i.e. an IMAP folder). These UIDs survive the closure and reopening of the message store and session context.
UIDs are assigned to messages in a folder in a strictly ascending fashion; that is, if the message number of message x is greater than the message number of message y, its UID will also be greater than that of y.
2060 http://www.ietf.org/rfc/rfc2060.txt
Nested Class Summary | |
static class |
UIDFolder.FetchProfileItem
A fetch profile item for fetching UIDs. |
Field Summary | |
static long |
LASTUID
This special value can be used as the end parameter in getMessages(start, end) to denote the last UID
in this folder. |
Method Summary | |
Message |
getMessageByUID(long uid)
Returns the message corresponding to the given UID, or null if no such message exists. |
Message[] |
getMessagesByUID(long[] uids)
Returns the messages specified by the given UIDs. |
Message[] |
getMessagesByUID(long start,
long end)
Returns the messages in the given range. |
long |
getUID(Message message)
Returns the UID for the specified message. |
long |
getUIDValidity()
Returns the UIDValidity value associated with this folder. |
Field Detail |
public static final long LASTUID
getMessages(start, end)
to denote the last UID
in this folder.
Method Detail |
public long getUIDValidity() throws MessagingException
A client should compare this value against a UIDValidity value saved from a previous session to ensure that any cached UIDs are valid.
MessagingException
public Message getMessageByUID(long uid) throws MessagingException
null
if no such message exists.
uid
- the UID of the desired message
MessagingException
public Message[] getMessagesByUID(long start, long end) throws MessagingException
end
parameter
to indicate the last available UID.
start
- the start UIDend
- the end UID
MessagingException
public Message[] getMessagesByUID(long[] uids) throws MessagingException
null
is returned for that entry.
The returned array will be of the same size as the specified UIDs.
uids
- the UIDs
MessagingException
public long getUID(Message message) throws MessagingException
message
- a message in this folder
java.util.NoSuchElementException
- if the given message is not in this
folder
MessagingException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |