MessageSet ActiveX Reference Documentation

MessageSet

Current Version: 10.1.0
Requires Chilkat Bundle License

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

Object Creation

Note:
For versions of Chilkat < 10.0.0, use "Chilkat_9_5_0.MessageSet" instead of "Chilkat.MessageSet"
For a specific major version, use "Chilkat.MessageSet.<major_version>", such as "Chilkat.MessageSet.10" for Chilkat v10.*.*
See Chilkat ActiveX Object Creation

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

(AutoIt)
$obj = ObjCreate("Chilkat.MessageSet")

(Visual Basic 6.0)
Dim obj As New MessageSet

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

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

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

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

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

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

Properties

Count
Count As Long (read-only)

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

top
HasUids
HasUids As Long

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

top
LastBinaryResult
LastBinaryResult As Variant (read-only)

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

top
LastMethodSuccess
LastMethodSuccess As Long

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.

top
LastStringResult
LastStringResult As String (read-only)

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

More Information and Examples
Long Strings Returned by ActiveX Methods in SQL Server
top
LastStringResultLen
LastStringResultLen As Long (read-only)

The length, in characters, of the string contained in the LastStringResult property.

top

Methods

ContainsId
ContainsId(ByVal msgId As Long) As Long

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

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

top
GetId
GetId(ByVal index As Long) As Long

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

More Information and Examples
(AutoIt) How to Download Messages in MessageSet One at a Time(Classic ASP) How to Download Messages in MessageSet One at a Time(PowerBuilder) How to Download Messages in MessageSet One at a Time(SQL Server) How to Download Messages in MessageSet One at a Time(VBScript) How to Download Messages in MessageSet One at a Time(Visual Basic 6.0) How to Download Messages in MessageSet One at a Time(Visual FoxPro) How to Download Messages in MessageSet One at a Time
top
InsertId
InsertId(ByVal id As Long)

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

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

top
RemoveId
RemoveId(ByVal id As Long)

Removes a message ID from the set.

top
ToCommaSeparatedStr
ToCommaSeparatedStr() As String

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

Returns Nothing on failure

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

top