Chilkat_9_5_0.MessageSet PHP ActiveX Reference Documentation

Chilkat_9_5_0.MessageSet

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

int Count (read-only)

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

bool HasUids

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

Methods

bool ContainsId(int msgId)

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

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

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.

void InsertId(int id)

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

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.

void RemoveId(int id)

Removes a message ID from the set.

string ToCommaSeparatedStr()

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

Returns null on failure

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