Mailboxes Node.js Reference Documentation

Mailboxes

Current Version: 11.0.0

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
DebugLogFilePath
DebugLogFilePath
· string

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
LastErrorHtml
LastErrorHtml
· string, read-only

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
LastErrorText
· string, read-only

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
LastErrorXml
· string, read-only

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
LastMethodSuccess
· boolean

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.

top
VerboseLogging
VerboseLogging
· boolean

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.

top
Version
Version
· string, read-only

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

More Information and Examples
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.

More Information and Examples
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).
· task Task
Introduced in version 9.5.0.52

Loads the mailboxes object from a completed asynchronous task.

Returns true for success, false for failure.

top