MessageSet Excel Class Module Reference Documentation

MessageSet

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

Object Creation

Dim oMessageSet As Chilkat.MessageSet
Set oMessageSet = Chilkat.NewMessageSet

Properties

Count As Long (read only)

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

HasUids As Long

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

Methods

ContainsId(msgId As Long) As Long

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

FromCompactString(str As String) As Long

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

GetId(index As Long) As Long

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

InsertId(id As Long)

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

RemoveId(id As Long)

Removes a message ID from the set.

ToCommaSeparatedStr() As String

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

Returns Nothing on failure

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 Nothing on failure