Mail/Protocol/Abstract.php

Show:

inherited

Classes
- \Zend_Mail_Protocol_Abstract

Table of Contents

Zend Framework

LICENSE This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Mail
Subpackage: Protocol
Version: $Id$

\Zend_Mail_Protocol_Abstract
jump to top

Package: Zend_Mail\Protocol

Zend_Mail_Protocol_Abstract

Provides low-level methods for concrete adapters to communicate with a remote mail server and track requests and responses.

Children: \Zend_Mail_Protocol_Smtp
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Todo: Implement proxy settings
Version: $Id$

Constants

 
                EOL
                = "\r\n"

Mail default EOL string

 
                TIMEOUT_CONNECTION
                = 30

Default timeout in seconds for initiating session

Properties

string $_host

Hostname or IP address of remote server

Details

Type: string

array $_log = array()

Log of mail requests and server responses for a session

Default valuearray()Details

Type: array

integer $_maximumLog = 64

Maximum of the transaction log

Default value64Details

Type: integer

integer $_port

Port number of connection

Details

Type: integer

string $_request

Last request sent to server

Details

Type: string

array $_response

Array of server responses to last request

Details

Type: array

resource $_socket

Socket connection resource

Details

Type: resource

resource $_template = '%d%s'

String template for parsing server responses using sscanf (default: 3 digit code and response string)

Default value'%d%s'Details

Type: resource
Deprecated: Since 1.10.3

\Zend_Validate $_validHost

Instance of Zend_Validate to check hostnames

Details

Type: \Zend_Validate

Methods

__construct(string $host = '127.0.0.1', integer $port = null) : void

Constructor.

Parameters

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

Throws

Exception	Description
\Zend_Mail_Protocol_Exception

__destruct() : void

Class destructor to cleanup open resources

_addLog( $value) : void

Add the transaction log

Parameters

Name	Type	Description
$value

_connect(string $remote) : boolean

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

Name	Type	Description
$remote	string	Remote

Returns

Type	Description
boolean

Throws

Exception	Description
\Zend_Mail_Protocol_Exception

_disconnect() : void

Disconnect from remote host and free resource

_expect(string | array $code, $timeout = null) : string

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

Name	Type	Description
$code	string \| array	One or more codes that indicate a successful response
$timeout

Returns

Type	Description
string	Last line of response string

Throws

Exception	Description
\Zend_Mail_Protocol_Exception

_receive( $timeout = null) : string

Get a line from the stream.

Parameters

Name	Type	Description
$timeout

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Mail_Protocol_Exception

Details

$timeout: integer

Per-request timeout value if applicable

_send(string $request) : integer | boolean

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

Parameters

Name	Type	Description
$request	string

Returns

Type	Description
integer \| boolean	Number of bytes written to remote host

Throws

Exception	Description
\Zend_Mail_Protocol_Exception

_setStreamTimeout(integer $timeout) : boolean

Set stream timeout

Parameters

Name	Type	Description
$timeout	integer

Returns

Type	Description
boolean

connect() : void

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

Retrieve the transaction log

Returns

Type	Description
string

getMaximumLog() : int

Get the maximum log size

Returns

Type	Description
int	the maximum log size

getRequest() : string

Retrieve the last client request

Returns

Type	Description
string

getResponse() : array

Retrieve the last server response

Returns

Type	Description
array

resetLog() : void

Reset the transaction log

setMaximumLog(integer $maximumLog) : void

Set the maximum log size

Parameters

Name	Type	Description
$maximumLog	integer	Maximum log size

Mail/Protocol/Abstract.php

\Zend_Mail_Protocol_Abstractjump to top

Constants

Properties

Methods

\Zend_Mail_Protocol_Abstract
jump to top