CkMessageSet CkPython Reference Documentation
CkMessageSet
Current Version: 10.1.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.
topHasUids
boolVal = messageSet.get_HasUids();
messageSet.put_HasUids(boolVal);
If True then the message set contains UIDs, otherwise it contains sequence numbers.
topLastMethodSuccess
boolVal = messageSet.get_LastMethodSuccess();
messageSet.put_LastMethodSuccess(boolVal);
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.
topUtf8
boolVal = messageSet.get_Utf8();
messageSet.put_Utf8(boolVal);
When set to True, all "const char *" arguments are interpreted as utf-8 strings. If set to False (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to True, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to False, all "const char *" return values are ANSI strings.
topMethods
ContainsId
retBool = messageSet.ContainsId(msgId);
Returns True if the msgId is contained in the message set.
topFromCompactString
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