Chilkat_9_5_0.MessageSet PHP ActiveX Reference Documentation
Current Version: 126.96.36.199
Represents a collection of email message sequence numbers or UIDs on an IMAP server.
$obj = new COM("Chilkat_9_5_0.MessageSet");
The number of message UIDs (or sequence numbers) in this message set.top
If true then the message set contains UIDs, otherwise it contains sequence numbers.top
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).top
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.top
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).
The length, in characters, of the string contained in the LastStringResult property.top
Returns true if the msgId is contained in the message set.top
Loads the message set from a compact-string representation. Here are some examples:
Returns the message ID of the Nth message in the set. (indexing begins at 0). Returns -1 if the index is out of range.
Inserts a message ID into the set. If the ID already exists, a duplicate is not inserted.top
Loads the message set from a completed asynchronous task.
Returns true for success, false for failure.top
Removes a message ID from the set.top
Returns a string of comma-separated message IDs. (This is the non-compact string format.)
Returns null on failuretop
Returns the set of message IDs represented as a compact string. Here are some examples:
Returns null on failuretop