MessageSet Tcl Reference Documentation
MessageSet
Current Version: 11.0.0
Represents a collection of email message sequence numbers or UIDs on an IMAP server.
Object Creation
set myMessageSet [new CkMessageSet]
Properties
Count
set intVal [CkMessageSet_get_Count $myMessageSet]
The number of message UIDs (or sequence numbers) in this message set.
topDebugLogFilePath
# ckStr is a CkString
CkMessageSet_get_DebugLogFilePath $myMessageSet $ckStr
set strVal [CkMessageSet_get_debugLogFilePath $myMessageSet]
CkMessageSet_put_DebugLogFilePath $myMessageSet $strVal
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.
HasUids
set boolVal [CkMessageSet_get_HasUids $myMessageSet]
CkMessageSet_put_HasUids $myMessageSet $boolVal
If 1 then the message set contains UIDs, otherwise it contains sequence numbers.
LastErrorHtml
# ckStr is a CkString
CkMessageSet_get_LastErrorHtml $myMessageSet $ckStr
set strVal [CkMessageSet_get_lastErrorHtml $myMessageSet]
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.
topLastErrorText
# ckStr is a CkString
CkMessageSet_get_LastErrorText $myMessageSet $ckStr
set strVal [CkMessageSet_get_lastErrorText $myMessageSet]
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.
LastErrorXml
# ckStr is a CkString
CkMessageSet_get_LastErrorXml $myMessageSet $ckStr
set strVal [CkMessageSet_get_lastErrorXml $myMessageSet]
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.
topLastMethodSuccess
set boolVal [CkMessageSet_get_LastMethodSuccess $myMessageSet]
CkMessageSet_put_LastMethodSuccess $myMessageSet $boolVal
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.
VerboseLogging
set boolVal [CkMessageSet_get_VerboseLogging $myMessageSet]
CkMessageSet_put_VerboseLogging $myMessageSet $boolVal
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.
Version
# ckStr is a CkString
CkMessageSet_get_Version $myMessageSet $ckStr
set strVal [CkMessageSet_get_version $myMessageSet]
Methods
ContainsId
set retBool [CkMessageSet_ContainsId $msgId]
Returns 1 if the msgId is contained in the message set.
FromCompactString
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 |
GetId
set retInt [CkMessageSet_GetId $index]
Returns the message ID of the Nth message in the set. (indexing begins at 0). Returns 0xFFFFFFFF if the index is out of range.
InsertId
CkMessageSet_InsertId $id
Inserts a message ID into the set. If the ID already exists, a duplicate is not inserted.
topLoadTaskResult
RemoveId
CkMessageSet_RemoveId $id
Removes a message ID from the set.
topToCommaSeparatedStr
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.
topToCompactString
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