• Home
  • Horde_Imap_Client_Mailbox_List

PHP Class Horde_Imap_Client_Mailbox_List, horde

Copyright 2004-2012 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Author: Michael Slusarz ([email protected])
Inheritance: implements Countable, implements IteratorAggregate
Mostra file Open project: horde/horde Class Usage Examples

Protected Properties

Property Type Description
$_delimiter string The delimiter character to use.
$_mboxes array Mailbox list.
$_sortinbox boolean Should we sort with INBOX at the front of the list?

Public Methods

Method Description
__construct ( mixed $mboxes ) Constructor.
count ( )
getIterator ( )
sort ( array $opts = [] ) : array Sort the list of mailboxes.

Protected Methods

Method Description
_mboxCompare ( string $a, string $b ) : integer Hierarchical folder sorting function (used with usort()).

Method Details

__construct() public method

Constructor.
public __construct ( mixed $mboxes )
$mboxes mixed A mailbox or list of mailboxes.

_mboxCompare() final protected method

Hierarchical folder sorting function (used with usort()).
final protected _mboxCompare ( string $a, string $b ) : integer
$a string Comparison item 1.
$b string Comparison item 2.
return integer See usort().

count() public method

public count ( )

getIterator() public method

public getIterator ( )

sort() public method

Sort the list of mailboxes.
public sort ( array $opts = [] ) : array
$opts array 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
return array List of sorted mailboxes (index association is kept).

Property Details

$_delimiter protected_oe property

The delimiter character to use.
protected string $_delimiter
return string

$_mboxes protected_oe property

Mailbox list.
protected array $_mboxes
return array

$_sortinbox protected_oe property

Should we sort with INBOX at the front of the list?
protected bool $_sortinbox
return boolean