Mailboxes Rust Reference Documentation
Mailboxes
Current Version: 11.6.1
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
// Cargo.toml:
// [dependencies]
// chilkat = "11.6"
use chilkat::Mailboxes;
// Once per process, before any other Chilkat call:
chilkat::unlock_bundle("Anything for 30-day trial")?; // shorthand for Global::new().unlock_bundle(..)
let mailboxes = Mailboxes::new();
// ... the native object is freed when `mailboxes` goes out of scope.Creates the underlying native Chilkat object (Mailboxes also implements Default). Every method takes &self, so the object never needs to be declared mut. A Mailboxes is Send but not Sync: it may be moved to another thread, but a reference to it cannot be shared between threads at the same time.
The native object is freed when the Mailboxes is dropped — when it goes out of scope, or explicitly with drop(mailboxes). There is no Dispose method to call.
Errors
Methods that can fail return chilkat::Result<T>, which is Result<T, chilkat::Error>: a method whose only outcome is success or failure returns Result<()>, a method producing a string or an object returns Result<String> or Result<Mailboxes>. The error carries the object's LastErrorText at the time of the failure (Error::last_error_text), the class and method names, and implements std::error::Error, so ? works in any function returning chilkat::Result or a Box<dyn Error>. Properties never fail, and methods that answer a question (has_..., is_..., ...) return a plain bool.
match mailboxes.some_method(...) {
Ok(value) => println!("{value:?}"),
Err(e) => eprintln!("{}", e.last_error_text()),
}Properties
Count
pub fn count(&self) -> i32
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
pub fn debug_log_file_path(&self) -> String
pub fn set_debug_log_file_path(&self, value: &str)
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
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
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
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
pub fn last_method_success(&self) -> bool
pub fn set_last_method_success(&self, value: bool)
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
pub fn verbose_logging(&self) -> bool
pub fn set_verbose_logging(&self, value: bool)
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
Methods
GetFlags
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 Err(chilkat::Error) on failure.
GetMailboxIndex
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
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 Err(chilkat::Error) on failure.
GetNthFlag
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 Err(chilkat::Error) on failure.
GetNumFlags
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
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.
HasInferiors
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.
IsMarked
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.
IsSelectable
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.