Zend_Mail_Protocol_Smtp Class Reference

Inheritance diagram for Zend_Mail_Protocol_Smtp:

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 ()
Public Member Functions inherited from Zend_Mail_Protocol_Abstract
	__construct ($host='127.0.0.1', $port=null)
	__destruct ()
	setMaximumLog ($maximumLog)
	getMaximumLog ()
	connect ()
	getRequest ()
	getResponse ()
	getLog ()
	resetLog ()

Protected Member Functions
	_ehlo ($host)
	_startSession ()
	_stopSession ()
Protected Member Functions inherited from Zend_Mail_Protocol_Abstract
	_addLog ($value)
	_connect ($remote)
	_disconnect ()
	_send ($request)
	_receive ($timeout=null)
	_expect ($code, $timeout=null)
	_setStreamTimeout ($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
Data Fields inherited from Zend_Mail_Protocol_Abstract
const	EOL = "\r\n"
const	TIMEOUT_CONNECTION = 30

Detailed Description

Definition at line 48 of file Smtp.php.

Constructor & Destructor Documentation

__construct()

__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.

    {
        if (isset($config['ssl'])) {
            switch (strtolower($config['ssl'])) {
                case 'tls':
                    $this->_secure = 'tls';
                    break;

                case 'ssl':
                    $this->_transport = 'ssl';
                    $this->_secure = 'ssl';
                    if ($port == null) {
                        $port = 465;
                    }
                    break;

                default:
                    #require_once 'Zend/Mail/Protocol/Exception.php';
                    throw new Zend_Mail_Protocol_Exception($config['ssl'] . ' is unsupported SSL type');
                    break;
            }
        }

        // If no port has been specified then check the master PHP ini file. Defaults to 25 if the ini setting is null.
        if ($port == null) {
            if (($port = ini_get('smtp_port')) == '') {
                $port = 25;
            }
        }

        parent::__construct($host, $port);
    }

Member Function Documentation

_ehlo()

_ehlo (   $host )

protected

Send EHLO or HELO depending on capabilities of smtp host

Parameters

string

$host

The client hostname or IP address (default: 127.0.0.1)

Exceptions

Zend_Mail_Protocol_Exception

Returns

void

Definition at line 229 of file Smtp.php.

    {
        // Support for older, less-compliant remote servers. Tries multiple attempts of EHLO or HELO.
        try {
            $this->_send('EHLO ' . $host);
            $this->_expect(250, 300); // Timeout set for 5 minutes as per RFC 2821 4.5.3.2
        } catch (Zend_Mail_Protocol_Exception $e) {
            $this->_send('HELO ' . $host);
            $this->_expect(250, 300); // Timeout set for 5 minutes as per RFC 2821 4.5.3.2
        } catch (Zend_Mail_Protocol_Exception $e) {
            throw $e;
        }
    }

_startSession()

_startSession ( )

protected

Start mail session

Returns

void

Definition at line 429 of file Smtp.php.

    {
        $this->_sess = true;
    }

_stopSession()

_stopSession ( )

protected

Stop mail session

Returns

void

Definition at line 440 of file Smtp.php.

    {
        $this->_sess = false;
    }

auth()

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

Definition at line 401 of file Smtp.php.

    {
        if ($this->_auth === true) {
            #require_once 'Zend/Mail/Protocol/Exception.php';
            throw new Zend_Mail_Protocol_Exception('Already authenticated for this session');
        }
    }

connect()

connect

(

)

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

Returns

boolean

Definition at line 165 of file Smtp.php.

    {
        return $this->_connect($this->_transport . '://' . $this->_host . ':'. $this->_port);
    }

data()

data

(

$data

)

Issues DATA command

Parameters

string

$data

Exceptions

Zend_Mail_Protocol_Exception

Returns

void

See also

Zend_Mail_Protocol_Exception

Definition at line 302 of file Smtp.php.

    {
        // Ensure recipients have been set
        if ($this->_rcpt !== true) {
            #require_once 'Zend/Mail/Protocol/Exception.php';
            throw new Zend_Mail_Protocol_Exception('No recipient forward path has been supplied');
        }

        $this->_send('DATA');
        $this->_expect(354, 120); // Timeout set for 2 minutes as per RFC 2821 4.5.3.2

        foreach (explode(Zend_Mime::LINEEND, $data) as $line) {
            if (strpos($line, '.') === 0) {
                // Escape lines prefixed with a '.'
                $line = '.' . $line;
            }
            $this->_send($line);
        }

        $this->_send('.');
        $this->_expect(250, 600); // Timeout set for 10 minutes as per RFC 2821 4.5.3.2
        $this->_data = true;
    }

disconnect()

disconnect

(

)

Closes connection

Returns

void

Definition at line 418 of file Smtp.php.

    {
        $this->_disconnect();
    }

helo()

helo

(

$host = '127.0.0.1'

)

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

Parameters

string

$host

The 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.

    {
        // Respect RFC 2821 and disallow HELO attempts if session is already initiated.
        if ($this->_sess === true) {
            #require_once 'Zend/Mail/Protocol/Exception.php';
            throw new Zend_Mail_Protocol_Exception('Cannot issue HELO to existing session');
        }

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

        // Initiate helo sequence
        $this->_expect(220, 300); // Timeout set for 5 minutes as per RFC 2821 4.5.3.2
        $this->_ehlo($host);

        // If a TLS session is required, commence negotiation
        if ($this->_secure == 'tls') {
            $this->_send('STARTTLS');
            $this->_expect(220, 180);
            // TODO: Add STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT in the future when it is supported by PHP
            if (!stream_socket_enable_crypto($this->_socket, true, STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT)) {
                #require_once 'Zend/Mail/Protocol/Exception.php';
                throw new Zend_Mail_Protocol_Exception('Unable to connect via TLS');
            }
            $this->_ehlo($host);
        }

        $this->_startSession();
        $this->auth();
    }

mail()

mail

(

$from

)

Issues MAIL command

Parameters

string

$from

Sender mailbox

Exceptions

Zend_Mail_Protocol_Exception

Returns

void

See also

Zend_Mail_Protocol_Exception

Definition at line 251 of file Smtp.php.

    {
        if ($this->_sess !== true) {
            #require_once 'Zend/Mail/Protocol/Exception.php';
            throw new Zend_Mail_Protocol_Exception('A valid session has not been started');
        }

        $this->_send('MAIL FROM:<' . $from . '>');
        $this->_expect(250, 300); // Timeout set for 5 minutes as per RFC 2821 4.5.3.2

        // Set mail to true, clear recipients and any existing data flags as per 4.1.1.2 of RFC 2821
        $this->_mail = true;
        $this->_rcpt = false;
        $this->_data = false;
    }

noop()

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

Definition at line 356 of file Smtp.php.

    {
        $this->_send('NOOP');
        $this->_expect(250, 300); // Timeout set for 5 minutes as per RFC 2821 4.5.3.2
    }

quit()

quit

(

)

Issues the QUIT command and clears the current session

Returns

void

Definition at line 383 of file Smtp.php.

    {
        if ($this->_sess) {
            $this->_send('QUIT');
            $this->_expect(221, 300); // Timeout set for 5 minutes as per RFC 2821 4.5.3.2
            $this->_stopSession();
        }
    }

rcpt()

rcpt

(

$to

)

Issues RCPT command

Parameters

string

$to

Receiver(s) mailbox

Exceptions

Zend_Mail_Protocol_Exception

Returns

void

See also

Zend_Mail_Protocol_Exception

Definition at line 278 of file Smtp.php.

    {
        if ($this->_mail !== true) {
            #require_once 'Zend/Mail/Protocol/Exception.php';
            throw new Zend_Mail_Protocol_Exception('No sender reverse path has been supplied');
        }

        // Set rcpt to true, as per 4.1.1.3 of RFC 2821
        $this->_send('RCPT TO:<' . $to . '>');
        $this->_expect(array(250, 251), 300); // Timeout set for 5 minutes as per RFC 2821 4.5.3.2
        $this->_rcpt = true;
    }

rset()

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

Definition at line 337 of file Smtp.php.

    {
        $this->_send('RSET');
        // MS ESMTP doesn't follow RFC, see [ZF-1377]
        $this->_expect(array(250, 220));

        $this->_mail = false;
        $this->_rcpt = false;
        $this->_data = false;
    }

vrfy()

vrfy

(

$user

)

Issues the VRFY command and validates answer

Not used by Zend_Mail.

Parameters

string

$user

User Name or eMail to verify

Returns

void

Definition at line 371 of file Smtp.php.

    {
        $this->_send('VRFY ' . $user);
        $this->_expect(array(250, 251, 252), 300); // Timeout set for 5 minutes as per RFC 2821 4.5.3.2
    }

Field Documentation

$_auth

$_auth = false

protected

Definition at line 87 of file Smtp.php.

$_data

$_data = null

protected

Definition at line 111 of file Smtp.php.

$_helo

$_helo = false

protected

Definition at line 79 of file Smtp.php.

$_mail

$_mail = false

protected

Definition at line 95 of file Smtp.php.

$_rcpt

$_rcpt = false

protected

Definition at line 103 of file Smtp.php.

$_secure

$_secure

protected

Definition at line 63 of file Smtp.php.

$_sess

$_sess = false

protected

Definition at line 71 of file Smtp.php.

$_transport

$_transport = 'tcp'

protected

Definition at line 55 of file Smtp.php.

---

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

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