CkMessageSet PHP Extension Reference Documentation

CkMessageSet

Current Version: 10.0.0
Requires Chilkat Bundle License

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

Object Creation

$obj = new CkMessageSet();

Properties

Count
(read-only)
int get_Count()

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

top
HasUids
bool get_HasUids()
void put_HasUids(bool boolVal);

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

top
LastMethodSuccess
bool get_LastMethodSuccess()
void put_LastMethodSuccess(bool boolVal);

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
Utf8
bool get_Utf8()
void put_Utf8(bool boolVal);

When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.

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 0xFFFFFFFF if the index is out of range.

More Information and Examples
How to Download Messages in MessageSet One at a Time
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(CkTask 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
bool ToCommaSeparatedStr(CkString outStr);
string toCommaSeparatedStr();

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

Returns true for success, false for failure.

top
ToCompactString
bool ToCompactString(CkString outStr);
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 true for success, false for failure.

top