JavaScript

Get MessageSet IDs as a Compact String

Demonstrates the Chilkat MessageSet.ToCompactString method, which returns the unique identifiers in ascending order using compact IMAP message-set syntax, collapsing consecutive runs into inclusive ranges. It takes no arguments. This example loads 1,2,3,4,5,8,9,10 and prints the compact form 1:5,8:10.

Background: The result is canonical for the current set — unique, sorted, and range-compacted — which is the compact notation IMAP servers expect for message-set arguments. It is the inverse of FromCompactString, so the two round-trip: a set emitted here can be reloaded later. The string contains only numbers and omits the HasUids setting, so track UID-vs-sequence separately.

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

JavaScript

var success = false;

//  Demonstrates the MessageSet.ToCompactString method, which returns the unique identifiers in
//  ascending order using compact IMAP message-set syntax, with consecutive runs collapsed into
//  inclusive ranges.  It takes no arguments.

var msgSet = new CkMessageSet();

//  Load a set of individual identifiers.
success = msgSet.FromCompactString("1,2,3,4,5,8,9,10");
if (success == false) {
    console.log(msgSet.LastErrorText);
    return;
}

//  Get the canonical compact representation.
var compact = msgSet.ToCompactString();
console.log(compact);
//  Output: 1:5,8:10