CkMailboxes Perl Programming
Reference Documentation

CkMailboxes

Represents a collection of IMAP mailboxes.

Properties

# Returns an integer value
get_Count( )

The number of mailboxes in the collection.

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

# Returns a boolean value
get_Utf8( )

# b is a boolean (input)
put_Utf8( b )

When set to true, all "const char *" arguments are expected to be utf-8 strings. If set to false, the "const char *" arguments are expected to be ANSI strings.

Methods

# index is an integer (input)
# strName is a CkString object (output)
# Returns a boolean value
GetName( index, strName )

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

Returns 1 for success, 0 for failure.

# index is an integer (input)
# Returns a boolean value
HasInferiors( index )

Returns 1 if the Nth mailbox has inferiors (i.e. sub-mailboxes)

# index is an integer (input)
# Returns a boolean value
IsMarked( index )

Returns 1 if the Nth mailbox is marked.

# index is an integer (input)
# Returns a boolean value
IsSelectable( index )

Returns 1 if the Nth mailbox is selectable.

# index is an integer (input)
# Returns a string
getName( index )

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