Zend_Mail_Transport_Smtp Class Reference

Inheritance diagram for Zend_Mail_Transport_Smtp:

Public Member Functions
	__construct ($host='127.0.0.1', Array $config=array())
	__destruct ()
	setConnection (Zend_Mail_Protocol_Abstract $connection)
	getConnection ()
	_sendMail ()
Public Member Functions inherited from Zend_Mail_Transport_Abstract
	send (Zend_Mail $mail)

Data Fields
	$EOL = "\n"
Data Fields inherited from Zend_Mail_Transport_Abstract
	$body = ''
	$boundary = ''
	$header = ''
	$recipients = ''
	$EOL = "\r\n"

Protected Member Functions
	_prepareHeaders ($headers)
Protected Member Functions inherited from Zend_Mail_Transport_Abstract
	_sendMail ()
	_getHeaders ($boundary)
	_prepareHeaders ($headers)
	_buildBody ()

Protected Attributes
	$_host
	$_port
	$_name = 'localhost'
	$_auth
	$_config
	$_connection
Protected Attributes inherited from Zend_Mail_Transport_Abstract
	$_headers = array()
	$_isMultipart = false
	$_mail = false
	$_parts = array()

Additional Inherited Members
Static Protected Member Functions inherited from Zend_Mail_Transport_Abstract
static	_formatHeader (&$item, $key, $prefix)

Detailed Description

Definition at line 51 of file Smtp.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$host = '127.0.0.1',
		Array	$config = array()
	)

Constructor.

Parameters

string	$host	OPTIONAL (Default: 127.0.0.1)
array | null	$config	OPTIONAL (Default: null)

Returns

void

Todo:

Someone please make this compatible with the SendMail transport class.

Definition at line 118 of file Smtp.php.

    {
        if (isset($config['name'])) {
            $this->_name = $config['name'];
        }
        if (isset($config['port'])) {
            $this->_port = $config['port'];
        }
        if (isset($config['auth'])) {
            $this->_auth = $config['auth'];
        }

        $this->_host = $host;
        $this->_config = $config;
    }

__destruct()

__destruct

(

)

Class destructor to ensure all open connections are closed

Returns

void

Definition at line 140 of file Smtp.php.

    {
        if ($this->_connection instanceof Zend_Mail_Protocol_Smtp) {
            try {
                $this->_connection->quit();
            } catch (Zend_Mail_Protocol_Exception $e) {
                // ignore
            }
            $this->_connection->disconnect();
        }
    }

Member Function Documentation

_prepareHeaders()

_prepareHeaders (   $headers )

protected

Format and fix headers

Some SMTP servers do not strip BCC headers. Most clients do it themselves as do we.

@access protected

Parameters

array

$headers

Returns

void

Exceptions

Zend_Transport_Exception

See also

Zend_Mail_Transport_Exception

Definition at line 228 of file Smtp.php.

    {
        if (!$this->_mail) {
            #require_once 'Zend/Mail/Transport/Exception.php';
            throw new Zend_Mail_Transport_Exception('_prepareHeaders requires a registered Zend_Mail object');
        }

        unset($headers['Bcc']);

        // Prepare headers
        parent::_prepareHeaders($headers);
    }

_sendMail()

_sendMail

(

)

Send an email via the SMTP connection protocol

The connection via the protocol adapter is made just-in-time to allow a developer to add a custom adapter if required before mail is sent.

Returns

void

Todo:

Rename this to sendMail, it's a public method...

Definition at line 185 of file Smtp.php.

    {
        // If sending multiple messages per session use existing adapter
        if (!($this->_connection instanceof Zend_Mail_Protocol_Smtp)) {
            // Check if authentication is required and determine required class
            $connectionClass = 'Zend_Mail_Protocol_Smtp';
            if ($this->_auth) {
                $connectionClass .= '_Auth_' . ucwords($this->_auth);
            }
            if (!class_exists($connectionClass)) {
                #require_once 'Zend/Loader.php';
                Zend_Loader::loadClass($connectionClass);
            }
            $this->setConnection(new $connectionClass($this->_host, $this->_port, $this->_config));
            $this->_connection->connect();
            $this->_connection->helo($this->_name);
        } else {
            // Reset connection to ensure reliable transaction
            $this->_connection->rset();
        }

        // Set sender email address
        $this->_connection->mail($this->_mail->getReturnPath());

        // Set recipient forward paths
        foreach ($this->_mail->getRecipients() as $recipient) {
            $this->_connection->rcpt($recipient);
        }

        // Issue DATA command to client
        $this->_connection->data($this->header . Zend_Mime::LINEEND . $this->body);
    }

getConnection()

getConnection

(

)

Gets the connection protocol instance

Returns

Zend_Mail_Protocol|null

Definition at line 171 of file Smtp.php.

    {
        return $this->_connection;
    }

setConnection()

setConnection

(

Zend_Mail_Protocol_Abstract

$connection

)

Sets the connection protocol instance

Parameters

Zend_Mail_Protocol_Abstract

$client

Returns

void

Definition at line 160 of file Smtp.php.

    {
        $this->_connection = $connection;
    }

Field Documentation

$_auth

$_auth

protected

Definition at line 89 of file Smtp.php.

$_config

$_config

protected

Definition at line 97 of file Smtp.php.

$_connection

$_connection

protected

Definition at line 105 of file Smtp.php.

$_host

$_host

protected

Definition at line 65 of file Smtp.php.

$_name

$_name = 'localhost'

protected

Definition at line 81 of file Smtp.php.

$_port

$_port

protected

Definition at line 73 of file Smtp.php.

$EOL

$EOL = "\n"

Definition at line 58 of file Smtp.php.

---

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

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