API Documentation
\

\Horde_Imap_Client_Mailbox

An object that provides a way to switch between UTF7-IMAP and human-readable representations of a mailbox name.

Summary

Methods
Properties
Constants
get()
__construct()
__get()
__toString()
equals()
serialize()
unserialize()
$list_escape
$utf7imap
$utf8
No constants found
No protected methods found
$_utf7imap
$_utf8
N/A
No private methods found
No private properties found
N/A

Properties

$list_escape

$list_escape : string

Escapes mailbox for use in LIST command (UTF-8).

Type

string

$utf7imap

$utf7imap : string

Mailbox in UTF7-IMAP.

Type

string

$utf8

$utf8 : string

Mailbox in UTF-8.

Type

string

$_utf7imap

$_utf7imap : mixed

UTF7-IMAP representation of mailbox.

If boolean true, it is identical to UTF-8 representation.

Type

mixed

$_utf8

$_utf8 : string

UTF8 representation of mailbox.

Type

string

Methods

get()

get(string  $mbox, boolean  $utf7imap = false) : \Horde_Imap_Client_Mailbox

Shortcut to obtaining mailbox object.

Parameters

string $mbox

The mailbox name.
boolean $utf7imap

Is mailbox UTF7-IMAP encoded? Otherwise, mailbox is assumed to be UTF-8.

Returns

\Horde_Imap_Client_Mailbox —

A mailbox object.

__construct()

__construct(string  $mbox, boolean  $utf7imap = false)

Constructor.

Parameters

string $mbox

The mailbox name.
boolean $utf7imap

Is mailbox UTF7-IMAP encoded (true). Otherwise, mailbox is assumed to be UTF-8 encoded.

__get()

__get(  $name)

Parameters

$name

__toString()

__toString()

equals()

equals(  $mbox) : boolean

Compares this mailbox to another mailbox string.

Parameters

$mbox

Returns

boolean —

True if the items are equal.

serialize()

serialize()

unserialize()

unserialize(  $data)

Parameters

$data