Documentation

Horde_Imap_Client_Namespace_List
in package
implements ArrayAccess, Countable, IteratorAggregate

List of namespaces.

Tags
author

Michael Slusarz slusarz@horde.org

category

Horde

copyright

2014-2017 Horde LLC

license

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

since
2.21.0

Interfaces, Classes, Traits and Enums

ArrayAccess
Countable
IteratorAggregate

Table of Contents

$_ns  : array<string|int, mixed>
The list of namespace objects.
__construct()  : mixed
Constructor.
count()  : mixed
getIterator()  : mixed
getNamespace()  : mixed
Get namespace info for a full mailbox path.
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed

Properties

$_ns

The list of namespace objects.

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

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $ns = array() ]) : mixed
Parameters
$ns : array<string|int, mixed> = array()

The list of namespace objects.

Return values
mixed

count()

public count() : mixed
Return values
mixed

getIterator()

public getIterator() : mixed
Return values
mixed

getNamespace()

Get namespace info for a full mailbox path.

public getNamespace(string $mbox[, bool $personal = false ]) : mixed
Parameters
$mbox : string

The mailbox path.

$personal : bool = false

If true, will return the empty namespace only if it is a personal namespace.

Return values
mixed

The Horde_Imap_Client_Data_Namespace object for the mailbox path, or null if the path doesn't exist.

offsetExists()

public offsetExists(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed

offsetGet()

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed

offsetSet()

public offsetSet(mixed $offset, mixed $value) : mixed
Parameters
$offset : mixed
$value : mixed
Return values
mixed

offsetUnset()

public offsetUnset(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed

Search results