Chilkat_9_5_0.MessageSet PHP ActiveX Reference Documentation

Chilkat_9_5_0.MessageSet

Current Version: 9.5.0.90

Represents a collection of email message sequence numbers or UIDs on an IMAP server.

Object Creation

$obj = new COM("Chilkat_9_5_0.MessageSet");

Properties

Count
int Count (read-only)

The number of message UIDs (or sequence numbers) in this message set.

top
HasUids
bool HasUids

If true then the message set contains UIDs, otherwise it contains sequence numbers.

top
LastBinaryResult
VARIANT LastBinaryResult (read-only)
Introduced in version 9.5.0.52

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
LastMethodSuccess
bool LastMethodSuccess

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
LastStringResult
string LastStringResult (read-only)
Introduced in version 9.5.0.52

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).

top
LastStringResultLen
int LastStringResultLen (read-only)
Introduced in version 9.5.0.53

The length, in characters, of the string contained in the LastStringResult property.

top

Methods

ContainsId
bool ContainsId(int msgId)

Returns true if the msgId is contained in the message set.

top
FromCompactString
bool FromCompactString(string str)

Loads the message set from a compact-string representation. Here are some examples:

Non-Compact String

Compact String

1,2,3,4,5

1:5

1,2,3,4,5,8,9,10

1:5,8:10

1,3,4,5,8,9,10

1,3:5,8:10

top
GetId
int GetId(int index)

Returns the message ID of the Nth message in the set. (indexing begins at 0). Returns -1 if the index is out of range.

top
InsertId
void InsertId(int id)

Inserts a message ID into the set. If the ID already exists, a duplicate is not inserted.

top
LoadTaskResult
bool LoadTaskResult(Chilkat_9_5_0.Task task)
Introduced in version 9.5.0.52

Loads the message set from a completed asynchronous task.

Returns true for success, false for failure.

top
RemoveId
void RemoveId(int id)

Removes a message ID from the set.

top
ToCommaSeparatedStr
string ToCommaSeparatedStr()

Returns a string of comma-separated message IDs. (This is the non-compact string format.)

Returns null on failure

top
ToCompactString
string ToCompactString()

Returns the set of message IDs represented as a compact string. Here are some examples:

Non-Compact String

Compact String

1,2,3,4,5

1:5

1,2,3,4,5,8,9,10

1:5,8:10

1,3,4,5,8,9,10

1,3:5,8:10

Returns null on failure

top