\Horde_Imap_Client_Data_Format_Astring

__construct()

__construct(mixed  $data) 

Constructor.

Parameters

__toString()

__toString() : string

Returns the string value of the raw data.

Returns

String value.

escape()

escape() : string

Returns the data formatted for output to the IMAP server.

Returns

IMAP escaped string.

escapeStream()

escapeStream() : resource

Return the escaped string as a stream.

Returns

The IMAP escaped stream.

quoted()

quoted() : boolean

Does this data item require quoted string output?

Returns

True if quoted output is required.

forceQuoted()

forceQuoted() 

Force item to be output quoted.

literal()

literal() : boolean

Does this data item require literal string output?

Returns

True if literal output is required.

forceLiteral()

forceLiteral() 

Force item to be output as a literal.

binary()

binary() : boolean

If literal output, is the data binary?

Returns

True if the literal output is binary.

forceBinary()

forceBinary() 

Force item to be output as a binary literal.

length()

length() : integer

Return the length of the data.

Returns

Data length.

getStream()

getStream() : \Horde_Stream

Return the contents of the string as a stream object.

Returns

The stream object.

getData()

getData() : mixed

Returns the raw data.

Returns

Raw data.

verify()

verify() 

Verify the data.

Throws

\Horde_Imap_Client_Data_Format_Exception

_filterParams()

_filterParams() : object

Return the base string filter parameters.

Returns

Filter parameters.