API Documentation
\

\Horde_Imap_Client_Data_Format_Atom

Object representation of an IMAP atom (RFC 3501 [4.1]).

Summary

Methods
Properties
Constants
__construct()
__toString()
getData()
escape()
verify()
stripNonAtomCharacters()
No public properties found
No constants found
No protected methods found
$_data
N/A
No private methods found
No private properties found
N/A

Properties

$_data

$_data : mixed

Data.

Type

mixed

Methods

__construct()

__construct(mixed  $data)

Constructor.

Parameters

mixed $data

Data.

__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.

escape()

escape() : string

Returns the data formatted for output to the IMAP server.

Returns

string —

IMAP escaped string.

verify()

verify()

Verify the data.

stripNonAtomCharacters()

stripNonAtomCharacters() : string

Strip out any characters that are not allowed in an IMAP atom.

Returns

string —

The atom data disallowed characters removed.