MessageSet React Native Reference Documentation

MessageSet

Current Version: 11.6.1

Chilkat.MessageSet

Represent and pass sets of IMAP message identifiers.

Chilkat.MessageSet represents a set of IMAP message identifiers used by Chilkat.Imap. It is a helper object for passing groups of messages to IMAP methods and for receiving groups of message IDs returned by IMAP search, fetch, copy, delete, or flag-related operations. A MessageSet may contain either UIDs or sequence numbers, and the HasUids setting identifies which form is being used.

IMAP message IDs

Store the identifiers used by IMAP operations, either as message UIDs or as sequence numbers.

Used by Chilkat.Imap

Pass message sets to IMAP methods that operate on multiple messages, or receive them from IMAP methods that return matching messages.

UID awareness

Use HasUids to indicate whether the contained identifiers are stable IMAP UIDs or mailbox-relative sequence numbers.

Add and remove IDs

Insert message identifiers, remove identifiers, check whether an ID is present, and build the exact message group needed for an IMAP operation.

Compact string formats

Load or emit compact IMAP-style message ranges such as comma-separated lists and range expressions.

Set operations

Subtract one message set from another when application logic needs to exclude already-processed or unwanted messages.

Common pattern: Use MessageSet only for IMAP message identifiers, not as a general-purpose collection. Obtain a message set from an IMAP search or build one manually, confirm whether it contains UIDs or sequence numbers, then pass it to the appropriate Chilkat.Imap method for fetching, copying, deleting, flagging, or otherwise processing the selected messages.

For an extended overview, see MessageSet Class Overview.

Object Creation

// npm install @chilkat/react-native react-native-nitro-modules
// (React Native 0.76+ with the New Architecture; then `pod install` for iOS.  The Chilkat
//  native library is downloaded and verified during the native build -- see the package README.)

import { Chilkat, MessageSet } from '@chilkat/react-native'

// Once per app start, before any other Chilkat call:
Chilkat.unlockBundle('Anything for 30-day trial')   // shorthand for new Global().unlockBundle(..)

const messageSet = new MessageSet()
// ... the native object is released when `messageSet` is garbage collected, or now with messageSet.dispose()

new MessageSet()

Creates the underlying native Chilkat object. MessageSet is a Nitro Module HybridObject: use it from the JavaScript thread only (it cannot be passed to a Worklet or another runtime). Every member is synchronous and blocks the JavaScript thread until Chilkat returns; a method that can take a while also exists as a ...Async twin returning a Promise, which runs the same call on a native worker thread so the UI keeps rendering. While such a call is pending, every other call on this object throws, except abort() and assigning onPercentDone / onProgressInfo.

dispose(): void

Releases the native object immediately instead of waiting for garbage collection (useful for a large BinData or an open socket). Calling it more than once is harmless; any other use of the object afterwards throws. An object with a pending ...Async call cannot be disposed until the promise settles.

Errors

A method that can fail throws a plain Error: 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 error's message is "Class.method(...): reason", where the reason is the last informative line of the object's lastErrorText, which holds the full Chilkat log of the failed call. A ...Async twin rejects its promise with the same Error instead of throwing. Properties never throw, and methods that answer a question (has..., is..., ...) return a plain boolean.

try {
  messageSet.someMethod(...)
} catch (e) {
  console.log((e as Error).message)   // MessageSet.someMethod(...): <reason>
  console.log(messageSet.lastErrorText)   // the full Chilkat log of the failed call
}

// The same call without blocking the JavaScript thread:
try {
  await messageSet.someMethodAsync(...)
} catch (e) {
  console.log((e as Error).message)   // MessageSet.someMethodAsync: <reason>
}

Properties

Count

// read-only
readonly count: number

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 true, or as sequence numbers when it is false.

Input	Result
`1,2,3,4,5`	Loads `1,2,3,4,5`.
`1:5`	Loads the inclusive range `1` through `5`.
`1:5,8:10`	Loads `1,2,3,4,5,8,9,10`.
`1,1,2,2,3`	Loads the unique values `1,2,3`.
`1:5,3:7`	Loads the unique values `1` through `7`.
`1,,3`	Empty comma-separated elements are ignored; loads `1,3`.
`1,2,abc,4`	Unrecognized elements are ignored; loads `1,2,4`.
`+1`	A leading plus sign is accepted; loads `1`.

Comma-separated form	Compact form
`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`

MessageSet React Native Reference Documentation

MessageSet

Current Version: 11.6.1

Represent and pass sets of IMAP message identifiers.

IMAP message IDs

Used by Chilkat.Imap

UID awareness

Add and remove IDs

Compact string formats

Set operations

Object Creation

Errors

Properties

Count

DebugLogFilePath

HasUids

LastErrorHtml

LastErrorText

LastErrorXml

LastMethodSuccess

VerboseLogging

Version

Methods

ContainsId

FromCompactString

GetId

InsertId

RemoveId

Subtract

ToCommaSeparatedStr

ToCompactString