MessageSet Tcl Reference Documentation

MessageSet

Current Version: 9.5.0.73

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

Object Creation

set myMessageSet [new CkMessageSet]

Properties

Count
integer
set intVal [CkMessageSet_get_Count $myMessageSet]

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

top
HasUids
boolean 1/0
set boolVal [CkMessageSet_get_HasUids $myMessageSet]
CkMessageSet_put_HasUids $myMessageSet $boolVal

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

top
LastMethodSuccess
boolean 1/0
set boolVal [CkMessageSet_get_LastMethodSuccess $myMessageSet]
CkMessageSet_put_LastMethodSuccess $myMessageSet $boolVal

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
Utf8
boolean 1/0
set boolVal [CkMessageSet_get_Utf8 $myMessageSet]
CkMessageSet_put_Utf8 $myMessageSet $boolVal

When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.

top

Methods

ContainsId
# msgId is an integer
set retBool [CkMessageSet_ContainsId $msgId]

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

top
FromCompactString
# str is a string
set retBool [CkMessageSet_FromCompactString $str]

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
# index is an integer
set retInt [CkMessageSet_GetId $index]

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
# id is an integer
CkMessageSet_InsertId $id

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

top
LoadTaskResult
# task is a CkTask
set status [CkMessageSet_LoadTaskResult $task]
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
# id is an integer
CkMessageSet_RemoveId $id

Removes a message ID from the set.

top
ToCommaSeparatedStr
# outStr is a CkString (output)
set status [CkMessageSet_ToCommaSeparatedStr $outStr]
set retStr [CkMessageSet_toCommaSeparatedStr $myMessageSet]

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

Returns 1 for success, 0 for failure.

top
ToCompactString
# outStr is a CkString (output)
set status [CkMessageSet_ToCompactString $outStr]
set retStr [CkMessageSet_toCompactString $myMessageSet]

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 1 for success, 0 for failure.

top