public interface UIDFolder
UIDFolder interface is implemented by Folders
that can support the "disconnected" mode of operation, by providing
unique-ids for messages in the folder. This interface is based on
the IMAP model for supporting disconnected operation.
A Unique identifier (UID) is a positive long value, assigned to each message in a specific folder. Unique identifiers are assigned in a strictly ascending fashion in the mailbox. That is, as each message is added to the mailbox it is assigned a higher UID than the message(s) which were added previously. Unique identifiers persist across sessions. This permits a client to resynchronize its state from a previous session with the server.
Associated with every mailbox is a unique identifier validity value. If unique identifiers from an earlier session fail to persist to this session, the unique identifier validity value must be greater than the one used in the earlier session.
Refer to RFC 2060 http://www.ietf.org/rfc/rfc2060.txt for more information.
|Nested Class Summary|
A fetch profile item for fetching UIDs.
This is a special value that can be used as the
Get the Message corresponding to the given UID.
Get the Messages specified by the given array of UIDs.
Get the Messages specified by the given range.
Get the UID for the specified message.
Returns the UIDValidity value associated with this folder.
static final long LASTUID
getMessagesByUID(start, end), to denote the UID of the last message in the folder.
long getUIDValidity() throws MessagingException
Clients typically compare this value against a UIDValidity value saved from a previous session to insure that any cached UIDs are not stale.
Message getMessageByUID(long uid) throws MessagingException
uid- UID for the desired message
nullis returned if no message corresponding to this UID is obtained.
Message getMessagesByUID(long start, long end) throws MessagingException
endparameter to indicate the UID of the last message in the folder.
end need not be greater than
the order of the range doesn't matter.
Note also that, unless the folder is empty, use of LASTUID ensures
that at least one message will be returned - the last message in the
start- start UID
end- end UID
Message getMessagesByUID(long uids) throws MessagingException
nullis returned for that entry.
Note that the returned array will be of the same size as the specified
array of UIDs, and
null entries may be present in the
array to indicate invalid UIDs.
uids- array of UIDs
long getUID(Message message) throws MessagingException
message- Message from this folder
java.util.NoSuchElementException- if the given Message is not in this Folder.