ImapFolderInfo

Contents
[ ]

Inheritance: java.lang.Object

public final class ImapFolderInfo

Represents an IMAP folder.

Fields

Field Description
IN_BOX Gets inbox name.

Methods

Method Description
getSelectable() Gets a value indicating whether it is possible to select this folder.
getMarked() Gets a value indicating whether it is marked this folder.
hasChildren() Gets value indicating whether folder contains subfolders.
getFolderType() Gets information about folder purpose in case if it is used as special folder.
getRemote() Gets value indicating that a folder is a remote mailbox.
getSubscribed() Gets value that indicates that a folder name is subscribed to.
getNonExistent() Gets value indicating whether a folder name is referred to an existing folder.
getNoInferiors() Gets a value indicating whether this folder can have child levels.
getName() Gets the name of the folder.
getNewMessageCount() Gets the number of the new messages.
getReadOnly() Gets a value indicating whether the folder is read-only.
getRecentMessageCount() Gets the number of messages that arrived recently.
getTotalMessageCount() Gets the number of messages in the folder.
getValidityId() Gets the validity ID of the mailbox.
getUidNotSticky() Gets value which indicates if mail store does not support persistent UIDs This property works only if server supports UIDPLUS extension.
getNoModSeq() Gets value which indicates if mailbox supports mod-sequences.
getHighestModSequence() Gets value of all messages in the mailbox.
getUIDNext() Gets the validity ID of the mailbox.
toString() Returns a string that represents the current object.

IN_BOX

public static final String IN_BOX

Gets inbox name.

getSelectable()

public final boolean getSelectable()

Gets a value indicating whether it is possible to select this folder.

Returns: boolean

getMarked()

public final boolean getMarked()

Gets a value indicating whether it is marked this folder.

Returns: boolean

hasChildren()

public final boolean hasChildren()

Gets value indicating whether folder contains subfolders. This option is accessible only in case if server supports IMAP4 LIST Command Extensions (rfc5258) See more: http://tools.ietf.org/html/rfc5258 If value is ``` true ```, it indicates that the folder has child sub-folders that are accessible to the currently authenticated user, otherwise false.

Returns: boolean

getFolderType()

public final int getFolderType()

Gets information about folder purpose in case if it is used as special folder. This option is accessible only in case if server supports IMAP LIST: Special-Use Mailboxes (rfc6154) See more: http://tools.ietf.org/html/rfc6154

Returns: int

getRemote()

public final boolean getRemote()

Gets value indicating that a folder is a remote mailbox. This option is accessible only in case if server supports IMAP4 LIST Command Extensions (rfc5258) See more: http://tools.ietf.org/html/rfc5258

Returns: boolean

getSubscribed()

public final boolean getSubscribed()

Gets value that indicates that a folder name is subscribed to. See more: http://tools.ietf.org/html/rfc5258

Returns: boolean

getNonExistent()

public final boolean getNonExistent()

Gets value indicating whether a folder name is referred to an existing folder. See more: http://tools.ietf.org/html/rfc5258

Returns: boolean

getNoInferiors()

public final boolean getNoInferiors()

Gets a value indicating whether this folder can have child levels. If it is ``` True ```, then no child levels exist now and none can be created in the future

Returns: boolean

getName()

public final String getName()

Gets the name of the folder.

Returns: java.lang.String

getNewMessageCount()

public final int getNewMessageCount()

Gets the number of the new messages.

Returns: int

getReadOnly()

public final boolean getReadOnly()

Gets a value indicating whether the folder is read-only.

Returns: boolean

getRecentMessageCount()

public final int getRecentMessageCount()

Gets the number of messages that arrived recently.

Returns: int

getTotalMessageCount()

public final int getTotalMessageCount()

Gets the number of messages in the folder.

Returns: int

getValidityId()

public final long getValidityId()

Gets the validity ID of the mailbox.

Returns: long

getUidNotSticky()

public final boolean getUidNotSticky()

Gets value which indicates if mail store does not support persistent UIDs This property works only if server supports UIDPLUS extension. Please, read more https://tools.ietf.org/html/rfc4315

Returns: boolean

getNoModSeq()

public final boolean getNoModSeq()

Gets value which indicates if mailbox supports mod-sequences. This property works only if server supports CONDSTORE extension. Please, read more https://tools.ietf.org/html/rfc4551#section-3.1.2

Returns: boolean

getHighestModSequence()

public final long getHighestModSequence()

Gets value of all messages in the mailbox. See more: https://tools.ietf.org/html/rfc7162

Returns: long

getUIDNext()

public final long getUIDNext()

Gets the validity ID of the mailbox.

Returns: long

toString()

public String toString()

Returns a string that represents the current object.

Returns: java.lang.String - A string that represents the current object.