API Documentation
\

\Horde_Imap_Client_Data_Format_Mailbox_Utf8

Object representation of an IMAP mailbox string allowed when UTF8=ACCEPT is supported/enabled on the server (RFC 6855 [3]).

Summary

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

Properties

$_encoding

$_encoding : string

Mailbox encoding.

Type

string

$_filter

$_filter : string

String filter parameters.

Type

string

$_data

$_data : mixed

Data.

Type

mixed

Methods

__construct()

__construct(mixed  $data)

Parameters

mixed $data

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

__toString()

__toString() : string

Returns the string value of the raw data.

Returns

string —

String value.

getData()

getData() : mixed

Returns the raw data.

Returns

mixed —

Raw data.

binary()

binary() : boolean

If literal output, is the data binary?

Returns

boolean —

True if the literal output is binary.

length()

length() : integer

Return the length of the data.

Returns

integer —

Data length.

getStream()

getStream() : \Horde_Stream

Return the contents of the string as a stream object.

Returns

\Horde_Stream —

The stream object.

quoted()

quoted() : boolean

Does this data item require quoted string output?

Returns

boolean —

True if quoted output is required.

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.

forceBinary()

forceBinary()

Force item to be output as a binary literal.

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.