|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface for objects representing the record of a folder on an IMAP host.
Method Summary | |
java.lang.String |
getAbsoluteName()
Returns the absolute name of this mailbox. |
int |
getExists()
Indicates number of messages in folder |
java.lang.String |
getFullName()
Returns the full name, including namespace, of this mailbox. |
int |
getHighestUid()
Returns current highest assigned uid value |
int |
getRecent()
Indicates no of messages with \Recent flag set |
int |
getUidValidity()
Returns current uid validity value |
int |
getUnseen(java.lang.String user)
Indicates the number of unseen messages for the specified user. |
java.lang.String |
getUser()
Returns the user in whose namespace the mailbox existed. |
boolean |
hasLookupRights(java.lang.String user)
Indicates if given user has lookup rights for this mailbox. |
boolean |
hasReadRights(java.lang.String user)
Indicates if given user has read rights for this mailbox. |
boolean |
isDeleted()
Returns whether mailbox has been deleted. |
boolean |
isMarked()
Indicates if the mailbox is marked. |
boolean |
isNameInUse()
Returns unavailability of name for a new mailbox. |
boolean |
isNotSelectableByAnyone()
|
boolean |
isSelectable(java.lang.String user)
A folder is selectable by a given user if both it is not NotSelectableByAnyone and the named user has read rights. |
void |
setDeleted(boolean state)
Records if the corresponding mailbox has been deleted. |
void |
setExists(int num)
Set number of messages in this folder |
void |
setHighestUid(int uid)
Records the highest assigned Unique Identifier Value for this mailbox. |
void |
setLookupRights(java.util.Set users)
Record which users have LookupRights. |
void |
setMarked(boolean mark)
Record if mailbox is marked. |
void |
setNameInUse(boolean state)
Records if this mailbox name is currently in use. |
void |
setNotSelectableByAnyone(boolean state)
Mark this mailbox as not selectable by anyone. |
void |
setReadRights(java.util.Set users)
Record which users have ReadRights. |
void |
setRecent(int num)
Set number of messages in this folder with Recent flag set |
void |
setUidValidity(int uidValidity)
Records the Unique Identifier Validity Value for this mailbox. |
void |
setUnseenbyUser(java.util.Map unseen)
Set map of users versus number of messages in this folder without \Seen flag set for them |
Method Detail |
public java.lang.String getFullName()
public java.lang.String getUser()
user
- String a user.An empty string indicates that the
mailbox name is absolute.public java.lang.String getAbsoluteName()
public void setNameInUse(boolean state)
state
- boolean true when mailbox created, false when name no
longer in use.public boolean isNameInUse()
public void setDeleted(boolean state)
state
- boolean true when mailbox deleted, false when createdpublic boolean isDeleted()
public void setUidValidity(int uidValidity)
uidValidity
- int the uid validity value must be incremented if
the current uid values overlap uid values of this or a previous
incarnation of the mailbox.public int getUidValidity()
public void setHighestUid(int uid)
uid
- int the highest uid assigned to a message in this mailbox.public int getHighestUid()
public void setLookupRights(java.util.Set users)
users
- Set of Strings, one per user with Lookup rightspublic boolean hasLookupRights(java.lang.String user)
public void setReadRights(java.util.Set users)
users
- Set of Strings, one per user with read rightspublic boolean hasReadRights(java.lang.String user)
public void setMarked(boolean mark)
public boolean isMarked()
public void setNotSelectableByAnyone(boolean state)
state
- true if folder is not selectable by anyonepublic boolean isNotSelectableByAnyone()
public boolean isSelectable(java.lang.String user)
public void setExists(int num)
public int getExists()
public void setRecent(int num)
public int getRecent()
public void setUnseenbyUser(java.util.Map unseen)
public int getUnseen(java.lang.String user)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |