Public Member Functions | Protected Member Functions | Protected Attributes

Zend_Mail_Protocol_Smtp Class Reference

Inheritance diagram for Zend_Mail_Protocol_Smtp:
Zend_Mail_Protocol_Abstract Zend_Mail_Protocol_Smtp_Auth_Crammd5 Zend_Mail_Protocol_Smtp_Auth_Login Zend_Mail_Protocol_Smtp_Auth_Plain

Public Member Functions

 __construct ($host= '127.0.0.1', $port=null, array $config=array())
 connect ()
 helo ($host= '127.0.0.1')
 mail ($from)
 rcpt ($to)
 data ($data)
 rset ()
 noop ()
 vrfy ($user)
 quit ()
 auth ()
 disconnect ()

Protected Member Functions

 _ehlo ($host)
 _startSession ()
 _stopSession ()

Protected Attributes

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

Detailed Description

Definition at line 48 of file Smtp.php.


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

Definition at line 123 of file Smtp.php.


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

Definition at line 228 of file Smtp.php.

_startSession (  ) [protected]

Start mail session

Returns:
void

Definition at line 428 of file Smtp.php.

_stopSession (  ) [protected]

Stop mail session

Returns:
void

Definition at line 439 of file Smtp.php.

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

Reimplemented in Zend_Mail_Protocol_Smtp_Auth_Crammd5, Zend_Mail_Protocol_Smtp_Auth_Login, and Zend_Mail_Protocol_Smtp_Auth_Plain.

Definition at line 400 of file Smtp.php.

connect (  )

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

Returns:
boolean

Reimplemented from Zend_Mail_Protocol_Abstract.

Definition at line 165 of file Smtp.php.

data ( data )

Issues DATA command

Parameters:
string$data
Exceptions:
Zend_Mail_Protocol_Exception
Returns:
void

See also:
Zend_Mail_Protocol_Exception

Definition at line 301 of file Smtp.php.

disconnect (  )

Closes connection

Returns:
void

Definition at line 417 of file Smtp.php.

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

Definition at line 178 of file Smtp.php.

mail ( from )

Issues MAIL command

Parameters:
string$fromSender mailbox
Exceptions:
Zend_Mail_Protocol_Exception
Returns:
void

See also:
Zend_Mail_Protocol_Exception

Definition at line 250 of file Smtp.php.

noop (  )

Issues the NOOP command end validates answer

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

Returns:
void

Definition at line 355 of file Smtp.php.

quit (  )

Issues the QUIT command and clears the current session

Returns:
void

Definition at line 382 of file Smtp.php.

rcpt ( to )

Issues RCPT command

Parameters:
string$toReceiver(s) mailbox
Exceptions:
Zend_Mail_Protocol_Exception
Returns:
void

See also:
Zend_Mail_Protocol_Exception

Definition at line 277 of file Smtp.php.

rset (  )

Issues the RSET command end 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

Definition at line 336 of file Smtp.php.

vrfy ( user )

Issues the VRFY command end validates answer

Not used by Zend_Mail.

Parameters:
string$userUser Name or eMail to verify
Returns:
void

Definition at line 370 of file Smtp.php.


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