MessageSet ActiveX Reference Documentation

MessageSet

Current Version: 11.0.0

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")

(VBA, such as Excel)
Dim obj As New MessageSet
See How to Use ActiveX in Excel

(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
DebugLogFilePath
DebugLogFilePath As String

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

  • A timeout property set to 0, indicating an infinite timeout.
  • A hang occurring within an event callback in the application code.
  • An internal bug in the Chilkat code causing the hang.

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)

This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to 1. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.

top
LastErrorHtml
LastErrorHtml As String (read-only)

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorText
LastErrorText As String (read-only)

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorXml
LastErrorXml As String (read-only)

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastMethodSuccess
LastMethodSuccess As Long

Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

top
LastStringResult
LastStringResult As String (read-only)

In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.

top
LastStringResultLen
LastStringResultLen As Long (read-only)

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

top
VerboseLogging
VerboseLogging As Long

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
Version As String (read-only)

Version of the component/library, such as "10.1.0"

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.

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