Documentation

Horde_Imap_Client_Data_Format_Mailbox_Utf8 extends Horde_Imap_Client_Data_Format_Mailbox
in package
implements Horde_Imap_Client_Data_Format_String_Support_Nonascii

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

Tags
author

Michael Slusarz slusarz@horde.org

category

Horde

copyright

2014-2017 Horde LLC

license

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

Interfaces, Classes, Traits and Enums

Horde_Imap_Client_Data_Format_String_Support_Nonascii
Interface a Horde_Imap_Client_Data_Format_String object should extend if it supports non-ASCII output (RFC 3501 [4.3.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()  : string
Returns the string value of the raw data.
binary()  : bool
If literal output, is the data binary?
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
Returns the raw data.
getStream()  : Horde_Stream
Return the contents of the string as a stream object.
length()  : int
Return the length of the data.
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 = 'utf8'

$_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()

Returns the string value of the raw data.

public __toString() : string
Return values
string

String value.

binary()

If literal output, is the data binary?

public binary() : bool
Return values
bool

True if the literal output is binary.

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()

Returns the raw data.

public getData() : mixed
Return values
mixed

Raw data.

getStream()

Return the contents of the string as a stream object.

public getStream() : Horde_Stream
Tags
since
2.3.0
Return values
Horde_Stream

The stream object.

length()

Return the length of the data.

public length() : int
Tags
since
2.2.0
Return values
int

Data length.

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