Zend_Mail_Transport_Sendmail Class Reference

Inheritance diagram for Zend_Mail_Transport_Sendmail:

Public Member Functions
	__construct ($parameters=null)
	_sendMail ()
	_handleMailErrors ($errno, $errstr, $errfile=null, $errline=null, array $errcontext=null)
Public Member Functions inherited from Zend_Mail_Transport_Abstract
	send (Zend_Mail $mail)

Data Fields
	$subject = null
	$parameters
	$EOL = PHP_EOL
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
	$_errstr
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 39 of file Sendmail.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$parameters = null

)

Constructor.

Parameters

string | array | Zend_Config

$parameters

OPTIONAL (Default: null)

Returns

void

Definition at line 74 of file Sendmail.php.

    {
        if ($parameters instanceof Zend_Config) {
            $parameters = $parameters->toArray();
        }

        if (is_array($parameters)) {
            $parameters = implode(' ', $parameters);
        }

        $this->parameters = $parameters;
    }

Member Function Documentation

_handleMailErrors()

_handleMailErrors	(		$errno,
			$errstr,
			$errfile = null,
			$errline = null,
		array	$errcontext = null
	)

Temporary error handler for PHP native mail().

Parameters

int	$errno
string	$errstr
string	$errfile
string	$errline
array	$errcontext

Returns

true

Definition at line 199 of file Sendmail.php.

    {
        $this->_errstr = $errstr;
        return true;
    }

_prepareHeaders()

_prepareHeaders (   $headers )

protected

Format and fix headers

mail() uses its $to and $subject arguments to set the To: and Subject: headers, respectively. This method strips those out as a sanity check to prevent duplicate header entries.

@access protected

Parameters

array

$headers

Returns

void

Exceptions

Zend_Mail_Transport_Exception

See also

Zend_Mail_Transport_Exception

Zend_Mail_Transport_Exception

Zend_Mail_Transport_Exception

Definition at line 127 of file Sendmail.php.

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

        // mail() uses its $to parameter to set the To: header, and the $subject
        // parameter to set the Subject: header. We need to strip them out.
        if (0 === strpos(PHP_OS, 'WIN')) {
            // If the current recipients list is empty, throw an error
            if (empty($this->recipients)) {
                #require_once 'Zend/Mail/Transport/Exception.php';
                throw new Zend_Mail_Transport_Exception('Missing To addresses');
            }
        } else {
            // All others, simply grab the recipients and unset the To: header
            if (!isset($headers['To'])) {
                #require_once 'Zend/Mail/Transport/Exception.php';
                throw new Zend_Mail_Transport_Exception('Missing To header');
            }

            unset($headers['To']['append']);
            $this->recipients = implode(',', $headers['To']);
        }

        // Remove recipient header
        unset($headers['To']);

        // Remove subject header, if present
        if (isset($headers['Subject'])) {
            unset($headers['Subject']);
        }

        // Sanitize the From header
        if (isset($headers['From'])) {
            $addressList = array_filter($headers['From'], function ($key) {
                return $key !== 'append';
            }, ARRAY_FILTER_USE_KEY);
            foreach ($addressList as $address) {
                if (preg_match('/\\\"/', $address)) {
                    throw new Zend_Mail_Transport_Exception('Potential code injection in From header');
                }
            }
        }

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

        // Fix issue with empty blank line ontop when using Sendmail Trnasport
        $this->header = rtrim($this->header);
    }

_sendMail()

_sendMail

(

)

Send mail using PHP native mail()

@access public

Returns

void

Exceptions

Zend_Mail_Transport_Exception	if parameters is set but not a string
Zend_Mail_Transport_Exception	on mail() failure

See also

Zend_Mail_Transport_Exception

Definition at line 96 of file Sendmail.php.

    {
        set_error_handler(array($this, '_handleMailErrors'));
        $result = mail(
            $this->recipients,
            $this->_mail->getSubject(),
            $this->body,
            $this->header);
        restore_error_handler();

        if ($this->_errstr !== null || !$result) {
            #require_once 'Zend/Mail/Transport/Exception.php';
            throw new Zend_Mail_Transport_Exception('Unable to send mail. ' . $this->_errstr);
        }
    }

Field Documentation

$_errstr

$_errstr

protected

Definition at line 66 of file Sendmail.php.

$EOL

$EOL = PHP_EOL

Definition at line 60 of file Sendmail.php.

$parameters

$parameters

Definition at line 53 of file Sendmail.php.

$subject

$subject = null

Definition at line 46 of file Sendmail.php.

---

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

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