com.aspose.email

Interfaces

Classes

Enums

Exceptions

com.aspose.email

Class ImapFolderInfo


  • public final class ImapFolderInfo
extends Object

    Represents an IMAP folder.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static String IN_BOX
      Gets inbox name.

    • Method Summary

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

    • Field Detail

      • IN_BOX

        public static final String IN_BOX

        Gets inbox name.

    • Method Detail

      • getSelectable

        public final boolean getSelectable()

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

      • getMarked

        public final boolean getMarked()

        Gets a value indicating whether it is marked this folder.

      • 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.

      • 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

      • 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

      • getSubscribed

        public final boolean getSubscribed()

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

      • 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

      • 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

      • getName

        public final String getName()

        Gets the name of the folder.

      • getNewMessageCount

        public final int getNewMessageCount()

        Gets the number of the new messages.

      • getReadOnly

        public final boolean getReadOnly()

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

      • getRecentMessageCount

        public final int getRecentMessageCount()

        Gets the number of messages that arrived recently.

      • getTotalMessageCount

        public final int getTotalMessageCount()

        Gets the number of messages in the folder.

      • getValidityId

        public final long getValidityId()

        Gets the validity ID of the mailbox.

      • 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

      • 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

      • getHighestModSequence

        public final long getHighestModSequence()

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

      • getUIDNext

        public final long getUIDNext()

        Gets the validity ID of the mailbox.

      • toString

        public String toString()

        Returns a string that represents the current object.

        Overrides:
        toString in class Object
        Returns:
        A string that represents the current object.