Documentation

Horde_Imap_Client_Data_Format_Mailbox extends Horde_Imap_Client_Data_Format_Astring
in package

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

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.
$_encoding  : string
Mailbox encoding.
$_filter  : string
String filter parameters.
$_mailbox  : Horde_Imap_Client_Mailbox
Mailbox object.
__construct()  : mixed
__toString()  : mixed
binary()  : mixed
escape()  : string
Returns the data formatted for output to the IMAP server.
escapeStream()  : resource
Return the escaped string as a stream.
forceBinary()  : mixed
Force item to be output as a binary literal.
forceLiteral()  : mixed
Force item to be output as a literal.
forceQuoted()  : mixed
Force item to be output quoted.
getData()  : mixed
getStream()  : mixed
length()  : mixed
literal()  : bool
Does this data item require literal string output?
quoted()  : bool
Does this data item require quoted string output?
verify()  : mixed
Verify the data.
_filterParams()  : object
Return the base string filter parameters.

Properties

$_data

Data.

protected mixed $_data

$_encoding

Mailbox encoding.

protected string $_encoding = 'utf7imap'

$_filter

String filter parameters.

protected string $_filter

Methods

__construct()

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

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

Return values
mixed

__toString()

public __toString() : mixed
Return values
mixed

escape()

Returns the data formatted for output to the IMAP server.

public escape() : string
Return values
string

IMAP escaped string.

escapeStream()

Return the escaped string as a stream.

public escapeStream() : resource
Return values
resource

The IMAP escaped stream.

forceBinary()

Force item to be output as a binary literal.

public forceBinary() : mixed
Return values
mixed

forceLiteral()

Force item to be output as a literal.

public forceLiteral() : mixed
Return values
mixed

forceQuoted()

Force item to be output quoted.

public forceQuoted() : mixed
Return values
mixed

getData()

public getData() : mixed
Return values
mixed

getStream()

public getStream() : mixed
Return values
mixed

length()

public length() : mixed
Return values
mixed

literal()

Does this data item require literal string output?

public literal() : bool
Return values
bool

True if literal output is required.

quoted()

Does this data item require quoted string output?

public quoted() : bool
Return values
bool

True if quoted output is required.

_filterParams()

Return the base string filter parameters.

protected _filterParams() : object
Return values
object

Filter parameters.

Search results