MessageSet Delphi DLL Reference Documentation

MessageSet

Current Version: 9.5.0.73

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.

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

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

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

top

Methods

ContainsId
function CkMessageSet_ContainsId(objHandle: HCkMessageSet;
    msgId: Integer): wordbool; stdcall;

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

top
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

top
GetId
function CkMessageSet_GetId(objHandle: HCkMessageSet;
    index: Integer): Integer; stdcall;

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

top
InsertId
procedure CkMessageSet_InsertId(objHandle: HCkMessageSet;
    id: Integer) stdcall;

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

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

top
RemoveId
procedure CkMessageSet_RemoveId(objHandle: HCkMessageSet;
    id: Integer) stdcall;

Removes a message ID from the set.

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

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

top