Mailboxes PureBasic Reference Documentation

Mailboxes

Current Version: 11.0.0
Requires Chilkat Bundle License

Represents a collection of IMAP mailboxes.

Object Creation

obj.i = CkMailboxes::ckCreate()

; Make sure to dispose of the object when finished like this:
CkMailboxes::ckDispose(obj);

Properties

Count
Declare.i ckCount(obj.i) ; (read-only)

The number of mailboxes in the collection.

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

top
DebugLogFilePath
Declare.s ckDebugLogFilePath(obj.i)
Declare setCkDebugLogFilePath(obj.i, value.s)

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
Example showing how to use DebugLogFilePath.
top
LastErrorHtml
Declare.s ckLastErrorHtml(obj.i) ; (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
Declare.s ckLastErrorText(obj.i) ; (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.

More Information and Examples
Concept of LastErrorTextLastErrorText Standard Information
top
LastErrorXml
Declare.s ckLastErrorXml(obj.i) ; (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
Declare.i ckLastMethodSuccess(obj.i)
Declare setCkLastMethodSuccess(obj.i, value.i)

Indicates the success or failure of the most recent method call: 1 means success, 0 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
Declare.i ckVerboseLogging(obj.i)
Declare setCkVerboseLogging(obj.i, value.i)

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

top
Version
Declare.s ckVersion(obj.i) ; (read-only)

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

More Information and Examples
How to get the Chilkat version at runtime.
top

Methods

GetFlags
Declare.s ckGetFlags(obj.i, index.l)

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

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

top
GetMailboxIndex
Declare.i ckGetMailboxIndex(obj.i, mbxName.s)

Returns the index of the mailbox having the specified name.

top
GetName
Declare.s ckGetName(obj.i, index.l)

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

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

top
GetNthFlag
Declare.s ckGetNthFlag(obj.i, index.l, flagIndex.l)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

top
GetNumFlags
Declare.i ckGetNumFlags(obj.i, index.l)

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

top
HasFlag
Declare.i ckHasFlag(obj.i, index.l, flagName.s)

Returns 1 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
Find the "Sent" IMAP Mailbox
top
HasInferiors
Declare.i ckHasInferiors(obj.i, index.l)

Returns 1 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.

More Information and Examples
HasInferiors always True? (Why HasInferiors is Often Misunderstood)
top
IsMarked
Declare.i ckIsMarked(obj.i, index.l)

Returns 1 if the Nth mailbox is marked.

top
IsSelectable
Declare.i ckIsSelectable(obj.i, index.l)

Returns 1 if the Nth mailbox is selectable.

top
LoadTaskResult
Declare.i ckLoadTaskResult(obj.i, task.i)
Introduced in version 9.5.0.52

Loads the mailboxes object from a completed asynchronous task.

Returns 1 for success, 0 for failure.

top