Zend_Mail_Transport_Abstract Class Reference

Inheritance diagram for Zend_Mail_Transport_Abstract:

Public Member Functions
	send (Zend_Mail $mail)

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

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

Static Protected Member Functions
static	_formatHeader (&$item, $key, $prefix)

Protected Attributes
	$_headers = array()
	$_isMultipart = false
	$_mail = false
	$_parts = array()

Detailed Description

Definition at line 40 of file Abstract.php.

Member Function Documentation

_buildBody()

_buildBody ( )

protected

Generate MIME compliant message from the current configuration

If both a text and HTML body are present, generates a multipart/alternative Zend_Mime_Part containing the headers and contents of each. Otherwise, uses whichever of the text or HTML parts present.

The content part is then prepended to the list of Zend_Mime_Parts for this message.

Returns

void

See also

Zend_Mail_Transport_Exception

Definition at line 233 of file Abstract.php.

    {
        if (($text = $this->_mail->getBodyText())
            && ($html = $this->_mail->getBodyHtml()))
        {
            // Generate unique boundary for multipart/alternative
            $mime = new Zend_Mime(null);
            $boundaryLine = $mime->boundaryLine($this->EOL);
            $boundaryEnd  = $mime->mimeEnd($this->EOL);

            $text->disposition = false;
            $html->disposition = false;

            $body = $boundaryLine
                  . $text->getHeaders($this->EOL)
                  . $this->EOL
                  . $text->getContent($this->EOL)
                  . $this->EOL
                  . $boundaryLine
                  . $html->getHeaders($this->EOL)
                  . $this->EOL
                  . $html->getContent($this->EOL)
                  . $this->EOL
                  . $boundaryEnd;

            $mp           = new Zend_Mime_Part($body);
            $mp->type     = Zend_Mime::MULTIPART_ALTERNATIVE;
            $mp->boundary = $mime->boundary();

            $this->_isMultipart = true;

            // Ensure first part contains text alternatives
            array_unshift($this->_parts, $mp);

            // Get headers
            $this->_headers = $this->_mail->getHeaders();
            return;
        }

        // If not multipart, then get the body
        if (false !== ($body = $this->_mail->getBodyHtml())) {
            array_unshift($this->_parts, $body);
        } elseif (false !== ($body = $this->_mail->getBodyText())) {
            array_unshift($this->_parts, $body);
        }

        if (!$body) {
            #require_once 'Zend/Mail/Transport/Exception.php';
            throw new Zend_Mail_Transport_Exception('No body specified');
        }

        // Get headers
        $this->_headers = $this->_mail->getHeaders();
        $headers = $body->getHeadersArray($this->EOL);
        foreach ($headers as $header) {
            // Headers in Zend_Mime_Part are kept as arrays with two elements, a
            // key and a value
            $this->_headers[$header[0]] = array($header[1]);
        }
    }

_formatHeader()

static _formatHeader ( &  $item,   $key,   $prefix  )

staticprotected

Prepend header name to header value

Parameters

string	$item
string	$key
string	$prefix	@access protected

Returns

void

Definition at line 165 of file Abstract.php.

    {
        $item = $prefix . ': ' . $item;
    }

_getHeaders()

_getHeaders (   $boundary )

protected

Return all mail headers as an array

If a boundary is given, a multipart header is generated with a Content-Type of either multipart/alternative or multipart/mixed depending on the mail parts present in the Zend_Mail object present.

Parameters

string

$boundary

Returns

array

Definition at line 127 of file Abstract.php.

    {
        if (null !== $boundary) {
            // Build multipart mail
            $type = $this->_mail->getType();
            if (!$type) {
                if ($this->_mail->hasAttachments) {
                    $type = Zend_Mime::MULTIPART_MIXED;
                } elseif ($this->_mail->getBodyText() && $this->_mail->getBodyHtml()) {
                    $type = Zend_Mime::MULTIPART_ALTERNATIVE;
                } else {
                    $type = Zend_Mime::MULTIPART_MIXED;
                }
            }

            $this->_headers['Content-Type'] = array(
                $type . ';'
                . $this->EOL
                . " " . 'boundary="' . $boundary . '"'
            );
            $this->boundary = $boundary;
        }

        $this->_headers['MIME-Version'] = array('1.0');

        return $this->_headers;
    }

