public class ReadOnlyMailFolder extends MailFolder implements java.io.Serializable
ReadOnlyMailFolder
- a data container object for a mail folderMailFolder.DefaultFolderType
DEFAULT_FOLDER_ID, DEFAULT_FOLDER_NAME
Constructor and Description |
---|
ReadOnlyMailFolder(MailFolder delegate)
Initializes a new
ReadOnlyMailFolder |
Modifier and Type | Method and Description |
---|---|
void |
addPermission(MailPermission permission)
Adds a permission.
|
void |
addPermissions(java.util.Collection<? extends MailPermission> permissions)
Adds a collection of permissions.
|
void |
addPermissions(MailPermission[] permissions)
Adds an array of permissions.
|
boolean |
containsDefaultFolder()
Checks if default-folder flag was set through
setDefaultFolder(boolean) . |
boolean |
containsDeletedMessageCount()
Checks if the number of messages was set through
setDeletedMessageCount(int) . |
boolean |
containsExists()
Checks if folder existence status was set through
setExists(boolean) . |
boolean |
containsFullname()
Checks if full name is set through
MailFolder.setFullname(String) . |
boolean |
containsHoldsFolders()
Checks if the holds-folder flag was set through
setHoldsFolders(boolean) . |
boolean |
containsHoldsMessages()
Checks if he holds-messages flag was set through
setHoldsMessages(boolean) . |
boolean |
containsMessageCount()
Checks if number of messages was set through
setMessageCount(int) . |
boolean |
containsName()
Checks if name was set through
setName(String) . |
boolean |
containsNewMessageCount()
Checks if the number of new messages was set through
setNewMessageCount(int) . |
boolean |
containsOwnPermission()
Checks if own permission was set through
setOwnPermission(MailPermission) . |
boolean |
containsParentFullname()
Checks if parent fullname was set through
setParentFullname(String) . |
boolean |
containsPermissions()
Checks if permissions were set through
MailFolder.addPermission(MailPermission) , MailFolder.addPermissions(Collection) , or
MailFolder.addPermissions(MailPermission[]) . |
boolean |
containsRootFolder()
Checks if root-folder flag was set through
setRootFolder(boolean) . |
boolean |
containsSeparator()
Checks if seperator character was set through
setSeparator(char) . |
boolean |
containsSubfolders()
Checks if has-subfolders flag was set through
setSubfolders(boolean) . |
boolean |
containsSubscribed()
Checks if subscribed status was set through
setSubscribed(boolean) . |
boolean |
containsSubscribedSubfolders()
Checks if the has-subscribed-subfolders flag was set through
setSubscribedSubfolders(boolean) . |
boolean |
containsSupportsUserFlags()
Checks if the supports-user-flags flag was set through
MailFolder.setSupportsUserFlags(boolean) . |
boolean |
containsUnreadMessageCount()
Checks if the number of unread messages was set through
setUnreadMessageCount(int) . |
boolean |
exists()
Checks if this folder exists.
|
int |
getDeletedMessageCount()
Gets the number of messages marked for deletion in this folder
|
java.lang.String |
getFullname()
Gets the full name.
|
int |
getMessageCount()
Gets the number of messages.
|
java.lang.String |
getName()
Gets the name.
|
int |
getNewMessageCount()
Gets the number of new messages (since last time this folder was accessed).
|
MailPermission |
getOwnPermission()
Gets the permission for currently logged-in user accessing this folder
The returned permission should reflect user's permission regardless if mailing system supports permissions or not.
|
java.lang.String |
getParentFullname()
Gets the parent fullname.
|
MailPermission[] |
getPermissions() |
char |
getSeparator()
Gets the separator character.
|
int |
getUnreadMessageCount()
Gets the number of unread messages.
|
boolean |
hasSubfolders()
Checks if this mail folder has subfolders.
|
boolean |
hasSubscribedSubfolders()
Checks if this mail folder has subscribed subfolders.
|
boolean |
isDefaultFolder()
Checks if this folder denotes a default folder (Drafts, Sent, Trash, etc.)
|
boolean |
isHoldsFolders()
Checks if this folder is able to hold folders.
|
boolean |
isHoldsMessages()
Checks if this folder is able to hold messages.
|
boolean |
isRootFolder()
Checks if this folder denotes the root folder
|
boolean |
isSubscribed()
Returns whether the denoted mail folder is subscribed or not.
|
boolean |
isSupportsUserFlags()
Checks if this folder supports user flags.
|
void |
removeDefaultFolder()
Removes the default folder flag.
|
void |
removeDeletedMessageCount()
Removes the number of messages marked for deletion in this folder.
|
void |
removeExists()
Removes exists status.
|
void |
removeFullname()
Removes the full name.
|
void |
removeHoldsFolders()
Removes the holds-folders flag
|
void |
removeHoldsMessages()
Removes the holds-messages flag
|
void |
removeMessageCount()
Removes the message-count.
|
void |
removeName()
Removes the name.
|
void |
removeNewMessageCount()
Removes the new-message-count.
|
void |
removeOwnPermission()
Removes the own permission.
|
void |
removeParentFullname()
Removes the parent fullname.
|
void |
removePermissions()
Removes the permissions.
|
void |
removeRootFolder()
Removes the root folder flag.
|
void |
removeSeparator()
Removes the separator character.
|
void |
removeSubfolders()
Removes the has-subfolders flag.
|
void |
removeSubscribed()
Removes the subscription status.
|
void |
removeSubscribedSubfolders()
Removes has-subscribed-subfolders flag.
|
void |
removeSupportsUserFlags()
Removes the supports-user-flags flag.
|
void |
removeUnreadMessageCount()
Removes the unread-message-count.
|
void |
setDefaultFolder(boolean defaultFolder)
Sets the default folder flag.
|
void |
setDeletedMessageCount(int deletedMessageCount)
Sets the number of messages marked for deletion in this folder.
|
void |
setExists(boolean exists)
Sets the exists status.
|
void |
setFullname(java.lang.String fullname)
Sets this mail folder's full name.
|
void |
setHoldsFolders(boolean holdsFolders)
Sets if this folder holds folders.
|
void |
setHoldsMessages(boolean holdsMessages)
Sets if this folder holds messages.
|
void |
setMessageCount(int messageCount)
Sets the number of messages.
|
void |
setName(java.lang.String name)
Sets this mail folder's name.
|
void |
setNewMessageCount(int newMessageCount)
Sets the number of new messages.
|
void |
setOwnPermission(MailPermission ownPermission)
Sets own permission.
|
void |
setParentFullname(java.lang.String parentFullname)
Sets the parent fullname.
|
void |
setRootFolder(boolean rootFolder)
Sets the root folder flag.
|
void |
setSeparator(char separator)
Sets the separator character.
|
void |
setSubfolders(boolean hasSubfolders)
Sets if this mail folder has subfolders.
|
void |
setSubscribed(boolean subscribed)
Sets the subscription status for this mail folder.
|
void |
setSubscribedSubfolders(boolean hasSubscribedSubfolders)
Sets if this mail folder has subscribed subfolders.
|
void |
setSupportsUserFlags(boolean supportsUserFlags)
Sets the supports-user-flags flag.
|
void |
setUnreadMessageCount(int unreadMessageCount)
Sets the number of unread messages.
|
clone, containsDefaultFolderType, containsOwner, containsProperty, containsPublic, containsShared, getDefaultFolderType, getOwner, getProperty, isConfirmedHam, isConfirmedSpam, isDrafts, isInbox, isPublic, isSent, isShared, isSpam, isTrash, liveAccess, removeDefaultFolderType, removeOwne, removePublic, removeShared, setDefaultFolderType, setLiveAccess, setOwner, setProperty, setPropertyIfAbsent, setPublic, setShared, toString
public ReadOnlyMailFolder(MailFolder delegate)
ReadOnlyMailFolder
public java.lang.String getFullname()
MailFolder
getFullname
in class MailFolder
MailFolder.DEFAULT_FOLDER_ID
if this mail folder denotes the root folder)public boolean containsFullname()
MailFolder
MailFolder.setFullname(String)
.containsFullname
in class MailFolder
true
if full name is set; otherwise false
public void removeFullname()
MailFolder
removeFullname
in class MailFolder
public void setFullname(java.lang.String fullname)
MailFolder
If this mail folder denotes the root folder, MailFolder.DEFAULT_FOLDER_ID
is supposed to be set as fullname.
setFullname
in class MailFolder
fullname
- the full name to setpublic boolean hasSubfolders()
hasSubfolders
in class MailFolder
true
if this mail folder has subfolders; otherwise false
public boolean containsSubfolders()
setSubfolders(boolean)
.containsSubfolders
in class MailFolder
true
if has-subfolders flag is set; otherwise false
public void removeSubfolders()
removeSubfolders
in class MailFolder
public void setSubfolders(boolean hasSubfolders)
setSubfolders
in class MailFolder
hasSubfolders
- the has-subfolders flag to setpublic boolean hasSubscribedSubfolders()
hasSubscribedSubfolders
in class MailFolder
true
if this mail folder has subscribed subfolders; otherwise false
public boolean containsSubscribedSubfolders()
setSubscribedSubfolders(boolean)
.containsSubscribedSubfolders
in class MailFolder
true
if the has-subscribed-subfolders flag was set; otherwise false
public void removeSubscribedSubfolders()
removeSubscribedSubfolders
in class MailFolder
public void setSubscribedSubfolders(boolean hasSubscribedSubfolders)
setSubscribedSubfolders
in class MailFolder
hasSubscribedSubfolders
- the has-subscribed-subfolders flag to setpublic java.lang.String getName()
getName
in class MailFolder
public boolean containsName()
setName(String)
.containsName
in class MailFolder
true
if name is set; otherwise false
public void removeName()
removeName
in class MailFolder
public void setName(java.lang.String name)
If this mail folder denotes the root folder, MailFolder.DEFAULT_FOLDER_NAME
is supposed to be set as name.
setName
in class MailFolder
name
- the name to setpublic boolean isSubscribed()
If mailing system does not support subscription, true
is supposed to be returned.
isSubscribed
in class MailFolder
public boolean containsSubscribed()
setSubscribed(boolean)
.containsSubscribed
in class MailFolder
true
if subscribed is set; otherwise false
public void removeSubscribed()
removeSubscribed
in class MailFolder
public void setSubscribed(boolean subscribed)
If mailing system does not support subscription, true
is supposed to be set as subscription status.
setSubscribed
in class MailFolder
subscribed
- the subscription status to setpublic int getDeletedMessageCount()
getDeletedMessageCount
in class MailFolder
-1
if this mail folder does not hold messagesisHoldsMessages()
public boolean containsDeletedMessageCount()
setDeletedMessageCount(int)
.containsDeletedMessageCount
in class MailFolder
true
if deletedMessageCount is set; otherwise false
public void removeDeletedMessageCount()
removeDeletedMessageCount
in class MailFolder
public void setDeletedMessageCount(int deletedMessageCount)
setDeletedMessageCount
in class MailFolder
deletedMessageCount
- The number of messages marked for deletion or -1
if this mail folder does not hold messagespublic boolean exists()
exists
in class MailFolder
true
if folder exists in mailbox; otherwise false
public boolean containsExists()
setExists(boolean)
.containsExists
in class MailFolder
true
if exists status is set; otherwise false
public void removeExists()
removeExists
in class MailFolder
public void setExists(boolean exists)
setExists
in class MailFolder
exists
- true
if folder exists in mailbox; otherwise false
public int getMessageCount()
getMessageCount
in class MailFolder
-1
if this mail folder does not hold messagesisHoldsMessages()
public boolean containsMessageCount()
setMessageCount(int)
.containsMessageCount
in class MailFolder
true
if messageCount is set; otherwise false
public void removeMessageCount()
removeMessageCount
in class MailFolder
public void setMessageCount(int messageCount)
setMessageCount
in class MailFolder
messageCount
- The number of messages or -1
if this mail folder does not hold messagespublic int getNewMessageCount()
getNewMessageCount
in class MailFolder
-1
if this mail folder does not hold messages.isHoldsMessages()
public boolean containsNewMessageCount()
setNewMessageCount(int)
.containsNewMessageCount
in class MailFolder
true
if newMessageCount is set; otherwise false
public void removeNewMessageCount()
removeNewMessageCount
in class MailFolder
public void setNewMessageCount(int newMessageCount)
setNewMessageCount
in class MailFolder
newMessageCount
- The number of new messages or -1
if this mail folder does not hold messagespublic int getUnreadMessageCount()
getUnreadMessageCount
in class MailFolder
-1
if this mail folder does not hold messagesisHoldsMessages()
public boolean containsUnreadMessageCount()
setUnreadMessageCount(int)
.containsUnreadMessageCount
in class MailFolder
true
if unreadMessageCount is set; otherwise false
public void removeUnreadMessageCount()
removeUnreadMessageCount
in class MailFolder
public void setUnreadMessageCount(int unreadMessageCount)
setUnreadMessageCount
in class MailFolder
unreadMessageCount
- The number of unread messages or -1
if this mail folder does not hold messagespublic char getSeparator()
getSeparator
in class MailFolder
MailConfig#getDefaultSeparator()
public boolean containsSeparator()
setSeparator(char)
.containsSeparator
in class MailFolder
true
if separator is set; otherwise false
public void removeSeparator()
removeSeparator
in class MailFolder
public void setSeparator(char separator)
If mailing system does not support a separator character, MailConfig#getDefaultSeparator()
should to be used.
setSeparator
in class MailFolder
separator
- the separator to setpublic java.lang.String getParentFullname()
getParentFullname
in class MailFolder
null
if this mail folder denotes the root folderpublic boolean containsParentFullname()
setParentFullname(String)
.containsParentFullname
in class MailFolder
true
if parentFullname is set; otherwise false
public void removeParentFullname()
removeParentFullname
in class MailFolder
public void setParentFullname(java.lang.String parentFullname)
If this mail folder denotes the root folder, null
is supposed to be set.
setParentFullname
in class MailFolder
parentFullname
- the parent fullname to setpublic boolean isHoldsMessages()
isHoldsMessages
in class MailFolder
true
if this folder is able to hold messages; otherwise false
public boolean containsHoldsMessages()
setHoldsMessages(boolean)
.containsHoldsMessages
in class MailFolder
true
if the holds-messages flag is set; otherwise false
public void removeHoldsMessages()
removeHoldsMessages
in class MailFolder
public void setHoldsMessages(boolean holdsMessages)
setHoldsMessages
in class MailFolder
holdsMessages
- true
if folder holds messages; otherwise false
public boolean isHoldsFolders()
isHoldsFolders
in class MailFolder
true
if this folder is able to hold folders; otherwise false
public boolean containsHoldsFolders()
setHoldsFolders(boolean)
.containsHoldsFolders
in class MailFolder
true
if this folder has the holds-folder flag set; otherwise false
public void removeHoldsFolders()
removeHoldsFolders
in class MailFolder
public void setHoldsFolders(boolean holdsFolders)
setHoldsFolders
in class MailFolder
holdsFolders
- true
if folder holds folders; otherwise false
public MailPermission getOwnPermission()
The returned permission should reflect user's permission regardless if mailing system supports permissions or not. An instance of
DefaultMailPermission
is supposed to be returned on missing permissions support except for the root folder. The root folder
should indicate no object permissions in any case, but the folder permission varies if mailing system allows subfolder creation below
root folder or not. The returned permission must reflect the allowed behavior.
getOwnPermission
in class MailFolder
public boolean containsOwnPermission()
setOwnPermission(MailPermission)
.containsOwnPermission
in class MailFolder
true
if own permission is set; otherwise false
public void removeOwnPermission()
removeOwnPermission
in class MailFolder
public void setOwnPermission(MailPermission ownPermission)
Apply an instance of DefaultMailPermission
if mailing system does not support permissions, except if this mail folder denotes
the root folder, then apply altered instance of DefaultMailPermission
with no object permissions but properly reflects folder
permission as described in getOwnPermission()
.
setOwnPermission
in class MailFolder
ownPermission
- the own permission to setpublic boolean isRootFolder()
isRootFolder
in class MailFolder
true
if this folder denotes the root folder; otherwise false
public boolean containsRootFolder()
setRootFolder(boolean)
.containsRootFolder
in class MailFolder
true
if root-folder flag is set; otherwise false
public void removeRootFolder()
removeRootFolder
in class MailFolder
public void setRootFolder(boolean rootFolder)
setRootFolder
in class MailFolder
rootFolder
- the root folder flag to setpublic boolean isDefaultFolder()
isDefaultFolder
in class MailFolder
true
if this folder denotes a default folder; otherwise false
public boolean containsDefaultFolder()
setDefaultFolder(boolean)
.containsDefaultFolder
in class MailFolder
true
if default-folder flag is set; otherwise false
public void removeDefaultFolder()
MailFolder
removeDefaultFolder
in class MailFolder
public void setDefaultFolder(boolean defaultFolder)
MailFolder
setDefaultFolder
in class MailFolder
defaultFolder
- the default folder flag to setpublic void addPermission(MailPermission permission)
MailFolder
addPermission
in class MailFolder
permission
- The permission to addpublic void addPermissions(MailPermission[] permissions)
MailFolder
addPermissions
in class MailFolder
permissions
- The array of permissions to addpublic void addPermissions(java.util.Collection<? extends MailPermission> permissions)
MailFolder
addPermissions
in class MailFolder
permissions
- The collection of permissions to addpublic boolean containsPermissions()
MailFolder
MailFolder.addPermission(MailPermission)
, MailFolder.addPermissions(Collection)
, or
MailFolder.addPermissions(MailPermission[])
.containsPermissions
in class MailFolder
true
if permissions are set; otherwise false
public void removePermissions()
MailFolder
removePermissions
in class MailFolder
public MailPermission[] getPermissions()
getPermissions
in class MailFolder
MailPermission
public boolean isSupportsUserFlags()
MailFolder
isSupportsUserFlags
in class MailFolder
true
if this folder supports user flags; otherwise false
public boolean containsSupportsUserFlags()
MailFolder
MailFolder.setSupportsUserFlags(boolean)
.containsSupportsUserFlags
in class MailFolder
true
if supportsUserFlags is set; otherwise false
public void removeSupportsUserFlags()
MailFolder
removeSupportsUserFlags
in class MailFolder
public void setSupportsUserFlags(boolean supportsUserFlags)
MailFolder
setSupportsUserFlags
in class MailFolder
supportsUserFlags
- the supports-user-flags flag to set