API Documentation
\

\Horde_Imap_Client_Socket_Connection_Socket

PHP stream connection to the IMAP server.

NOTE: This class is NOT intended to be accessed outside of the package. There is NO guarantees that the API of this class will not change across versions.

Summary

Methods
Properties
Constants
write()
writeLiteral()
read()
$client_debug
No constants found
_connect()
$_protocol
$_buffer
N/A
No private methods found
No private properties found
N/A

Properties

$client_debug

$client_debug : boolean

If false, does not outpt the current line of client output to debug.

Type

boolean

$_protocol

$_protocol : string

Protocol type.

Type

string

$_buffer

$_buffer : string

Sending buffer.

Type

string

Methods

write()

write(string  $data, boolean  $eol = false)

Writes data to the IMAP output stream.

Parameters

string $data

String data.
boolean $eol

Append EOL?

Throws

\Horde_Imap_Client_Exception

writeLiteral()

writeLiteral(mixed  $data, integer  $length, boolean  $binary = false)

Writes literal data to the IMAP output stream.

Parameters

mixed $data

Either a stream resource, or Horde_Stream object.
integer $length

The literal length.
boolean $binary

If true, this is binary data.

Throws

\Horde_Imap_Client_Exception

read()

read(integer  $size = null) : \Horde_Imap_Client_Tokenize

Read data from incoming IMAP stream.

Parameters

integer $size

UNUSED: The number of bytes to read from the socket.

Throws

\Horde_Imap_Client_Exception

Returns

\Horde_Imap_Client_Tokenize —

The tokenized data.

_connect()

_connect(  $host,   $port,   $timeout,   $secure,   $context,   $retries)

Parameters

$host
$port
$timeout
$secure
$context
$retries