API Documentation
\

\Horde_Imap_Client_Data_Format_Mailbox

Object representation of an IMAP mailbox string (RFC 3501 [9]).

Summary

Methods
Properties
Constants
quoted()
__construct()
__toString()
escape()
escapeStream()
forceQuoted()
literal()
forceLiteral()
binary()
forceBinary()
length()
getStream()
getData()
verify()
No public properties found
No constants found
_filterParams()
$_filter
$_data
$_encoding
$_mailbox
N/A
No private methods found
No private properties found
N/A

Properties

$_filter

$_filter : string

String filter parameters.

Type

string

$_data

$_data : mixed

Data.

Type

mixed

$_encoding

$_encoding : string

Mailbox encoding.

Type

string

Methods

quoted()

quoted() : boolean

Does this data item require quoted string output?

Returns

boolean —

True if quoted output is required.

__construct()

__construct(mixed  $data)

Parameters

mixed $data

Either a mailbox object or a UTF-8 mailbox name.

__toString()

__toString()

escape()

escape() : string

Returns the data formatted for output to the IMAP server.

Returns

string —

IMAP escaped string.

escapeStream()

escapeStream() : resource

Return the escaped string as a stream.

Returns

resource —

The IMAP escaped stream.

forceQuoted()

forceQuoted()

Force item to be output quoted.

literal()

literal() : boolean

Does this data item require literal string output?

Returns

boolean —

True if literal output is required.

forceLiteral()

forceLiteral()

Force item to be output as a literal.

binary()

binary()

Throws

\Horde_Imap_Client_Exception

forceBinary()

forceBinary()

Force item to be output as a binary literal.

length()

length()

getStream()

getStream()

getData()

getData()

verify()

verify()

Verify the data.

Throws

\Horde_Imap_Client_Data_Format_Exception

_filterParams()

_filterParams() : object

Return the base string filter parameters.

Returns

object —

Filter parameters.