| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface UIDFolder
The 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 | |
---|---|
static class |
A fetch profile item for fetching UIDs. |
Field Summary | |
---|---|
static long |
LASTUID
This is a special value that can be used as the end
parameter in getMessagesByUID(start, end) , to denote the
UID of the last message in the folder. |
Method Summary | |
---|---|
Message |
getMessageByUID(long uid) Get the Message corresponding to the given UID. |
Message[] |
getMessagesByUID(long start, long end) Get the Messages specified by the given range. |
Message[] |
getMessagesByUID(long[] uids) Get the Messages specified by the given array of UIDs. |
long |
Get the UID for the specified message. |
long |
Returns the UIDValidity value associated with this folder. |
Field Detail |
---|
public static final long LASTUID
end
parameter in getMessagesByUID(start, end)
, to denote the
UID of the last message in the folder.
Method Detail |
---|
public Message getMessageByUID(long uid) throws MessagingException
null
is returned.
uid
- UID for the desired messagenull
is returned
if no message corresponding to this UID is obtained.MessagingException
public Message[] getMessagesByUID(long start, long end) throws MessagingException
end
parameter
to indicate the UID of the last message in the folder.
start
- start UIDend
- end UIDMessagingException
public Message[] getMessagesByUID(long[] uids) throws MessagingException
null
is 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 UIDsMessagingException
public long getUID(Message message) throws MessagingException
message
- Message from this folderMessagingException
public 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.
MessagingException
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |