PHP Extension

Load a MessageSet from a Compact String

Demonstrates the Chilkat MessageSet.FromCompactString method, which clears the set and loads message identifiers from compact IMAP message-set syntax. The only argument is the compact string: a colon specifies an inclusive ascending range, and commas separate values or ranges. This example loads 1:5,8:10 and prints the result as a comma-separated list.

Background: Compact message-set syntax is how IMAP itself expresses groups of messages — 1:5,8:10 is far more concise than listing every id. FromCompactString is the inverse of ToCompactString: it parses that text into a set you can pass to Imap methods. Duplicates are removed, identifiers are sorted ascending, and the existing HasUids setting is preserved. Note the string carries only the numbers — it does not record whether they are UIDs or sequence numbers.

Chilkat PHP Extension Downloads

Download Chilkat for PHP Extension

PHP Extension

<?php

include("chilkat.php");

$success = false;

//  Demonstrates the MessageSet.FromCompactString method, which loads a set of message
//  identifiers from compact IMAP message-set syntax.  The only argument is the compact string.
//  A colon specifies an inclusive range, and commas separate values or ranges.

$msgSet = new CkMessageSet();

//  Load a compact message set.  "1:5,8:10" expands to 1,2,3,4,5,8,9,10.
$success = $msgSet->FromCompactString('1:5,8:10');
if ($success == false) {
    print $msgSet->lastErrorText() . "\n";
    exit;
}

print 'Count: ' . $msgSet->get_Count() . "\n";

//  Show the loaded identifiers in comma-separated form.
$csv = $msgSet->toCommaSeparatedStr();
print $csv . "\n";

?>