|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.james.imapserver.SimpleFolderRecord
Object representing the record of a folder in an IMAP on an IMAP Host.
Constructor Summary | |
SimpleFolderRecord(java.lang.String mailboxName,
java.lang.String user,
java.lang.String absName)
Constructor Records the full name, including namespace, of this mailbox relative, to a specified user, and the absolute name.. |
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. |
void |
initialize()
|
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 uidV)
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 |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public SimpleFolderRecord(java.lang.String mailboxName, java.lang.String user, java.lang.String absName)
mailboxName
- String mailbox hierarchical name including namespaceuser
- String a user. An empty user parameter indicates that the
mailbox name is absolute.Method Detail |
public void initialize()
initialize
in interface org.apache.avalon.framework.activity.Initializable
public java.lang.String getFullName()
FolderRecord
getFullName
in interface FolderRecord
public java.lang.String getUser()
FolderRecord
getUser
in interface FolderRecord
org.apache.james.imapserver.FolderRecord
user
- String a user.An empty string indicates that the
mailbox name is absolute.public java.lang.String getAbsoluteName()
FolderRecord
getAbsoluteName
in interface FolderRecord
public void setNameInUse(boolean state)
FolderRecord
setNameInUse
in interface FolderRecord
org.apache.james.imapserver.FolderRecord
state
- boolean true when mailbox created, false when name no
longer in use.public boolean isNameInUse()
FolderRecord
isNameInUse
in interface FolderRecord
public void setDeleted(boolean state)
FolderRecord
setDeleted
in interface FolderRecord
org.apache.james.imapserver.FolderRecord
state
- boolean true when mailbox deleted, false when createdpublic boolean isDeleted()
FolderRecord
isDeleted
in interface FolderRecord
public void setUidValidity(int uidV)
FolderRecord
setUidValidity
in interface FolderRecord
org.apache.james.imapserver.FolderRecord
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()
FolderRecord
getUidValidity
in interface FolderRecord
public void setHighestUid(int uid)
FolderRecord
setHighestUid
in interface FolderRecord
org.apache.james.imapserver.FolderRecord
uid
- int the highest uid assigned to a message in this mailbox.public int getHighestUid()
FolderRecord
getHighestUid
in interface FolderRecord
public void setLookupRights(java.util.Set users)
FolderRecord
setLookupRights
in interface FolderRecord
org.apache.james.imapserver.FolderRecord
users
- Set of Strings, one per user with Lookup rightspublic boolean hasLookupRights(java.lang.String user)
FolderRecord
hasLookupRights
in interface FolderRecord
public void setReadRights(java.util.Set users)
FolderRecord
setReadRights
in interface FolderRecord
org.apache.james.imapserver.FolderRecord
users
- Set of Strings, one per user with read rightspublic boolean hasReadRights(java.lang.String user)
FolderRecord
hasReadRights
in interface FolderRecord
public void setMarked(boolean mark)
FolderRecord
setMarked
in interface FolderRecord
public boolean isMarked()
FolderRecord
isMarked
in interface FolderRecord
public void setNotSelectableByAnyone(boolean state)
FolderRecord
setNotSelectableByAnyone
in interface FolderRecord
org.apache.james.imapserver.FolderRecord
state
- true if folder is not selectable by anyonepublic boolean isNotSelectableByAnyone()
isNotSelectableByAnyone
in interface FolderRecord
public boolean isSelectable(java.lang.String user)
FolderRecord
isSelectable
in interface FolderRecord
public void setExists(int num)
FolderRecord
setExists
in interface FolderRecord
public int getExists()
FolderRecord
getExists
in interface FolderRecord
public void setRecent(int num)
FolderRecord
setRecent
in interface FolderRecord
public int getRecent()
FolderRecord
getRecent
in interface FolderRecord
public void setUnseenbyUser(java.util.Map unseen)
FolderRecord
setUnseenbyUser
in interface FolderRecord
public int getUnseen(java.lang.String user)
FolderRecord
getUnseen
in interface FolderRecord
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |