CkMailboxes Ruby Reference Documentation

CkMailboxes

Represents a collection of IMAP mailboxes.

Object Creation

obj = Chilkat::CkMailboxes.new()

Properties

# intVal is an integer
intVal = mailboxes.get_Count();

The number of mailboxes in the collection.

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

# boolVal is a boolean
boolVal = mailboxes.get_Utf8();
mailboxes.put_Utf8(boolVal);

When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.

Methods

# index is an integer
# 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.

# mbxName is a string
retInt = mailboxes.GetMailboxIndex(mbxName);

Returns the index of the mailbox having the specified name.

# index is an integer
# outStrName is a CkString (output)
status = mailboxes.GetName(index, outStrName);
retStr = mailboxes.getName(index);

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

Returns true for success, false for failure.

# index is an integer
# 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.

# index is an integer
retInt = mailboxes.GetNumFlags(index);

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

# index is an integer
# 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.

# index is an integer
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.

HasInferiors always True? (Why HasInferiors is Often Misunderstood)

# index is an integer
retBool = mailboxes.IsMarked(index);

Returns true if the Nth mailbox is marked.

# index is an integer
retBool = mailboxes.IsSelectable(index);

Returns true if the Nth mailbox is selectable.

# task is a CkTask
status = mailboxes.LoadTaskResult(task);

Introduced in version 9.5.0.52

Loads the mailboxes object from a completed asynchronous task.

Returns true for success, false for failure.