Package com.chilkatsoft.chilkat2

Class Mailboxes

java.lang.Object
com.chilkatsoft.chilkat2.ChilkatObject
com.chilkatsoft.chilkat2.Mailboxes
All Implemented Interfaces:
AutoCloseable
public class Mailboxes extends ChilkatObject
<section class="mailboxes-summary">

Inspect IMAP mailbox names and attributes returned by Chilkat.Imap.

Chilkat.Mailboxes is a read-only result collection populated by Chilkat.Imap.MbxList. Applications inspect the returned mailbox names and attributes but do not directly add, remove, or modify entries. The class provides indexed access to mailbox flags, selectable status, marked status, whether child mailboxes exist, and whether child mailboxes may be created.

Mailbox collection

Receive the read-only list of IMAP mailboxes populated by Chilkat.Imap.MbxList.

Indexed mailbox access

Use the mailbox count and index-based methods to retrieve each mailbox name in the returned collection.

Mailbox flags

Inspect IMAP flags associated with each mailbox, including standard and server-specific attributes.

Selectable status

Determine whether a mailbox can be selected and opened for message access.

Hierarchy information

Check whether a mailbox has child mailboxes or whether children may be created beneath it.

Marked status

Detect whether a mailbox is marked or unmarked according to the attributes returned by the IMAP server.

Common pattern: Call Chilkat.Imap.MbxList to populate a Mailboxes object, loop from 0 to Count - 1, retrieve each mailbox name, and inspect its flags or selectable status. Mailbox names are exposed as normal Unicode text; Chilkat automatically handles modified UTF-7 or IMAP UTF-8 at the protocol level.

For an extended overview, see Mailboxes Class Overview.

</section>

Instances hold a native Chilkat object: close them with ChilkatObject.close() (try-with-resources) when done; an unclosed instance is freed when it becomes unreachable.

See Also:
Online reference

  • Constructor Details

    • Mailboxes

      public Mailboxes()
      Creates a new Mailboxes object.

  • Method Details

    • getCount

      public int getCount()
      Returns the number of mailboxes in this collection. An empty collection has a count of 0.

      Mailboxes is a read-only result container populated by Imap.MbxList. Applications inspect the returned entries but do not directly add, remove, or modify mailboxes in this object.

      Returns:
      the value of the Count property (read-only)

    • getFlags

      public String getFlags​(int index)
      Returns a comma-separated list of flags for the mailbox at the zero-based index specified by index.

      For example: 

      \HasNoChildren,\Important

      To inspect the flags individually, use getNumFlags(int) and getNthFlag(int, int).

      Parameters:
      index - the index argument
      Returns:
      the result (never null)
      Throws:
      ChilkatException - if the operation fails; ChilkatException.getLastErrorText() says why

    • getMailboxIndex

      public int getMailboxIndex​(String mbxName)
      Returns the zero-based index of the mailbox whose name matches mbxName.

      Pass mbxName as a normal Unicode mailbox name. Chilkat automatically handles the protocol-level modified UTF-7 or IMAP UTF-8 representation; the application should not encode the mailbox name manually.

      The returned index can be used with methods such as getName(int), getFlags(int), and isSelectable(int).

      Parameters:
      mbxName - the mbxName argument (not null)
      Returns:
      the result (see ChilkatObject.getLastMethodSuccess() where the description mentions failure)

    • getName

      public String getName​(int index)
      Returns the name of the mailbox at the zero-based index specified by index.

      The name is returned as normal Unicode text. Chilkat automatically decodes modified UTF-7 or IMAP UTF-8 mailbox names received from the server and automatically performs the corresponding encoding when the name is passed to an Imap method.

      The returned name can therefore be passed directly to methods that select, examine, create, rename, delete, copy to, or otherwise operate on a mailbox. Do not manually encode or decode the mailbox name.

      Parameters:
      index - the index argument
      Returns:
      the result (never null)
      Throws:
      ChilkatException - if the operation fails; ChilkatException.getLastErrorText() says why

    • getNthFlag

      public String getNthFlag​(int index, int flagIndex)
      Returns one flag from a mailbox in the collection.
      • index is the zero-based mailbox index.
      • flagIndex is the zero-based flag index within that mailbox.

      Call getNumFlags(int) to determine the number of flags available for the mailbox.

      Parameters:
      index - the index argument
      flagIndex - the flagIndex argument
      Returns:
      the result (never null)
      Throws:
      ChilkatException - if the operation fails; ChilkatException.getLastErrorText() says why

    • getNumFlags

      public int getNumFlags​(int index)
      Returns the number of flags associated with the mailbox at the zero-based index specified by index.

      Returns -1 if index is outside the valid mailbox-index range. Use getNthFlag(int, int) to retrieve the individual flags.

      Parameters:
      index - the index argument
      Returns:
      the result (see ChilkatObject.getLastMethodSuccess() where the description mentions failure)

    • hasFlag

      public boolean hasFlag​(int index, String flagName)
      Returns true if the mailbox at the zero-based index specified by index contains the flag named by flagName.

      Flag-name comparison is case-insensitive. Include the leading backslash when checking an IMAP system flag or mailbox attribute, for example \Marked, \Noselect, or \HasChildren.

      Parameters:
      index - the index argument
      flagName - the flagName argument (not null)
      Returns:
      the result; this method never throws ChilkatException

    • hasInferiors

      public boolean hasInferiors​(int index)
      Returns true if the mailbox at the zero-based index specified by index either has child mailboxes or permits child mailboxes to be created beneath it.

      Important distinction: \HasNoChildren means that no child mailboxes currently exist. It does not mean that children cannot be created. The IMAP \Noinferiors attribute means that child mailboxes cannot be created.

      Parameters:
      index - the index argument
      Returns:
      the result; this method never throws ChilkatException

    • isMarked

      public boolean isMarked​(int index)
      Returns true if the mailbox at the zero-based index specified by index has the IMAP \Marked attribute.

      \Marked is a server-provided hint that the mailbox may contain messages added since it was last selected. It is advisory information returned by the mailbox-listing operation.

      Parameters:
      index - the index argument
      Returns:
      the result; this method never throws ChilkatException

    • isSelectable

      public boolean isSelectable​(int index)
      Returns true if the mailbox at the zero-based index specified by index can be selected or examined for message access.

      A mailbox having the IMAP \Noselect attribute is not selectable, even though it may appear in the mailbox hierarchy and may contain selectable child mailboxes.

      Parameters:
      index - the index argument
      Returns:
      the result; this method never throws ChilkatException