Zend Framework  1.12
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Zend_Mail_Protocol_Smtp Class Reference

Public Member Functions

 __construct ($host= '127.0.0.1', $port=null, array $config=array())
 Constructor.
 
 connect ()
 Connect to the server with the parameters given in the constructor.
 
 helo ($host= '127.0.0.1')
 Initiate HELO/EHLO sequence and set flag to indicate valid smtp session.
 
 mail ($from)
 Issues MAIL command.
 
 rcpt ($to)
 Issues RCPT command.
 
 data ($data)
 Issues DATA command.
 
 rset ()
 Issues the RSET command and validates answer.
 
 noop ()
 Issues the NOOP command and validates answer.
 
 vrfy ($user)
 Issues the VRFY command and validates answer.
 
 quit ()
 Issues the QUIT command and clears the current session.
 
 auth ()
 Default authentication method.
 
 disconnect ()
 Closes connection.
 
- Public Member Functions inherited from Zend_Mail_Protocol_Abstract
 __construct ($host= '127.0.0.1', $port=null)
 Constructor.
 
 __destruct ()
 Class destructor to cleanup open resources.
 
 setMaximumLog ($maximumLog)
 Set the maximum log size.
 
 getMaximumLog ()
 Get the maximum log size.
 
 connect ()
 Create a connection to the remote host.
 
 getRequest ()
 Retrieve the last client request.
 
 getResponse ()
 Retrieve the last server response.
 
 getLog ()
 Retrieve the transaction log.
 
 resetLog ()
 Reset the transaction log.
 

Protected Member Functions

 _ehlo ($host)
 Send EHLO or HELO depending on capabilities of smtp host.
 
 _startSession ()
 Start mail session.
 
 _stopSession ()
 Stop mail session.
 
- Protected Member Functions inherited from Zend_Mail_Protocol_Abstract
 _addLog ($value)
 Add the transaction log.
 
 _connect ($remote)
 Connect to the server using the supplied transport and target.
 
 _disconnect ()
 Disconnect from remote host and free resource.
 
 _send ($request)
 Send the given request followed by a LINEEND to the server.
 
 _receive ($timeout=null)
 
 _expect ($code, $timeout=null)
 Parse server response for successful codes.
 
 _setStreamTimeout ($timeout)
 Set stream timeout.
 

Protected Attributes

 $_transport = 'tcp'
 
 $_secure
 
 $_sess = false
 
 $_helo = false
 
 $_auth = false
 
 $_mail = false
 
 $_rcpt = false
 
 $_data = null
 
- Protected Attributes inherited from Zend_Mail_Protocol_Abstract
 $_maximumLog = 64
 
 $_host
 
 $_port
 
 $_validHost
 
 $_socket
 
 $_request
 
 $_response
 
 $_template = '%d%s'
 

Additional Inherited Members

- Public Attributes inherited from Zend_Mail_Protocol_Abstract
const EOL = "\r\n"
 Mail default EOL string.
 
const TIMEOUT_CONNECTION = 30
 Default timeout in seconds for initiating session.
 

Constructor & Destructor Documentation

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

Constructor.

Parameters
string$host
integer$port
array$config
Returns
void
Exceptions
Zend_Mail_Protocol_Exception
See Also
Zend_Mail_Protocol_Exception

Member Function Documentation

_ehlo (   $host)
protected

Send EHLO or HELO depending on capabilities of smtp host.

Parameters
string$hostThe client hostname or IP address (default: 127.0.0.1)
Exceptions
Zend_Mail_Protocol_Exception
Returns
void
_startSession ( )
protected

Start mail session.

Returns
void
_stopSession ( )
protected

Stop mail session.

Returns
void
auth ( )

Default authentication method.

This default method is implemented by AUTH adapters to properly authenticate to a remote host.

Exceptions
Zend_Mail_Protocol_Exception
Returns
void
See Also
Zend_Mail_Protocol_Exception
connect ( )

Connect to the server with the parameters given in the constructor.

Returns
boolean
data (   $data)

Issues DATA command.

Parameters
string$data
Exceptions
Zend_Mail_Protocol_Exception
Returns
void
See Also
Zend_Mail_Protocol_Exception
disconnect ( )

Closes connection.

Returns
void
helo (   $host = '127.0.0.1')

Initiate HELO/EHLO sequence and set flag to indicate valid smtp session.

Parameters
string$hostThe client hostname or IP address (default: 127.0.0.1)
Exceptions
Zend_Mail_Protocol_Exception
Returns
void
See Also
Zend_Mail_Protocol_Exception
Zend_Mail_Protocol_Exception
Zend_Mail_Protocol_Exception
mail (   $from)

Issues MAIL command.

Parameters
string$fromSender mailbox
Exceptions
Zend_Mail_Protocol_Exception
Returns
void
See Also
Zend_Mail_Protocol_Exception
noop ( )

Issues the NOOP command and validates answer.

Not used by Zend_Mail, could be used to keep a connection alive or check if it is still open.

Returns
void
quit ( )

Issues the QUIT command and clears the current session.

Returns
void
rcpt (   $to)

Issues RCPT command.

Parameters
string$toReceiver(s) mailbox
Exceptions
Zend_Mail_Protocol_Exception
Returns
void
See Also
Zend_Mail_Protocol_Exception
rset ( )

Issues the RSET command and validates answer.

Can be used to restore a clean smtp communication state when a transaction has been cancelled or commencing a new transaction.

Returns
void
vrfy (   $user)

Issues the VRFY command and validates answer.

Not used by Zend_Mail.

Parameters
string$userUser Name or eMail to verify
Returns
void

Member Data Documentation

$_auth = false
protected
$_data = null
protected
$_helo = false
protected
$_mail = false
protected
$_rcpt = false
protected
$_secure
protected
$_sess = false
protected
$_transport = 'tcp'
protected