MessageSet CkPython Reference Documentation
CkMessageSet
Current Version: 11.0.0
Represents a collection of email message sequence numbers or UIDs on an IMAP server.
Object Creation
obj = chilkat.CkMessageSet()
Properties
Count
intVal = messageSet.get_Count();
The number of message UIDs (or sequence numbers) in this message set.
topDebugLogFilePath
# ckStr is a CkString
messageSet.get_DebugLogFilePath(ckStr);
strVal = messageSet.debugLogFilePath();
messageSet.put_DebugLogFilePath(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
boolVal = messageSet.get_HasUids();
messageSet.put_HasUids(boolVal);
If True then the message set contains UIDs, otherwise it contains sequence numbers.
LastErrorHtml
# ckStr is a CkString
messageSet.get_LastErrorHtml(ckStr);
strVal = messageSet.lastErrorHtml();
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
messageSet.get_LastErrorText(ckStr);
strVal = messageSet.lastErrorText();
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
messageSet.get_LastErrorXml(ckStr);
strVal = messageSet.lastErrorXml();
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
boolVal = messageSet.get_LastMethodSuccess();
messageSet.put_LastMethodSuccess(boolVal);
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
boolVal = messageSet.get_VerboseLogging();
messageSet.put_VerboseLogging(boolVal);
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
# ckStr is a CkString
messageSet.get_Version(ckStr);
strVal = messageSet.version();
Methods
ContainsId
retBool = messageSet.ContainsId(msgId);
Returns True if the msgId is contained in the message set.
FromCompactString
retBool = messageSet.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
retInt = messageSet.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
messageSet.InsertId(id);
Inserts a message ID into the set. If the ID already exists, a duplicate is not inserted.
topLoadTaskResult
Loads the message set from a completed asynchronous task.
Returns True for success, False for failure.
topRemoveId
messageSet.RemoveId(id);
Removes a message ID from the set.
topToCommaSeparatedStr
status = messageSet.ToCommaSeparatedStr(outStr);
retStr = messageSet.toCommaSeparatedStr();
Returns a string of comma-separated message IDs. (This is the non-compact string format.)
Returns True for success, False for failure.
topToCompactString
status = messageSet.ToCompactString(outStr);
retStr = messageSet.toCompactString();
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