Mailboxes PHP ActiveX Reference Documentation
Mailboxes
Current Version: 10.0.0
Represents a collection of IMAP mailboxes.
Object Creation
Chilkat v10.0.0 or greater:
$obj = new COM("Chilkat.Mailboxes");
Chilkat v9.5.0.*:
$obj = new COM("Chilkat_9_5_0.Mailboxes");
Properties
Count
The number of mailboxes in the collection.
Note: The Mailboxes class is for use with the Chilkat IMAP component.
topLastBinaryResult
The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to true. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).
topLastMethodSuccess
Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false 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 = true and failure = false.
- 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 true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.
topLastStringResult
The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to true. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).
LastStringResultLen
The length, in characters, of the string contained in the LastStringResult property.
topMethods
GetFlags
Returns a comma-separated list of flags for the Nth mailbox. For example, "\HasNoChildren,\Important".
Returns null on failure
topGetMailboxIndex
Returns the index of the mailbox having the specified name.
topGetName
GetNthFlag
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 null on 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.
topIsSelectable
Returns true if the Nth mailbox is selectable.
topLoadTaskResult
Loads the mailboxes object from a completed asynchronous task.
Returns true for success, false for failure.
top