MessageSet Delphi DLL Reference Documentation

MessageSet

Current Version: 11.0.0

Requires Chilkat Bundle License

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

Create/Dispose

var
myObject: HCkMessageSet;

begin
myObject := CkMessageSet_Create();

// ...

CkMessageSet_Dispose(myObject);
end;

function CkMessageSet_Create: HCkMessageSet; stdcall;

Creates an instance of the HCkMessageSet object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

procedure CkMessageSet_Dispose(handle: HCkMessageSet); stdcall;

Objects created by calling CkMessageSet_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.

Properties

Count

function CkMessageSet_getCount(objHandle: HCkMessageSet): Integer; stdcall;

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

DebugLogFilePath

procedure CkMessageSet_getDebugLogFilePath(objHandle: HCkMessageSet; outPropVal: HCkString); stdcall;
procedure CkMessageSet_putDebugLogFilePath(objHandle: HCkMessageSet; newPropVal: PWideChar); stdcall;
function CkMessageSet__debugLogFilePath(objHandle: HCkMessageSet): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Example showing how to use DebugLogFilePath.

HasUids

function CkMessageSet_getHasUids(objHandle: HCkMessageSet): wordbool; stdcall;
procedure CkMessageSet_putHasUids(objHandle: HCkMessageSet; newPropVal: wordbool); stdcall;

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

LastErrorHtml

procedure CkMessageSet_getLastErrorHtml(objHandle: HCkMessageSet; outPropVal: HCkString); stdcall;
function CkMessageSet__lastErrorHtml(objHandle: HCkMessageSet): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

LastErrorText

procedure CkMessageSet_getLastErrorText(objHandle: HCkMessageSet; outPropVal: HCkString); stdcall;
function CkMessageSet__lastErrorText(objHandle: HCkMessageSet): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

procedure CkMessageSet_getLastErrorXml(objHandle: HCkMessageSet; outPropVal: HCkString); stdcall;
function CkMessageSet__lastErrorXml(objHandle: HCkMessageSet): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

LastMethodSuccess

function CkMessageSet_getLastMethodSuccess(objHandle: HCkMessageSet): wordbool; stdcall;
procedure CkMessageSet_putLastMethodSuccess(objHandle: HCkMessageSet; newPropVal: wordbool); stdcall;

Indicates the success or failure of the most recent method call: True means success, False 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.

VerboseLogging

function CkMessageSet_getVerboseLogging(objHandle: HCkMessageSet): wordbool; stdcall;
procedure CkMessageSet_putVerboseLogging(objHandle: HCkMessageSet; newPropVal: wordbool); stdcall;

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

Version

procedure CkMessageSet_getVersion(objHandle: HCkMessageSet; outPropVal: HCkString); stdcall;
function CkMessageSet__version(objHandle: HCkMessageSet): PWideChar; stdcall;

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

See the notes about PWideChar memory ownership and validity.

More Information and Examples

How to get the Chilkat version at runtime.

Methods

ContainsId

function CkMessageSet_ContainsId(objHandle: HCkMessageSet;
msgId: LongWord): wordbool; stdcall;

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

FromCompactString

function CkMessageSet_FromCompactString(objHandle: HCkMessageSet;
str: PWideChar): wordbool; stdcall;

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

function CkMessageSet_GetId(objHandle: HCkMessageSet;
index: Integer): LongWord; stdcall;

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

How to Download Messages in MessageSet One at a Time

InsertId

procedure CkMessageSet_InsertId(objHandle: HCkMessageSet;
id: LongWord) stdcall;

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

LoadTaskResult

function CkMessageSet_LoadTaskResult(objHandle: HCkMessageSet;
task: HCkTask): wordbool; stdcall;

Introduced in version 9.5.0.52

Loads the message set from a completed asynchronous task.

Returns True for success, False for failure.

RemoveId

procedure CkMessageSet_RemoveId(objHandle: HCkMessageSet;
id: LongWord) stdcall;

Removes a message ID from the set.

ToCommaSeparatedStr

function CkMessageSet_ToCommaSeparatedStr(objHandle: HCkMessageSet;
outStr: HCkString): wordbool; stdcall;
function CkMessageSet__toCommaSeparatedStr(objHandle: HCkMessageSet): PWideChar; stdcall;

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

Returns True for success, False for failure.

See the notes about PWideChar memory ownership and validity.

ToCompactString

function CkMessageSet_ToCompactString(objHandle: HCkMessageSet;
outStr: HCkString): wordbool; stdcall;
function CkMessageSet__toCompactString(objHandle: HCkMessageSet): PWideChar; stdcall;

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 True for success, False for failure.

See the notes about PWideChar memory ownership and validity.