MessageSet DataFlex Reference Documentation

MessageSet

Current Version: 9.5.0.73

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

Object Creation

// (Dataflex programs use the 32-bit Chilkat ActiveX)
Handle hoMessageSet
Get Create(RefClass(cComMessageSet)) to hoMessageSet

Properties

Count
Function ComCount Returns Integer

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

top
HasUids
Function ComHasUids Returns Boolean
Procedure Set ComHasUids Boolean value

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

top
LastMethodSuccess
Function ComLastMethodSuccess Returns Boolean
Procedure Set ComLastMethodSuccess Boolean value

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

top

Methods

ContainsId
Function ComContainsId Integer msgId Returns Boolean

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

top
FromCompactString
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

top
GetId
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.

top
InsertId
Procedure ComInsertId Integer id

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

top
LoadTaskResult
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.

top
RemoveId
Procedure ComRemoveId Integer id

Removes a message ID from the set.

top
ToCommaSeparatedStr
Function ComToCommaSeparatedStr Returns String

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

Returns null on failure

top
ToCompactString
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 null on failure

top