Mailboxes Perl Reference Documentation
CkMailboxes
Current Version: 11.0.0
Represents a collection of IMAP mailboxes.
Object Creation
$obj = chilkat::CkMailboxes->new();
Properties
Count
$intVal = $mailboxes->get_Count();
The number of mailboxes in the collection.
Note: The Mailboxes class is for use with the Chilkat IMAP component.
topDebugLogFilePath
# $ckStr is a CkString
$mailboxes->get_DebugLogFilePath($ckStr);
$strVal = $mailboxes->debugLogFilePath();
$mailboxes->put_DebugLogFilePath($strVal);
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.
LastErrorHtml
# $ckStr is a CkString
$mailboxes->get_LastErrorHtml($ckStr);
$strVal = $mailboxes->lastErrorHtml();
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.
topLastErrorText
# $ckStr is a CkString
$mailboxes->get_LastErrorText($ckStr);
$strVal = $mailboxes->lastErrorText();
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.
LastErrorXml
# $ckStr is a CkString
$mailboxes->get_LastErrorXml($ckStr);
$strVal = $mailboxes->lastErrorXml();
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.
topLastMethodSuccess
$boolVal = $mailboxes->get_LastMethodSuccess();
$mailboxes->put_LastMethodSuccess($boolVal);
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.
VerboseLogging
$boolVal = $mailboxes->get_VerboseLogging();
$mailboxes->put_VerboseLogging($boolVal);
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.
Version
# $ckStr is a CkString
$mailboxes->get_Version($ckStr);
$strVal = $mailboxes->version();
Methods
GetFlags
# $outStr is a CkString (output)
$status = $mailboxes->GetFlags($index, $outStr);
$retStr = $mailboxes->getFlags($index);
Returns a comma-separated list of flags for the Nth mailbox. For example, "\HasNoChildren,\Important".
Returns 1 for success, 0 for failure.
topGetMailboxIndex
$retInt = $mailboxes->GetMailboxIndex($mbxName);
Returns the index of the mailbox having the specified name.
topGetName
# $outStrName is a CkString (output)
$status = $mailboxes->GetName($index, $outStr);
$retStr = $mailboxes->getName($index);
The name of the Nth mailbox in this collection. Indexing begins at 0.
Returns 1 for success, 0 for failure.
topGetNthFlag
# $flagIndex is an integer
# $outStr is a CkString (output)
$status = $mailboxes->GetNthFlag($index, $flagIndex, $outStr);
$retStr = $mailboxes->getNthFlag($index, $flagIndex);
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 1 for success, 0 for failure.
topGetNumFlags
$retInt = $mailboxes->GetNumFlags($index);
Returns the number of flags for the Nth mailbox. Returns -1 if the index is out of range.
topHasFlag
# $flagName is a string
$retBool = $mailboxes->HasFlag($index, $flagName);
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.
HasInferiors
$retBool = $mailboxes->HasInferiors($index);
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.
IsMarked
$retBool = $mailboxes->IsMarked($index);
Returns 1 if the Nth mailbox is marked.
IsSelectable
$retBool = $mailboxes->IsSelectable($index);
Returns 1 if the Nth mailbox is selectable.
LoadTaskResult
Loads the mailboxes object from a completed asynchronous task.
Returns 1 for success, 0 for failure.
top