CkMessageSet Perl Reference Documentation

CkMessageSet

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

Object Creation

$obj = chilkat::CkMessageSet()->new();

Properties

# $intVal is an integer
$intVal = $messageSet->get_Count();

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

# $boolVal is a boolean
$boolVal = $messageSet->get_HasUids();
$messageSet->put_HasUids($boolVal);

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

# $boolVal is a boolean
$boolVal = $messageSet->get_LastMethodSuccess();
$messageSet->put_LastMethodSuccess($boolVal);

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

# $boolVal is a boolean
$boolVal = $messageSet->get_Utf8();
$messageSet->put_Utf8($boolVal);

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

Methods

# $msgId is an integer
$retBool = $messageSet->ContainsId($msgId);

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

# $str is a string
$retBool = $messageSet->FromCompactString($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

# $index is an integer
$retInt = $messageSet->GetId($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.

# $id is an integer
$messageSet->InsertId($id);

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

# $task is a CkTask
$status = $messageSet->LoadTaskResult($task);

Introduced in version 9.5.0.52

Loads the message set from a completed asynchronous task.

Returns 1 for success, 0 for failure.

# $id is an integer
$messageSet->RemoveId($id);

Removes a message ID from the set.

# $outStr is a CkString (output)
$status = $messageSet->ToCommaSeparatedStr($outStr);
$retStr = $messageSet->toCommaSeparatedStr();

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

Returns 1 for success, 0 for failure.

# $outStr is a CkString (output)
$status = $messageSet->ToCompactString($outStr);
$retStr = $messageSet->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 1 for success, 0 for failure.