MessageSet Objective-C Reference Documentation

CkoMessageSet

Current Version: 11.0.0

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

Object Creation

CkoMessageSet *obj = [[CkoMessageSet alloc] init];

Properties

Count
@property (nonatomic, readonly, copy) NSNumber *Count;

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

top
DebugLogFilePath
@property (nonatomic, copy) NSString *DebugLogFilePath;

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.

More Information and Examples
top
HasUids
@property (nonatomic) BOOL HasUids;

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

top
LastErrorHtml
@property (nonatomic, readonly, copy) NSString *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.

top
LastErrorText
@property (nonatomic, readonly, copy) NSString *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.

top
LastErrorXml
@property (nonatomic, readonly, copy) NSString *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.

top
LastMethodSuccess
@property (nonatomic) BOOL LastMethodSuccess;

Indicates the success or failure of the most recent method call: YES means success, NO 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.

top
VerboseLogging
@property (nonatomic) BOOL VerboseLogging;

If set to YES, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is NO. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
@property (nonatomic, readonly, copy) NSString *Version;

Version of the component/library, such as "10.1.0"

More Information and Examples
top

Methods

ContainsId
- (BOOL)ContainsId:(NSNumber *)id;

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

top
FromCompactString
- (BOOL)FromCompactString:(NSString *)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
- (NSNumber *)GetId:(NSNumber *)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.

top
InsertId
- (void)InsertId:(NSNumber *)id;

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

top
LoadTaskResult
- (BOOL)LoadTaskResult:(CkoTask *)task;
Introduced in version 9.5.0.52

Loads the message set from a completed asynchronous task.

Returns YES for success, NO for failure.

top
RemoveId
- (void)RemoveId:(NSNumber *)id;

Removes a message ID from the set.

top
ToCommaSeparatedStr
- (NSString *)ToCommaSeparatedStr;

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

Returns nil on failure

top
ToCompactString
- (NSString *)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 nil on failure

top