PureBasic

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 PureBasic Downloads

Download Chilkat for PureBasic

PureBasic

IncludeFile "CkMessageSet.pb"

Procedure ChilkatExample()

    success.i = 0

    ;  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.i = CkMessageSet::ckCreate()
    If msgSet.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ;  Load a compact message set.  "1:5,8:10" expands to 1,2,3,4,5,8,9,10.
    success = CkMessageSet::ckFromCompactString(msgSet,"1:5,8:10")
    If success = 0
        Debug CkMessageSet::ckLastErrorText(msgSet)
        CkMessageSet::ckDispose(msgSet)
        ProcedureReturn
    EndIf

    Debug "Count: " + Str(CkMessageSet::ckCount(msgSet))

    ;  Show the loaded identifiers in comma-separated form.
    csv.s = CkMessageSet::ckToCommaSeparatedStr(msgSet)
    Debug csv


    CkMessageSet::ckDispose(msgSet)


    ProcedureReturn
EndProcedure