Mailboxes PHP Extension Reference Documentation
CkMailboxes
Current Version: 11.0.0
Represents a collection of IMAP mailboxes.
Object Creation
$obj = new CkMailboxes();
Properties
Count
int get_Count()
The number of mailboxes in the collection.
Note: The Mailboxes class is for use with the Chilkat IMAP component.
topDebugLogFilePath
void put_DebugLogFilePath(string strVal);
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
LastErrorHtml
string lastErrorHtml();
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
string lastErrorText();
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
string lastErrorXml();
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
void put_LastMethodSuccess(bool boolVal);
Indicates the success or failure of the most recent method call: true
means success, false
means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.
VerboseLogging
void put_VerboseLogging(bool boolVal);
If set to true
, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false
. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
string version();
Methods
GetFlags
Returns a comma-separated list of flags for the Nth mailbox. For example, "\HasNoChildren,\Important".
Returns true for success, false for failure.
topGetMailboxIndex
Returns the index of the mailbox having the specified name.
topGetName
The name of the Nth mailbox in this collection. Indexing begins at 0.
Returns true for success, false for failure.
topGetNthFlag
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.
topGetNumFlags
Returns the number of flags for the Nth mailbox. Returns -1 if the index is out of range.
topHasFlag
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
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.
IsMarked
Returns true
if the Nth mailbox is marked.
IsSelectable
Returns true
if the Nth mailbox is selectable.
LoadTaskResult
Loads the mailboxes object from a completed asynchronous task.
Returns true for success, false for failure.
top