javax.mail
public interface UIDFolder
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.
Version: 1.4
See Also: RFC 2060 http://www.ietf.org/rfc/rfc2060.txt
Nested Class Summary | |
---|---|
static class | UIDFolder.FetchProfileItem
A fetch profile item for fetching UIDs. |
Field Summary | |
---|---|
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 start, long end)
Returns the messages in the given range.
|
Message[] | getMessagesByUID(long[] uids)
Returns the messages specified by the given UIDs.
|
long | getUID(Message message)
Returns the UID for the specified message. |
long | getUIDValidity()
Returns the UIDValidity value associated with this folder.
|
getMessages(start, end)
to denote the last UID
in this folder.null
if no such message exists.Parameters: uid the UID of the desired message
end
parameter
to indicate the last available UID.Parameters: start the start UID end the end UID
null
is returned for that entry.
The returned array will be of the same size as the specified UIDs.
Parameters: uids the UIDs
Parameters: message a message in this folder
Throws: NoSuchElementException if the given message is not in this folder
A client should compare this value against a UIDValidity value saved from a previous session to ensure that any cached UIDs are valid.