Zend_Mail_Protocol_Abstract Class Reference

Inheritance diagram for Zend_Mail_Protocol_Abstract:

Public Member Functions
	__construct ($host='127.0.0.1', $port=null)
	__destruct ()
	setMaximumLog ($maximumLog)
	getMaximumLog ()
	connect ()
	getRequest ()
	getResponse ()
	getLog ()
	resetLog ()

Data Fields
const	EOL = "\r\n"
const	TIMEOUT_CONNECTION = 30

Protected Member Functions
	_addLog ($value)
	_connect ($remote)
	_disconnect ()
	_send ($request)
	_receive ($timeout=null)
	_expect ($code, $timeout=null)
	_setStreamTimeout ($timeout)

Protected Attributes
	$_maximumLog = 64
	$_host
	$_port
	$_validHost
	$_socket
	$_request
	$_response
	$_template = '%d%s'

Detailed Description

Definition at line 50 of file Abstract.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$host = '127.0.0.1',
			$port = null
	)

Constructor.

Parameters

string	$host	OPTIONAL Hostname of remote connection (default: 127.0.0.1)
integer	$port	OPTIONAL Port number (default: null)

Exceptions

Zend_Mail_Protocol_Exception

Returns

void

See also

Zend_Mail_Protocol_Exception

Definition at line 135 of file Abstract.php.

    {
        $this->_validHost = new Zend_Validate();
        $this->_validHost->addValidator(new Zend_Validate_Hostname(Zend_Validate_Hostname::ALLOW_ALL));

        if (!$this->_validHost->isValid($host)) {
            #require_once 'Zend/Mail/Protocol/Exception.php';
            throw new Zend_Mail_Protocol_Exception(join(', ', $this->_validHost->getMessages()));
        }

        $this->_host = $host;
        $this->_port = $port;
    }

__destruct()

__destruct

(

)

Class destructor to cleanup open resources

Returns

void

Definition at line 158 of file Abstract.php.

    {
        $this->_disconnect();
    }

Member Function Documentation

_addLog()

_addLog (   $value )

protected

Add the transaction log

Parameters

string

new transaction

Returns

void

Definition at line 243 of file Abstract.php.

    {
        if ($this->_maximumLog >= 0 && count($this->_log) >= $this->_maximumLog) {
            array_shift($this->_log);
        }

        $this->_log[] = $value;
    }

_connect()

_connect (   $remote )

protected

Connect to the server using the supplied transport and target

An example $remote string may be 'tcp://mail.example.com:25' or 'ssh://hostname.com:2222'

Parameters

string

$remote

Remote

Exceptions

Zend_Mail_Protocol_Exception

Returns

boolean

See also

Zend_Mail_Protocol_Exception

Zend_Mail_Protocol_Exception

Definition at line 261 of file Abstract.php.

    {
        $errorNum = 0;
        $errorStr = '';

        // open connection
        $this->_socket = @stream_socket_client($remote, $errorNum, $errorStr, self::TIMEOUT_CONNECTION);

        if ($this->_socket === false) {
            if ($errorNum == 0) {
                $errorStr = 'Could not open socket';
            }
            #require_once 'Zend/Mail/Protocol/Exception.php';
            throw new Zend_Mail_Protocol_Exception($errorStr);
        }

        if (($result = $this->_setStreamTimeout(self::TIMEOUT_CONNECTION)) === false) {
            #require_once 'Zend/Mail/Protocol/Exception.php';
            throw new Zend_Mail_Protocol_Exception('Could not set stream timeout');
        }

        return $result;
    }

_disconnect()

_disconnect ( )

protected

Disconnect from remote host and free resource

Returns

void

Definition at line 297 of file Abstract.php.

    {
        if (is_resource($this->_socket)) {
            fclose($this->_socket);
        }
    }

_expect()

_expect (   $code,   $timeout = null  )

protected

Parse server response for successful codes

Read the response from the stream and check for expected return code. Throws a Zend_Mail_Protocol_Exception if an unexpected code is returned.

Parameters

string | array

$code

One or more codes that indicate a successful response

Exceptions

Zend_Mail_Protocol_Exception

Returns

string Last line of response string

See also

Zend_Mail_Protocol_Exception

Definition at line 402 of file Abstract.php.

    {
        $this->_response = array();
        $cmd  = '';
        $more = '';
        $msg  = '';
        $errMsg = '';

        if (!is_array($code)) {
            $code = array($code);
        }

        do {
            $this->_response[] = $result = $this->_receive($timeout);
            list($cmd, $more, $msg) = preg_split('/([\s-]+)/', $result, 2, PREG_SPLIT_DELIM_CAPTURE);

            if ($errMsg !== '') {
                $errMsg .= ' ' . $msg;
            } elseif ($cmd === null || !in_array($cmd, $code)) {
                $errMsg =  $msg;
            }

        } while (strpos($more, '-') === 0); // The '-' message prefix indicates an information string instead of a response string.

        if ($errMsg !== '') {
            #require_once 'Zend/Mail/Protocol/Exception.php';
            throw new Zend_Mail_Protocol_Exception($errMsg, $cmd);
        }

        return $msg;
    }

