MessageSet DataFlex Reference Documentation

MessageSet

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

Object Creation

Handle hoMessageSet
Get Create(RefClass(cComMessageSet)) to hoMessageSet

Properties

Function ComCount Returns Integer

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

Function ComHasUids Returns Boolean
Procedure Set ComHasUids Boolean value

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

Methods

Function ComContainsId Integer msgId Returns Boolean

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

Function ComFromCompactString String str Returns Boolean

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

Function ComGetId Integer index Returns Integer

Returns the message ID of the Nth message in the set. (indexing begins at 0). Returns -1 if the index is out of range.

Procedure ComInsertId Integer id

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

Function ComLoadTaskResult cComChilkatTask task Returns Boolean

Introduced in version 9.5.0.52

Loads the message set from a completed asynchronous task.

Returns True for success, False for failure.

Procedure ComRemoveId Integer id

Removes a message ID from the set.

Function ComToCommaSeparatedStr Returns String

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

Returns True for success, False for failure.

Function ComToCompactString Returns String

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.