MessageSet Dart Reference Documentation
CkMessageSet
Current Version: 11.6.1
Object Creation
// pubspec.yaml:
// dependencies:
// chilkat: ^11.6.1
import 'package:chilkat/chilkat.dart';
// Once per process, before any other Chilkat call:
Chilkat.unlockBundle('Anything for 30-day trial'); // shorthand for CkGlobal().unlockBundle(..)
final messageSet = CkMessageSet();
// ... the native object is released when `messageSet` is garbage collected, or now with messageSet.dispose().Creates the underlying native Chilkat object. Use a CkMessageSet only from the isolate that created it: Chilkat objects cannot be sent between isolates. Every call is synchronous; in a Flutter app, run long operations (network, large files) inside Isolate.run, creating the Chilkat objects inside the isolate.
Releases the native object immediately instead of waiting for garbage collection (useful for a large CkBinData or an open socket). Calling it more than once is harmless; any other use of the object afterwards throws a StateError. isDisposed tells whether it has been called.
Errors
A method that can fail throws a ChilkatException: a method whose only outcome is success or failure returns void and throws on failure; a method producing a String or an object returns it and throws where Chilkat would have returned null. The exception carries the object's LastErrorText at the time of the failure (lastErrorText), the class and method names (className, methodName) and a one-line message. Properties never throw, and methods that answer a question (has..., is..., ...) return a plain bool.
try {
messageSet.someMethod(...);
} on ChilkatException catch (e) {
print(e); // CkMessageSet.someMethod failed: <reason>
print(e.lastErrorText); // the full Chilkat log of the failed call
}Properties
Count
int get count
Returns the number of unique message identifiers currently stored in the set. A newly created MessageSet has a count of 0.
The identifiers are maintained in ascending numeric order. They are interpreted as UIDs when HasUids is truefalse
DebugLogFilePath
String get debugLogFilePath
set debugLogFilePath(String value)
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
bool get hasUids
set hasUids(bool value)
Indicates how the numeric identifiers in this message set are interpreted:
truefalse
Changing this property only changes how the existing numeric values are interpreted. It does not convert, validate, reorder, or clear the identifiers.
An IMAP UID is stable only within its mailbox and while that mailbox's UIDVALIDITY remains unchanged. Sequence numbers are temporary and can change when messages are added or expunged.
Set this property consistently before passing a manually constructed message set to an Imap method. The string formats produced by ToCommaSeparatedStr and ToCompactString contain only the numeric values and do not include this setting.
LastErrorHtml
String get 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
String get 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
String get 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
bool get lastMethodSuccess
set lastMethodSuccess(bool value)
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. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
VerboseLogging
bool get verboseLogging
set verboseLogging(bool value)
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
String get version
Methods
ContainsId
Returns truemsgId is present in the message set; otherwise, returns false
The comparison is numeric only. The HasUids setting does not participate in the comparison.
FromCompactString
Clears the identifiers currently stored in this object and loads the compact message-set representation in str. The existing HasUids setting is preserved.
str is parsed. If parsing fails, the message set remains empty.An empty string succeeds and leaves the set empty. Valid identifiers are unsigned 32-bit decimal values from 1 through 4294967295. The value 0 is not accepted. Values too large for an unsigned 32-bit integer cause the method to fail.
The syntax uses commas to separate values or ranges, and a colon to specify an inclusive ascending range. A single range may contain at most 500,001 identifiers; equivalently, the ending value minus the starting value cannot exceed 500000.
Whitespace is accepted around values, commas, and colons. This includes spaces, tabs, carriage returns, and line feeds. Empty comma-separated elements and unrecognized non-numeric elements are intentionally ignored. If str is nonempty and no valid identifier is loaded, the method returns false
Descending ranges, ranges containing 0, wildcard ranges such as 1:*, malformed range syntax, oversized ranges, and numeric overflow cause the method to return false
On success, duplicate identifiers are removed and the resulting identifiers are stored in ascending numeric order. The serialized form contains only the numbers and does not indicate whether they are UIDs or sequence numbers.
Use ToCompactString to generate the canonical compact representation.
Returns normally on success; throws a ChilkatException on failure.
GetId
Returns the message identifier at the zero-based index specified by index. Identifiers are returned in ascending numeric order.
If index is negative or is greater than or equal to Count, this method returns 0xFFFFFFFF.
0xFFFFFFFF can also be stored in the set. Check index against Count before calling this method when that value could be present.InsertId
Adds id to the message set and maintains the identifiers in ascending numeric order.
- If
idis already present, no duplicate is added. - If
idis0, the set is unchanged. - The value
0xFFFFFFFFis accepted.
The HasUids setting determines whether the stored values are interpreted as UIDs or sequence numbers.
RemoveId
Removes the identifier whose raw numeric value equals id. If the value is not present, the set is unchanged.
The comparison is numeric only and does not depend on HasUids. The remaining identifiers stay in ascending numeric order.
Subtract
Removes from this message set every identifier whose raw numeric value is present in msgSet. Values not present in this set are ignored.
The comparison is numeric only; the HasUids values of the two objects are not compared. This object's HasUids value is preserved, and the remaining identifiers stay in ascending numeric order.
Passing the same object as msgSet clears the set. Passing an empty set leaves this set unchanged.
For meaningful IMAP results, both objects should represent identifiers of the same type and from the same mailbox.
ToCommaSeparatedStr
Returns the unique identifiers as a comma-separated string in ascending numeric order. An empty set returns an empty string.
For example, a set containing the identifiers 1 through 5 returns 1,2,3,4,5.
The returned string contains only the numeric values; it does not include the HasUids setting.
Throws a ChilkatException on failure (where the description says null is returned, the Dart method throws instead).
ToCompactString
Returns the unique identifiers in ascending numeric order using compact IMAP message-set syntax. Consecutive identifiers are represented as an inclusive range. An empty set returns an empty string.
The returned string is canonical for the current set: identifiers are unique, sorted, and consecutive runs are compacted. It contains only the numeric values and does not include the HasUids setting.
Use FromCompactString to load this format.
Throws a ChilkatException on failure (where the description says null is returned, the Dart method throws instead).