MessageSet ActiveX Reference Documentation

MessageSet

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

Object Creation

(Visual Basic 6.0)
Dim obj As New MessageSet

(ASP)
set obj = Server.CreateObject("Chilkat_9_5_0.MessageSet")

(VBScript)
set obj = CreateObject("Chilkat_9_5_0.MessageSet")

(Delphi)
obj := TMessageSet.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat_9_5_0.MessageSet')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat_9_5_0.MessageSet")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.MessageSet', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat_9_5_0.MessageSet");

Properties

Count As Long (read-only)

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

HasUids As Long

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

LastMethodSuccess As Long

Introduced in version 9.5.0.52

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

Methods

ContainsId(ByVal msgId As Long) As Long

Returns 1 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(ByVal 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(ByVal id As Long)

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

LoadTaskResult(task As ChilkatTask) As Long

Introduced in version 9.5.0.52

Loads the message set from a completed asynchronous task.

Returns 1 for success, 0 for failure.

RemoveId(ByVal 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