Mailboxes CkPython Reference Documentation
CkMailboxes
Current Version: 11.5.0
Chilkat.Mailboxes
Hold the list of IMAP mailboxes returned by mailbox-listing operations in
Use the mailbox count and index-based methods to retrieve each mailbox
name in the returned collection.
Inspect IMAP flags associated with each mailbox, including standard and
server-specific attributes.
Determine whether a mailbox can be selected and opened for message
access.
Check whether a mailbox has child mailboxes or whether children may be
created beneath it.
Detect whether a mailbox is marked or unmarked according to the
attributes returned by the IMAP server.
For an extended overview, see
Mailboxes Class Overview.
Inspect IMAP mailbox names and attributes returned by Chilkat.Imap.
Chilkat.Mailboxes represents a collection of IMAP mailboxes
returned by Chilkat.Imap. It provides indexed access to mailbox
names and mailbox attributes, including mailbox flags, selectable status,
marked status, whether child mailboxes exist, and whether child mailboxes may
be created. It is a lightweight result object used for listing and examining
the mailbox hierarchy on an IMAP server.
Mailbox collection
Chilkat.Imap.
Indexed mailbox access
Mailbox flags
Selectable status
Hierarchy information
Marked status
Chilkat.Imap, receive a
Mailboxes object, loop from 0 to
Count - 1, retrieve each mailbox name, and inspect its flags or
selectable status before selecting, creating, or displaying mailboxes in the
application.
Object Creation
obj = chilkat.CkMailboxes()
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: 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. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
Utf8
boolVal = mailboxes.get_Utf8();
mailboxes.put_Utf8(boolVal);
When set to True, all string arguments and return values are interpreted as UTF-8 strings. When set to False, they are interpreted as ANSI strings.
In Chilkat v11.0.0 and later, the default value is True. Before v11.0.0, it was False.
VerboseLogging
boolVal = mailboxes.get_VerboseLogging();
mailboxes.put_VerboseLogging(boolVal);
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.
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 True for success, False 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 True for success, False 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 True for success, False 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.
HasFlag
# flagName is a string
retBool = mailboxes.HasFlag(index, flagName);
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.
HasInferiors
retBool = mailboxes.HasInferiors(index);
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.
IsMarked
retBool = mailboxes.IsMarked(index);
Returns True if the Nth mailbox is marked.
IsSelectable
retBool = mailboxes.IsSelectable(index);
Returns True if the Nth mailbox is selectable.
LoadTaskResult
Loads the mailboxes object from a completed asynchronous task.
Returns True for success, False for failure.
top