Mailboxes Tcl Reference Documentation

Mailboxes

Represents a collection of IMAP mailboxes.

Object Creation

set myMailboxes [new CkMailboxes]

Properties

Count (integer)

set intVal [CkMailboxes_get_Count $myMailboxes]

The number of mailboxes in the collection.

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

Utf8 (boolean 1/0)

set boolVal [CkMailboxes_get_Utf8 $myMailboxes]
CkMailboxes_put_Utf8 $myMailboxes $boolVal

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

Methods

# index is an integer
# outStr is a CkString (output)
set status [CkMailboxes_GetFlags $index $outStr]
set retStr [CkMailboxes_getFlags $myMailboxes $index]

Returns a comma-separated list of flags for the Nth mailbox. For example, "\HasNoChildren,\Important".

Returns 1 for success, 0 for failure.

# mbxName is a string
set retInt [CkMailboxes_GetMailboxIndex $mbxName]

Returns the index of the mailbox having the specified name.

# index is an integer
# outStrName is a CkString (output)
set status [CkMailboxes_GetName $index $outStrName]
set retStr [CkMailboxes_getName $myMailboxes $index]

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

Returns 1 for success, 0 for failure.

# index is an integer
# flagIndex is an integer
# outStr is a CkString (output)
set status [CkMailboxes_GetNthFlag $index $flagIndex $outStr]
set retStr [CkMailboxes_getNthFlag $myMailboxes $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 1 for success, 0 for failure.

# index is an integer
set retInt [CkMailboxes_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
set retBool [CkMailboxes_HasFlag $index $flagName]

Returns 1 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
set retBool [CkMailboxes_HasInferiors $index]

Returns 1 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
set retBool [CkMailboxes_IsMarked $index]

Returns 1 if the Nth mailbox is marked.

# index is an integer
set retBool [CkMailboxes_IsSelectable $index]

Returns 1 if the Nth mailbox is selectable.

# task is a CkTask
set status [CkMailboxes_LoadTaskResult $task]

Introduced in version 9.5.0.52

Loads the mailboxes object from a completed asynchronous task.

Returns 1 for success, 0 for failure.