API Documentation
\

\Horde_Imap_Client_Mailbox_List

Container of IMAP mailboxes.

Summary

Methods
Properties
Constants
__construct()
sort()
count()
getIterator()
No public properties found
No constants found
_mboxCompare()
$_delimiter
$_mboxes
$_sortinbox
N/A
No private methods found
No private properties found
N/A

Properties

$_delimiter

$_delimiter : string

The delimiter character to use.

Type

string

$_mboxes

$_mboxes : array

Mailbox list.

Type

array

$_sortinbox

$_sortinbox : boolean

Should we sort with INBOX at the front of the list?

Type

boolean

Methods

__construct()

__construct(mixed  $mboxes)

Constructor.

Parameters

mixed $mboxes

A mailbox or list of mailboxes.

sort()

sort(array  $opts = array()) : array

Sort the list of mailboxes.

Parameters

array $opts

Options:

  • delimiter: (string) The delimiter to use. DEFAULT: '.'
  • inbox: (boolean) Always put INBOX at the head of the list? DEFAULT: Yes
  • noupdate: (boolean) Do not update the object's mailbox list? DEFAULT: true

Returns

array —

List of sorted mailboxes (index association is kept).

count()

count()

getIterator()

getIterator()

_mboxCompare()

_mboxCompare(string  $a, string  $b) : integer

Hierarchical folder sorting function (used with usort()).

Parameters

string $a

Comparison item 1.
string $b

Comparison item 2.

Returns

integer —

See usort().