Chilkat VB.NET MessageSet Class Reference

MessageSet

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

Object Creation

(C#)
Chilkat.MessageSet obj = new Chilkat.MessageSet();
(VB.NET)
Dim obj As New Chilkat.MessageSet()

Properties

Count As Integer (ReadOnly)

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(ByVal msgId As Integer) As Boolean

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

Function FromCompactString(ByVal 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(ByVal index As Integer) As 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.

Sub InsertId(ByVal id As Integer)

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

Sub RemoveId(ByVal id As Integer)

Removes a message ID from the set.

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

Function ToString() As String

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