_receive()

_receive (   $timeout = null )

protected

See also

Zend_Mail_Protocol_Exception

Zend_Mail_Protocol_Exception

Zend_Mail_Protocol_Exception

Definition at line 348 of file Abstract.php.

    {
        if (!is_resource($this->_socket)) {
            #require_once 'Zend/Mail/Protocol/Exception.php';
            throw new Zend_Mail_Protocol_Exception('No connection has been established to ' . $this->_host);
        }

        // Adapters may wish to supply per-commend timeouts according to appropriate RFC
        if ($timeout !== null) {
            $this->_setStreamTimeout($timeout);
        }

        // Retrieve response
        $reponse = fgets($this->_socket, 1024);

        // Save request to internal log
        $this->_addLog($reponse);

        // Check meta data to ensure connection is still valid
        $info = stream_get_meta_data($this->_socket);

        if (!empty($info['timed_out'])) {
            #require_once 'Zend/Mail/Protocol/Exception.php';
            throw new Zend_Mail_Protocol_Exception($this->_host . ' has timed out');
        }

        if ($reponse === false) {
            #require_once 'Zend/Mail/Protocol/Exception.php';
            throw new Zend_Mail_Protocol_Exception('Could not read from ' . $this->_host);
        }

        return $reponse;
    }

_send()

_send (   $request )

protected

Send the given request followed by a LINEEND to the server.

Parameters

string

$request

Exceptions

Zend_Mail_Protocol_Exception

Returns

integer|boolean Number of bytes written to remote host

See also

Zend_Mail_Protocol_Exception

Zend_Mail_Protocol_Exception

Definition at line 312 of file Abstract.php.

    {
        if (!is_resource($this->_socket)) {
            #require_once 'Zend/Mail/Protocol/Exception.php';
            throw new Zend_Mail_Protocol_Exception('No connection has been established to ' . $this->_host);
        }

        $this->_request = $request;

        $result = fwrite($this->_socket, $request . self::EOL);

        // Save request to internal log
        $this->_addLog($request . self::EOL);

        if ($result === false) {
            #require_once 'Zend/Mail/Protocol/Exception.php';
            throw new Zend_Mail_Protocol_Exception('Could not send request to ' . $this->_host);
        }

        return $result;
    }

_setStreamTimeout()

_setStreamTimeout (   $timeout )

protected

Set stream timeout

Parameters

integer

$timeout

Returns

boolean

Definition at line 443 of file Abstract.php.

    {
       return stream_set_timeout($this->_socket, $timeout);
    }

connect()

connect ( )

abstract

Create a connection to the remote host

Concrete adapters for this class will implement their own unique connect scripts, using the _connect() method to create the socket resource.

getLog()

getLog

(

)

Retrieve the transaction log

Returns

string

Definition at line 221 of file Abstract.php.

    {
        return implode('', $this->_log);
    }

getMaximumLog()

getMaximumLog

(

)

Get the maximum log size

Returns

int the maximum log size

Definition at line 180 of file Abstract.php.

    {
        return $this->_maximumLog;
    }

getRequest()

getRequest

(

)

Retrieve the last client request

Returns

string

Definition at line 199 of file Abstract.php.

    {
        return $this->_request;
    }

getResponse()

getResponse

(

)

Retrieve the last server response

Returns

array

Definition at line 210 of file Abstract.php.

    {
        return $this->_response;
    }

resetLog()

resetLog

(

)

Reset the transaction log

Returns

void

Definition at line 232 of file Abstract.php.

    {
        $this->_log = array();
    }

setMaximumLog()

setMaximumLog

(

$maximumLog

)

Set the maximum log size

Parameters

integer

$maximumLog

Maximum log size

Returns

void

Definition at line 169 of file Abstract.php.

    {
        $this->_maximumLog = (int) $maximumLog;
    }

Field Documentation

$_host

$_host

protected

Definition at line 74 of file Abstract.php.

$_maximumLog

$_maximumLog = 64

protected

Definition at line 67 of file Abstract.php.

$_port

$_port

protected

Definition at line 81 of file Abstract.php.

$_request

$_request

protected

Definition at line 102 of file Abstract.php.

$_response

$_response

protected

Definition at line 109 of file Abstract.php.

$_socket

$_socket

protected

Definition at line 95 of file Abstract.php.

$_template

$_template = '%d%s'

protected

Definition at line 117 of file Abstract.php.

$_validHost

$_validHost

protected

Definition at line 88 of file Abstract.php.

EOL

const EOL = "\r\n"

Mail default EOL string

Definition at line 55 of file Abstract.php.

TIMEOUT_CONNECTION

const TIMEOUT_CONNECTION = 30

Default timeout in seconds for initiating session

Definition at line 61 of file Abstract.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Mail/Protocol/Abstract.php