Mailboxes Excel Class Module Reference Documentation

Mailboxes

Represents a collection of IMAP mailboxes.

Object Creation

Dim oMailboxes As Chilkat.Mailboxes
Set oMailboxes = Chilkat.NewMailboxes

Properties

Count As Long (read only)

The number of mailboxes in the collection.

Note: The Mailboxes class is for use with the Chilkat IMAP component.

Methods

GetFlags(index As Long) As String

Returns a comma-separated list of flags for the Nth mailbox. For example, "\HasNoChildren,\Important".

Returns Nothing on failure

GetMailboxIndex(mbxName As String) As Long

Returns the index of the mailbox having the specified name.

GetName(index As Long) As String

The name of the Nth mailbox in this collection. Indexing begins at 0.

Returns Nothing on failure

GetNthFlag(index As Long, flagIndex As Long) As String

Returns the name of the Nth flag for the Mth mailbox. The index is the index of the mailbox. The flagIndex is the index of the flag.

Returns Nothing on failure

GetNumFlags(index As Long) As Long

Returns the number of flags for the Nth mailbox. Returns -1 if the index is out of range.

HasFlag(index As Long, flagName As String) As Long

Returns True if the Nth mailbox has the specified flag set. The flag name is case insensitive and should begin with a backslash character, such as "\Flagged". The index is the index of the Nth mailbox.

HasInferiors(index As Long) As Long

Returns True if the Nth mailbox has inferiors (i.e. sub-mailboxes), or if it is possible to create child mailboxes in the future.

Note: the HasNoChildren attribute/flag should not be confused with the IMAP4 [RFC-2060] defined attribute Noinferiors which indicates that no child mailboxes exist now AND none can be created in the future.

HasInferiors always True? (Why HasInferiors is Often Misunderstood)

IsMarked(index As Long) As Long

Returns True if the Nth mailbox is marked.

IsSelectable(index As Long) As Long

Returns True if the Nth mailbox is selectable.