Documentation

Horde_Imap_Client_Mailbox_List
in package
implements Countable, IteratorAggregate

Container of IMAP mailboxes.

Tags
author

Michael Slusarz slusarz@horde.org

category

Horde

copyright

2004-2017 Horde LLC

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

Interfaces, Classes, Traits and Enums

Countable
IteratorAggregate

Table of Contents

$_delimiter  : string
The delimiter character to use.
$_mboxes  : array<string|int, mixed>
Mailbox list.
$_sortinbox  : bool
Should we sort with INBOX at the front of the list?
__construct()  : mixed
Constructor.
count()  : mixed
getIterator()  : mixed
sort()  : array<string|int, mixed>
Sort the list of mailboxes.
_mboxCompare()  : int
Hierarchical folder sorting function (used with usort()).

Properties

$_delimiter

The delimiter character to use.

protected string $_delimiter

$_mboxes

Mailbox list.

protected array<string|int, mixed> $_mboxes = array()

$_sortinbox

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

protected bool $_sortinbox

Methods

__construct()

Constructor.

public __construct(mixed $mboxes) : mixed
Parameters
$mboxes : mixed

A mailbox or list of mailboxes.

Return values
mixed

count()

public count() : mixed
Return values
mixed

getIterator()

public getIterator() : mixed
Return values
mixed

sort()

Sort the list of mailboxes.

public sort([array<string|int, mixed> $opts = array() ]) : array<string|int, mixed>
Parameters
$opts : array<string|int, mixed> = 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 values
array<string|int, mixed>

List of sorted mailboxes (index association is kept).

_mboxCompare()

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

protected final _mboxCompare(string $a, string $b) : int
Parameters
$a : string

Comparison item 1.

$b : string

Comparison item 2.

Return values
int

See usort().

Search results