Mailboxes PureBasic Reference Documentation

Mailboxes

Current Version: 10.1.0
Requires Chilkat Bundle License

Represents a collection of IMAP mailboxes.

Object Creation

obj.i = CkMailboxes::ckCreate()

; Make sure to dispose of the object when finished like this:
CkMailboxes::ckDispose(obj);

Properties

Count
Declare.i ckCount(obj.i) ; (read-only)

The number of mailboxes in the collection.

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

top
LastMethodSuccess
Declare.i ckLastMethodSuccess(obj.i)
Declare setCkLastMethodSuccess(obj.i, value.i)

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.

top

Methods

GetFlags
Declare.s ckGetFlags(obj.i, index.l)

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

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

top
GetMailboxIndex
Declare.i ckGetMailboxIndex(obj.i, mbxName.s)

Returns the index of the mailbox having the specified name.

top
GetName
Declare.s ckGetName(obj.i, index.l)

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

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

top
GetNthFlag
Declare.s ckGetNthFlag(obj.i, index.l, flagIndex.l)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

top
GetNumFlags
Declare.i ckGetNumFlags(obj.i, index.l)

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

top
HasFlag
Declare.i ckHasFlag(obj.i, index.l, flagName.s)

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.

More Information and Examples
Find the "Sent" IMAP Mailbox
top
HasInferiors
Declare.i ckHasInferiors(obj.i, index.l)

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.

More Information and Examples
HasInferiors always True? (Why HasInferiors is Often Misunderstood)
top
IsMarked
Declare.i ckIsMarked(obj.i, index.l)

Returns 1 if the Nth mailbox is marked.

top
IsSelectable
Declare.i ckIsSelectable(obj.i, index.l)

Returns 1 if the Nth mailbox is selectable.

top
LoadTaskResult
Declare.i ckLoadTaskResult(obj.i, task.i)
Introduced in version 9.5.0.52

Loads the mailboxes object from a completed asynchronous task.

Returns 1 for success, 0 for failure.

top