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.
Zend_Mail_Protocol_Abstract
Provides low-level methods for concrete adapters to communicate with a remote mail server and track requests and responses.

array
$_log= 'array()'
Log of mail requests and server responses for a session
array()
Details
resource
$_template= ''%d%s''
String template for parsing server responses using sscanf (default: 3 digit code and response string)
'%d%s'
Details
\Zend_Validate
$_validHost= ''
Instance of Zend_Validate to check hostnames

__construct(
string $host
=
'127.0.0.1', integer $port
=
null
)
:
void
Constructor.
Name | Type | Description |
---|---|---|
$host | string | OPTIONAL Hostname of remote connection (default: 127.0.0.1) |
$port | integer | OPTIONAL Port number (default: null) |
Exception | Description |
---|---|
\Zend_Mail_Protocol_Exception |

_addLog(
string $value
)
:
void
Add the transaction log
Name | Type | Description |
---|---|---|
$value | string | new transaction |

_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'
Name | Type | Description |
---|---|---|
$remote | string | Remote |
Type | Description |
---|---|
boolean |
Exception | Description |
---|---|
\Zend_Mail_Protocol_Exception |

_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.
Name | Type | Description |
---|---|---|
$code | string|array | One or more codes that indicate a successful response |
$timeout |
Type | Description |
---|---|
string | Last line of response string |
Exception | Description |
---|---|
\Zend_Mail_Protocol_Exception |

_receive(
$timeout
=
null
)
:
string
Get a line from the stream.
Name | Type | Description |
---|---|---|
$timeout |
Type | Description |
---|---|
string |
Exception | Description |
---|---|
\Zend_Mail_Protocol_Exception |

_send(
string $request
)
:
integer|boolean
Send the given request followed by a LINEEND to the server.
Name | Type | Description |
---|---|---|
$request | string |
Type | Description |
---|---|
integer|boolean | Number of bytes written to remote host |
Exception | Description |
---|---|
\Zend_Mail_Protocol_Exception |

_setStreamTimeout(
integer $timeout
)
:
boolean
Set stream timeout
Name | Type | Description |
---|---|---|
$timeout | integer |
Type | Description |
---|---|
boolean |

connect(
)
:
void
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.