MessageSet Node.js Reference Documentation

MessageSet

Current Version: 10.1.0

Requires Chilkat Bundle License

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

Object Creation

var obj = new chilkat.MessageSet();

Properties

Count

Count

· integer, read-only

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

HasUids

HasUids

· boolean

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

LastMethodSuccess

LastMethodSuccess

· boolean

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.

Methods

ContainsId

var retBool = ContainsId(msgId);

· Returns a Boolean.
· msgId

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

FromCompactString

var retBool = FromCompactString(str);

· Returns a Boolean.
· str String

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

var = GetId(index);

· index Number

Returns the message ID of the Nth message in the set. (indexing begins at 0). Returns 0xFFFFFFFF if the index is out of range.

More Information and Examples

How to Download Messages in MessageSet One at a Time

InsertId

InsertId(id);

· Does not return anything (returns Undefined).
· id

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

LoadTaskResult

var status = LoadTaskResult(task);

· Returns Boolean (true for success, false for failure).
· task Task

Introduced in version 9.5.0.52

Loads the message set from a completed asynchronous task.

Returns true for success, false for failure.

RemoveId

RemoveId(id);

· Does not return anything (returns Undefined).
· id

Removes a message ID from the set.

ToCommaSeparatedStr

var retStr = ToCommaSeparatedStr();

· Returns a String.

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

Returns null on failure

ToCompactString

var retStr = ToCompactString();

· Returns a String.

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 null on failure