Mailboxes Lua Reference Documentation
chilkat.Mailboxes
Current Version: 11.7.0
Markdown version of this page for AI tools (v 11.7.0) · all AI docs
Chilkat.Mailboxes
Receive the read-only list of IMAP mailboxes populated by
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 is a read-only result collection populated by
Chilkat.Imap.MbxList. Applications inspect the returned mailbox
names and attributes but do not directly add, remove, or modify entries. The
class provides indexed access to mailbox flags, selectable status, marked
status, whether child mailboxes exist, and whether child mailboxes may be
created.
Mailbox collection
Chilkat.Imap.MbxList.
Indexed mailbox access
Mailbox flags
Selectable status
Hierarchy information
Marked status
Chilkat.Imap.MbxList to populate a
Mailboxes object, loop from 0 to
Count - 1, retrieve each mailbox name, and inspect its flags or
selectable status. Mailbox names are exposed as normal Unicode text; Chilkat
automatically handles modified UTF-7 or IMAP UTF-8 at the protocol level.
Object Creation
local chilkat = require("chilkat")
local mailboxes = chilkat.Mailboxes.new()Creates the object (chilkat.Mailboxes() does the same). Lua's garbage collector frees it when it is no longer referenced; mailboxes:dispose() frees it at once, and in Lua 5.4 and later local mailboxes <close> = chilkat.Mailboxes.new() frees it when the block ends. Calling a method of a disposed object raises an error.
Errors
A method that fails returns nil followed by the error text, as io.open does: local body, err = mailboxes:method(...), where err is the object's last_error_text. Wrap the call in assert() to raise an error with that text instead. Methods that answer a question return true or false, numbers are returned as they are (check last_method_success where the description says a value means failure), and property reads and writes never fail for Chilkat reasons.
Misuse raises a Lua error: a wrong argument type or a missing argument (bad argument #1 to ...), an unknown property name, a write to a read-only property, an out-of-range integer, or an object of the wrong class.
Names are Chilkat's in snake_case: QuickGetStr is quick_get_str, LastErrorText is last_error_text. Properties are fields (mailboxes.verbose_logging = true) and methods use the colon (mailboxes:method(...)). Strings are UTF-8; binary data is a Lua string of bytes. Indexes are 0-based, as in every Chilkat API. Unlocking: call chilkat.unlock_bundle("...") once at startup.
Properties
Count
local intVal = mailboxes.count
Returns the number of mailboxes in this collection. An empty collection has a count of 0.
Mailboxes is a read-only result container populated by Imap.MbxList. Applications inspect the returned entries but do not directly add, remove, or modify mailboxes in this object.
DebugLogFilePath
local strVal = mailboxes.debug_log_file_path
mailboxes.debug_log_file_path = 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
local strVal = mailboxes.last_error_html
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
local strVal = mailboxes.last_error_text
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
local strVal = mailboxes.last_error_xml
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
local boolVal = mailboxes.last_method_success
mailboxes.last_method_success = 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.
VerboseLogging
local boolVal = mailboxes.verbose_logging
mailboxes.verbose_logging = 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
local strVal = mailboxes.version
Methods
GetFlags
-- str is a string, or nil and err on failure
local str, err = mailboxes:get_flags(index)
Returns a comma-separated list of flags for the mailbox at the zero-based index specified by index.
For example:
\HasNoChildren,\Important
To inspect the flags individually, use GetNumFlags and GetNthFlag.
Returns the string, or nil, err on failure (or when nothing is found). The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.
GetMailboxIndex
-- n is an integer
local n = mailboxes:get_mailbox_index(mbx_name)
Returns the zero-based index of the mailbox whose name matches mbx_name.
Pass mbx_name as a normal Unicode mailbox name. Chilkat automatically handles the protocol-level modified UTF-7 or IMAP UTF-8 representation; the application should not encode the mailbox name manually.
The returned index can be used with methods such as GetName, GetFlags, and IsSelectable.
GetName
-- str is a string, or nil and err on failure
local str, err = mailboxes:get_name(index)
Returns the name of the mailbox at the zero-based index specified by index.
The name is returned as normal Unicode text. Chilkat automatically decodes modified UTF-7 or IMAP UTF-8 mailbox names received from the server and automatically performs the corresponding encoding when the name is passed to an Imap method.
The returned name can therefore be passed directly to methods that select, examine, create, rename, delete, copy to, or otherwise operate on a mailbox. Do not manually encode or decode the mailbox name.
Returns the string, or nil, err on failure (or when nothing is found). The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.
GetNthFlag
-- flag_index is an integer
-- str is a string, or nil and err on failure
local str, err = mailboxes:get_nth_flag(index, flag_index)
Returns one flag from a mailbox in the collection.
indexis the zero-based mailbox index.flag_indexis the zero-based flag index within that mailbox.
Call GetNumFlags to determine the number of flags available for the mailbox.
Returns the string, or nil, err on failure (or when nothing is found). The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.
GetNumFlags
-- n is an integer
local n = mailboxes:get_num_flags(index)
Returns the number of flags associated with the mailbox at the zero-based index specified by index.
Returns -1 if index is outside the valid mailbox-index range. Use GetNthFlag to retrieve the individual flags.
HasFlag
-- flag_name is a string
-- flag is true or false
local flag = mailboxes:has_flag(index, flag_name)
Returns true if the mailbox at the zero-based index specified by index contains the flag named by flag_name.
Flag-name comparison is case-insensitive. Include the leading backslash when checking an IMAP system flag or mailbox attribute, for example \Marked, \Noselect, or \HasChildren.
Returns true or false: an answer, not a success flag.
HasInferiors
-- flag is true or false
local flag = mailboxes:has_inferiors(index)
Returns true if the mailbox at the zero-based index specified by index either has child mailboxes or permits child mailboxes to be created beneath it.
\HasNoChildren means that no child mailboxes currently exist. It does not mean that children cannot be created. The IMAP \Noinferiors attribute means that child mailboxes cannot be created.
Returns true or false: an answer, not a success flag.
IsMarked
-- flag is true or false
local flag = mailboxes:is_marked(index)
Returns true if the mailbox at the zero-based index specified by index has the IMAP \Marked attribute.
\Marked is a server-provided hint that the mailbox may contain messages added since it was last selected. It is advisory information returned by the mailbox-listing operation.
Returns true or false: an answer, not a success flag.
IsSelectable
-- flag is true or false
local flag = mailboxes:is_selectable(index)
Returns true if the mailbox at the zero-based index specified by index can be selected or examined for message access.
A mailbox having the IMAP \Noselect attribute is not selectable, even though it may appear in the mailbox hierarchy and may contain selectable child mailboxes.
Returns true or false: an answer, not a success flag.