Mailboxes Node.js Reference Documentation

Mailboxes

Current Version: 9.5.0.73

Represents a collection of IMAP mailboxes.

Object Creation

var obj = new chilkat.Mailboxes();

Properties

Count
Count
· integer, read-only

The number of mailboxes in the collection.

Note: The Mailboxes class is for use with the Chilkat IMAP component.

top
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.

top

Methods

GetFlags
var retStr = GetFlags(index);
· Returns a String.
· index Number

Returns a comma-separated list of flags for the Nth mailbox. For example, "\HasNoChildren,\Important".

Returns null on failure

top
GetMailboxIndex
var retInt = GetMailboxIndex(mbxName);
· Returns a Number.
· mbxName String

Returns the index of the mailbox having the specified name.

top
GetName
var retStr = GetName(index);
· Returns a String.
· index Number

The name of the Nth mailbox in this collection. Indexing begins at 0.

Returns null on failure

top
GetNthFlag
var retStr = GetNthFlag(index, flagIndex);
· Returns a String.
· index Number
· flagIndex Number

Returns the name of the Nth flag for the Mth mailbox. The index is the index of the mailbox. The flagIndex is the index of the flag.

Returns null on failure

top
GetNumFlags
var retInt = GetNumFlags(index);
· Returns a Number.
· index Number

Returns the number of flags for the Nth mailbox. Returns -1 if the index is out of range.

top
HasFlag
var retBool = HasFlag(index, flagName);
· Returns a Boolean.
· index Number
· flagName String

Returns true if the Nth mailbox has the specified flag set. The flag name is case insensitive and should begin with a backslash character, such as "\Flagged". The index is the index of the Nth mailbox.

top
HasInferiors
var retBool = HasInferiors(index);
· Returns a Boolean.
· index Number

Returns true if the Nth mailbox has inferiors (i.e. sub-mailboxes), or if it is possible to create child mailboxes in the future.

Note: the HasNoChildren attribute/flag should not be confused with the IMAP4 [RFC-2060] defined attribute Noinferiors which indicates that no child mailboxes exist now AND none can be created in the future.

top
IsMarked
var retBool = IsMarked(index);
· Returns a Boolean.
· index Number

Returns true if the Nth mailbox is marked.

top
IsSelectable
var retBool = IsSelectable(index);
· Returns a Boolean.
· index Number

Returns true if the Nth mailbox is selectable.

top
LoadTaskResult
var status = LoadTaskResult(task);
· Returns Boolean (true for success, false for failure).
· taskbool
Introduced in version 9.5.0.52

Loads the mailboxes object from a completed asynchronous task.

Returns true for success, false for failure.

top