Horde_Imap_Client_Mailbox
in package
implements
Serializable
An object that provides a way to switch between UTF7-IMAP and human-readable representations of a mailbox name.
Tags
Interfaces, Classes, Traits and Enums
- Serializable
Table of Contents
- $list_escape : string
- $utf7imap : string
- $utf8 : string
- $_utf7imap : mixed
- UTF7-IMAP representation of mailbox.
- $_utf8 : string
- UTF8 representation of mailbox.
- __construct() : mixed
- Constructor.
- __get() : mixed
- __serialize() : array<string|int, mixed>
- __toString() : mixed
- __unserialize() : mixed
- equals() : bool
- Compares this mailbox to another mailbox string.
- get() : Horde_Imap_Client_Mailbox
- Shortcut to obtaining mailbox object.
- serialize() : mixed
- unserialize() : mixed
Properties
$list_escape read-only
public
string
$list_escape
Escapes mailbox for use in LIST command (UTF-8).
$utf7imap read-only
public
string
$utf7imap
Mailbox in UTF7-IMAP.
$utf8 read-only
public
string
$utf8
Mailbox in UTF-8.
$_utf7imap
UTF7-IMAP representation of mailbox.
protected
mixed
$_utf7imap
If boolean true, it is identical to UTF-8 representation.
$_utf8
UTF8 representation of mailbox.
protected
string
$_utf8
Methods
__construct()
Constructor.
public
__construct(string $mbox[, bool $utf7imap = false ]) : mixed
Parameters
- $mbox : string
-
The mailbox name.
- $utf7imap : bool = false
-
Is mailbox UTF7-IMAP encoded (true). Otherwise, mailbox is assumed to be UTF-8 encoded.
Return values
mixed —__get()
public
__get(mixed $name) : mixed
Parameters
- $name : mixed
Return values
mixed —__serialize()
public
__serialize() : array<string|int, mixed>
Return values
array<string|int, mixed> —__toString()
public
__toString() : mixed
Return values
mixed —__unserialize()
public
__unserialize(array<string|int, mixed> $data) : mixed
Parameters
- $data : array<string|int, mixed>
Return values
mixed —equals()
Compares this mailbox to another mailbox string.
public
equals(mixed $mbox) : bool
Parameters
- $mbox : mixed
Return values
bool —True if the items are equal.
get()
Shortcut to obtaining mailbox object.
public
static get(string $mbox[, bool $utf7imap = false ]) : Horde_Imap_Client_Mailbox
Parameters
- $mbox : string
-
The mailbox name.
- $utf7imap : bool = false
-
Is mailbox UTF7-IMAP encoded? Otherwise, mailbox is assumed to be UTF-8.
Return values
Horde_Imap_Client_Mailbox —A mailbox object.
serialize()
public
serialize() : mixed
Return values
mixed —unserialize()
public
unserialize(mixed $data) : mixed
Parameters
- $data : mixed