Mailboxes ActiveX Reference Documentation

Mailboxes

Represents a collection of IMAP mailboxes.

Object Creation

(Visual Basic 6.0)
Dim obj As New Mailboxes

(ASP)
set obj = Server.CreateObject("Chilkat_9_5_0.Mailboxes")

(VBScript)
set obj = CreateObject("Chilkat_9_5_0.Mailboxes")

(Delphi)
obj := TMailboxes.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat_9_5_0.Mailboxes')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat_9_5_0.Mailboxes")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Mailboxes', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat_9_5_0.Mailboxes");

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.

LastMethodSuccess As Long

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = 1 and failure = 0.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

Methods

GetFlags(ByVal 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(ByVal index As Long) As String

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

Returns Nothing on failure

GetNthFlag(ByVal index As Long, ByVal 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(ByVal index As Long) As Long

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

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

Returns 1 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(ByVal index As Long) As Long

Returns 1 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(ByVal index As Long) As Long

Returns 1 if the Nth mailbox is marked.

IsSelectable(ByVal index As Long) As Long

Returns 1 if the Nth mailbox is selectable.

LoadTaskResult(task As ChilkatTask) As Long

Introduced in version 9.5.0.52

Loads the mailboxes object from a completed asynchronous task.

Returns 1 for success, 0 for failure.