_prepareHeaders()

_prepareHeaders (   $headers )

protected

Prepare header string for use in transport

Prepares and generates $header based on the headers provided.

Parameters

mixed

$headers

@access protected

Returns

void

Exceptions

Zend_Mail_Transport_Exception

if any header lines exceed 998 characters

See also

Zend_Mail_Transport_Exception

Zend_Mail_Transport_Exception

Definition at line 181 of file Abstract.php.

    {
        if (!$this->_mail) {
            #require_once 'Zend/Mail/Transport/Exception.php';
            throw new Zend_Mail_Transport_Exception('Missing Zend_Mail object in _mail property');
        }

        $this->header = '';

        foreach ($headers as $header => $content) {
            if (isset($content['append'])) {
                unset($content['append']);
                $value = implode(',' . $this->EOL . ' ', $content);
                $this->header .= $header . ': ' . $value . $this->EOL;
            } else {
                array_walk($content, array(get_class($this), '_formatHeader'), $header);
                $this->header .= implode($this->EOL, $content) . $this->EOL;
            }
        }

        // Sanity check on headers -- should not be > 998 characters
        $sane = true;
        foreach (explode($this->EOL, $this->header) as $line) {
            if (strlen(trim($line)) > 998) {
                $sane = false;
                break;
            }
        }
        if (!$sane) {
            #require_once 'Zend/Mail/Transport/Exception.php';
            throw new Zend_Mail_Exception('At least one mail header line is too long');
        }
    }

_sendMail()

_sendMail ( )

abstractprotected

Send an email independent from the used transport

The requisite information for the email will be found in the following properties:

• $recipients - list of recipients (string)
• $header - message header
• $body - message body

send()

send

(

Zend_Mail

$mail

)

Send a mail using this transport

Parameters

Zend_Mail

$mail

@access public

Returns

void

Exceptions

Zend_Mail_Transport_Exception

if mail is empty

See also

Zend_Mail_Transport_Exception

Definition at line 305 of file Abstract.php.

    {
        $this->_isMultipart = false;
        $this->_mail        = $mail;
        $this->_parts       = $mail->getParts();
        $mime               = $mail->getMime();

        // Build body content
        $this->_buildBody();

        // Determine number of parts and boundary
        $count    = count($this->_parts);
        $boundary = null;
        if ($count < 1) {
            #require_once 'Zend/Mail/Transport/Exception.php';
            throw new Zend_Mail_Transport_Exception('Empty mail cannot be sent');
        }

        if ($count > 1) {
            // Multipart message; create new MIME object and boundary
            $mime     = new Zend_Mime($this->_mail->getMimeBoundary());
            $boundary = $mime->boundary();
        } elseif ($this->_isMultipart) {
            // multipart/alternative -- grab boundary
            $boundary = $this->_parts[0]->boundary;
        }

        // Determine recipients, and prepare headers
        $this->recipients = implode(',', $mail->getRecipients());
        $this->_prepareHeaders($this->_getHeaders($boundary));

        // Create message body
        // This is done so that the same Zend_Mail object can be used in
        // multiple transports
        $message = new Zend_Mime_Message();
        $message->setParts($this->_parts);
        $message->setMime($mime);
        $this->body = $message->generateMessage($this->EOL);

        // Send to transport!
        $this->_sendMail();
    }

Field Documentation

$_headers

$_headers = array()

protected

Definition at line 68 of file Abstract.php.

$_isMultipart

$_isMultipart = false

protected

Definition at line 75 of file Abstract.php.

$_mail

$_mail = false

protected

Definition at line 82 of file Abstract.php.

$_parts

$_parts = array()

protected

Definition at line 89 of file Abstract.php.

$body

$body = ''

Definition at line 47 of file Abstract.php.

$boundary

$boundary = ''

Definition at line 54 of file Abstract.php.

$EOL

$EOL = "\r\n"

Definition at line 103 of file Abstract.php.

$header

$header = ''

Definition at line 61 of file Abstract.php.

$recipients

$recipients = ''

Definition at line 96 of file Abstract.php.

---

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

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