Mailboxes Lianja Reference Documentation

Mailboxes

Current Version: 9.5.0.98
Requires Chilkat Bundle License

Represents a collection of IMAP mailboxes.

Object Creation

loObject = createobject("CkMailboxes")

Properties

Count
Count As Numeric (read-only)

The number of mailboxes in the collection.

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

top
LastMethodSuccess
LastMethodSuccess As Boolean

Indicate whether the last method call succeeded or failed. A value of .T. indicates success, a value of .F. 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 = .T. and failure = .F..
  • 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 .T.. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top

Methods

GetFlags
GetFlags(index As Numeric) As Character

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

Returns .F. on failure

top
GetMailboxIndex
GetMailboxIndex(mbxName As Character) As Numeric

Returns the index of the mailbox having the specified name.

top
GetName
GetName(index As Numeric) As Character

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

Returns .F. on failure

top
GetNthFlag
GetNthFlag(index As Numeric, flagIndex As Numeric) As Character

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 .F. on failure

top
GetNumFlags
GetNumFlags(index As Numeric) As Numeric

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

top
HasFlag
HasFlag(index As Numeric, flagName As Character) As Boolean

Returns .T. 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.

More Information and Examples
Find the "Sent" IMAP Mailbox
top
HasInferiors
HasInferiors(index As Numeric) As Boolean

Returns .T. 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.

More Information and Examples
HasInferiors always True? (Why HasInferiors is Often Misunderstood)
top
IsMarked
IsMarked(index As Numeric) As Boolean

Returns .T. if the Nth mailbox is marked.

top
IsSelectable
IsSelectable(index As Numeric) As Boolean

Returns .T. if the Nth mailbox is selectable.

top
LoadTaskResult
LoadTaskResult(task As CkTask) As Boolean
Introduced in version 9.5.0.52

Loads the mailboxes object from a completed asynchronous task.

Returns .T. for success, .F. for failure.

top