Documentation

Horde_Imap_Client_Data_Format_Atom extends Horde_Imap_Client_Data_Format
in package

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

Tags
author

Michael Slusarz slusarz@horde.org

category

Horde

copyright

2012-2017 Horde LLC

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

Table of Contents

$_data  : mixed
Data.
__construct()  : mixed
Constructor.
__toString()  : string
Returns the string value of the raw data.
escape()  : string
Returns the data formatted for output to the IMAP server.
getData()  : mixed
Returns the raw data.
stripNonAtomCharacters()  : string
Strip out any characters that are not allowed in an IMAP atom.
verify()  : mixed
Verify the data.

Properties

$_data

Data.

protected mixed $_data

Methods

__construct()

Constructor.

public __construct(mixed $data) : mixed
Parameters
$data : mixed

Data.

Return values
mixed

__toString()

Returns the string value of the raw data.

public __toString() : string
Return values
string

String value.

escape()

Returns the data formatted for output to the IMAP server.

public escape() : string
Return values
string

IMAP escaped string.

getData()

Returns the raw data.

public getData() : mixed
Return values
mixed

Raw data.

stripNonAtomCharacters()

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

public stripNonAtomCharacters() : string
Return values
string

The atom data disallowed characters removed.

verify()

Verify the data.

public verify() : mixed
Return values
mixed

Search results