Chilkat.MessageSet PHP Reference

Chilkat.MessageSet

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

Object Creation

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

Properties

int Count (read-only)

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

bool HasUids (read-only)

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

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

void RemoveId(int msgId)

Removes a message ID from the set.

string Serialize()

Identical to the ToCompactString method.

Returns a 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

string ToString()

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

bool Unserialize(string str)

Same as FromCompactString.