MessageSet Xojo Plugin Reference Documentation

MessageSet

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

Object Creation

Dim messageSet As New Chilkat.MessageSet

Properties

Count As Int32 (read-only)

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

HasUids As Boolean

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

Methods

Function ContainsId(msgId As Int32) As Boolean

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

Function FromCompactString(str As String) As 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 GetId(index As Int32) As Int32

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

Sub InsertId(id As Int32)

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

Function LoadTaskResult(task As Chilkat.Task) As Boolean

Introduced in version 9.5.0.52

Loads the message set from a completed asynchronous task.

Returns True for success, False for failure.

Sub RemoveId(id As Int32)

Removes a message ID from the set.

Function ToCommaSeparatedStr() As String

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

Returns Nil on failure

Function ToCompactString() As 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 Nil on failure