CkMailboxes PHP Extension Reference Documentation

CkMailboxes

Represents a collection of IMAP mailboxes.

Object Creation

$obj = new CkMailboxes();

Properties

(read-only)
int get_Count()

The number of mailboxes in the collection.

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

bool get_Utf8()
void put_Utf8(bool boolVal);

When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.

Methods

bool GetFlags(int index, CkString outStr);
string getFlags(int index);

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

Returns true for success, false for failure.

int GetMailboxIndex(string mbxName);

Returns the index of the mailbox having the specified name.

bool GetName(int index, CkString outStrName);
string getName(int index);

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

Returns true for success, false for failure.

bool GetNthFlag(int index, int flagIndex, CkString outStr);
string getNthFlag(int index, int flagIndex);

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 true for success, false for failure.

int GetNumFlags(int index);

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

bool HasFlag(int index, string flagName);

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.

bool HasInferiors(int index);

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)

bool IsMarked(int index);

Returns true if the Nth mailbox is marked.

bool IsSelectable(int index);

Returns true if the Nth mailbox is selectable.

bool LoadTaskResult(CkTask task);

Introduced in version 9.5.0.52

Loads the mailboxes object from a completed asynchronous task.

Returns true for success, false for failure.