Class MetaFolder

    • Constructor Detail

      • MetaFolder

        public MetaFolder​(FolderDelegate<MessageDelegate> delegate)
        Constructs a new meta folder instance.
        Parameters:
        file - the meta folder file
      • MetaFolder

        public MetaFolder​(org.jdom.Namespace namespace,
                          FolderDelegate<MessageDelegate> delegate)
        Constructs a new meta folder instance with the specified namespace.
        Parameters:
        file - the meta folder file
        namespace - the namespace for the metadata
    • Method Detail

      • getParent

        public MetaFolder getParent()
        Returns:
        the parent folder delegate of this delegate.
      • getFolder

        public MetaFolder getFolder​(String name)
                             throws javax.mail.MessagingException
        Returns a child folder delegate with the specified name.
        Parameters:
        name - a folder name
        Returns:
        the folder delegate with the specified name, or null if the folder doesn't exist
        Throws:
        javax.mail.MessagingException - where an unexpected error occurs retrieving the folder
      • list

        public MetaFolder[] list​(String pattern)
        Returns a list of child folder delegates matching the specified pattern.
        Parameters:
        pattern - a pattern to match folders against
        Returns:
        a list of folder delegates
      • getMessage

        public final MetaMessage getMessage​(int messageNumber)
                                     throws DelegateException
        Returns message delegate corresponding to the specified message id. If no delegate exists a new Message delegate is created.
        Parameters:
        messageNumber - the message number of the message to retrieve
        Returns:
        the message with the specified message number, or null if the messages doesn't exist
        Throws:
        DelegateException - where an error occurs retrieving the message
      • getLastUid

        public final long getLastUid()
        Retrieves the last allocated message UID for the folder.
        Returns:
        the latest UID for the folder
      • getUidValidity

        public final long getUidValidity()
                                  throws UnsupportedOperationException,
                                         javax.mail.MessagingException
        Returns the UID validity associated with the metadata. If no UID validity exist a new value is initialised.
        Returns:
        a long representation of the UID validity
        Throws:
        UnsupportedOperationException - if this method is not supported by the folder implementation
        javax.mail.MessagingException - if an error occurs retrieving the validity value