Swift_Mime_SimpleMessage

Complexity

Total Complexity

72

Size/Duplication

Total Lines	658
Duplicated Lines	16.11 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

97.79%

Importance

Changes

0

38 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	29	1
A	getNestingLevel()	0	4	1
A	setSubject()	0	8	2
A	getSubject()	0	4	1
A	setDate()	0	8	2
A	getDate()	0	4	1
A	setReturnPath()	0	8	2
A	getReturnPath()	0	4	1
A	setSender()	12	12	4
A	getSender()	0	4	1
A	addFrom()	0	7	1
A	setFrom()	12	12	4
A	getFrom()	0	4	1
A	addReplyTo()	0	7	1
A	setReplyTo()	12	12	4
A	getReplyTo()	0	4	1
A	addTo()	0	7	1
A	setTo()	12	12	4
A	getTo()	0	4	1
A	addCc()	0	7	1
A	setCc()	12	12	4
A	getCc()	0	4	1
A	addBcc()	0	7	1
A	setBcc()	12	12	4
A	getBcc()	0	4	1
B	setPriority()	0	24	4
A	getPriority()	0	7	2
A	setReadReceiptTo()	0	8	2
A	getReadReceiptTo()	0	4	1
A	attach()	0	6	1
A	detach()	0	12	3
A	embed()	0	6	1
A	toString()	18	18	3
A	__toString()	0	4	1
A	toByteStream()	16	16	3
A	_getIdField()	0	4	1
A	_becomeMimePart()	0	18	1
A	_getTopNestingLevel()	0	12	3

<?php

/*
 * This file is part of SwiftMailer.
 * (c) 2004-2009 Chris Corbyn
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

/**
 * The default email message class.
 *
 * @author Chris Corbyn
 */
class Swift_Mime_SimpleMessage extends Swift_Mime_MimePart implements Swift_Mime_Message

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    const PRIORITY_HIGHEST = 1;
    const PRIORITY_HIGH = 2;
    const PRIORITY_NORMAL = 3;
    const PRIORITY_LOW = 4;
    const PRIORITY_LOWEST = 5;

    /**
     * Create a new SimpleMessage with $headers, $encoder and $cache.
     *
     * @param Swift_Mime_HeaderSet      $headers
     * @param Swift_Mime_ContentEncoder $encoder
     * @param Swift_KeyCache            $cache
     * @param Swift_IdGenerator         $idGenerator
     * @param string                    $charset
     */
    public function __construct(Swift_Mime_HeaderSet $headers, Swift_Mime_ContentEncoder $encoder, Swift_KeyCache $cache, Swift_IdGenerator $idGenerator, $charset = null)
    {
        parent::__construct($headers, $encoder, $cache, $idGenerator, $charset);
        $this->getHeaders()->defineOrdering(
            array(
                'Return-Path',
                'Received',
                'DKIM-Signature',
                'DomainKey-Signature',
                'Sender',
                'Message-ID',
                'Date',
                'Subject',
                'From',
                'Reply-To',
                'To',
                'Cc',
                'Bcc',
                'MIME-Version',
                'Content-Type',
                'Content-Transfer-Encoding',
            )
        );
        $this->getHeaders()->setAlwaysDisplayed(array('Date', 'Message-ID', 'From'));
        $this->getHeaders()->addTextHeader('MIME-Version', '1.0');
        $this->setDate(time());
        $this->setId($this->getId());
        $this->getHeaders()->addMailboxHeader('From');
    }

    /**
     * Always returns {@link LEVEL_TOP} for a message instance.
     *
     * @return int
     */
    public function getNestingLevel()
    {
        return self::LEVEL_TOP;
    }

    /**
     * Set the subject of this message.
     *
     * @param string $subject
     *
     * @return $this
     */
    public function setSubject($subject)
    {
        if (!$this->_setHeaderFieldModel('Subject', $subject)) {
            $this->getHeaders()->addTextHeader('Subject', $subject);
        }

        return $this;
    }

    /**
     * Get the subject of this message.
     *
     * @return null|string
     */
    public function getSubject()
    {
        return $this->_getHeaderFieldModel('Subject');

The expression $this->_getHeaderFieldModel('Subject'); of type null|string[]|string adds the type string[] to the return on line 96 which is incompatible with the return type declared by the interface Swift_Mime_Message::getSubject of type string.

    }

    /**
     * Set the date at which this message was created.
     *
     * @param int $date
     *
     * @return $this
     */
    public function setDate($date)
    {
        if (!$this->_setHeaderFieldModel('Date', $date)) {
            $this->getHeaders()->addDateHeader('Date', $date);
        }

        return $this;
    }

    /**
     * Get the date at which this message was created.
     *
     * @return null|string
     */
    public function getDate()
    {
        return $this->_getHeaderFieldModel('Date');

The expression $this->_getHeaderFieldModel('Date'); of type null|string[]|string adds the type string[] to the return on line 122 which is incompatible with the return type declared by the interface Swift_Mime_Message::getDate of type integer.

    }

    /**
     * Set the return-path (the bounce address) of this message.
     *
     * @param string $address
     *
     * @return $this
     */
    public function setReturnPath($address)
    {
        if (!$this->_setHeaderFieldModel('Return-Path', $address)) {
            $this->getHeaders()->addPathHeader('Return-Path', $address);
        }

        return $this;
    }

    /**
     * Get the return-path (bounce address) of this message.
     *
     * @return null|string
     */
    public function getReturnPath()
    {
        return $this->_getHeaderFieldModel('Return-Path');

The expression $this->_getHeaderFieldModel('Return-Path'); of type null|string[]|string adds the type string[] to the return on line 148 which is incompatible with the return type declared by the interface Swift_Mime_Message::getReturnPath of type string.

    }

    /**
     * Set the sender of this message.
     *
     * This does not override the From field, but it has a higher significance.
     *
     * @param string|array $address
     * @param string $name optional
     *
     * @return $this
     */
    public function setSender($address, $name = null)

This method seems to be duplicated in your project.

    {
        if (!is_array($address) && isset($name)) {
            $address = array($address => $name);
        }

        if (!$this->_setHeaderFieldModel('Sender', (array)$address)) {
            $this->getHeaders()->addMailboxHeader('Sender', (array)$address);
        }

        return $this;
    }

    /**
     * Get the sender of this message.
     *
     * @return null|string
     */
    public function getSender()
    {
        return $this->_getHeaderFieldModel('Sender');

The expression $this->_getHeaderFieldModel('Sender'); of type null|string[]|string adds the type string to the return on line 181 which is incompatible with the return type declared by the interface Swift_Mime_Message::getSender of type string[].

    }

    /**
     * Add a From: address to this message.
     *
     * If $name is passed this name will be associated with the address.
     *
     * @param string $address
     * @param string $name optional
     *
     * @return $this
     */
    public function addFrom($address, $name = null)
    {
        $current = $this->getFrom();
        $current[$address] = $name;

        return $this->setFrom($current);
    }

    /**
     * Set the from address of this message.
     *
     * You may pass an array of addresses if this message is from multiple people.
     *
     * If $name is passed and the first parameter is a string, this name will be
     * associated with the address.
     *
     * @param string|array $addresses
     * @param string $name optional
     *
     * @return $this
     */
    public function setFrom($addresses, $name = null)

This method seems to be duplicated in your project.

    {
        if (!is_array($addresses) && isset($name)) {
            $addresses = array($addresses => $name);
        }

        if (!$this->_setHeaderFieldModel('From', (array)$addresses)) {
            $this->getHeaders()->addMailboxHeader('From', (array)$addresses);
        }

        return $this;
    }

    /**
     * Get the from address of this message.
     *
     * @return null|string[]
     */
    public function getFrom()
    {
        return $this->_getHeaderFieldModel('From');

The expression $this->_getHeaderFieldModel('From'); of type null|string[]|string adds the type string to the return on line 235 which is incompatible with the return type declared by the interface Swift_Mime_Message::getFrom of type string[].

    }

    /**
     * Add a Reply-To: address to this message.
     *
     * If $name is passed this name will be associated with the address.
     *
     * @param string $address
     * @param string $name optional
     *
     * @return $this
     */
    public function addReplyTo($address, $name = null)
    {
        $current = $this->getReplyTo();
        $current[$address] = $name;

        return $this->setReplyTo($current);
    }

    /**
     * Set the reply-to address of this message.
     *
     * You may pass an array of addresses if replies will go to multiple people.
     *
     * If $name is passed and the first parameter is a string, this name will be
     * associated with the address.
     *
     * @param mixed $addresses
     * @param string $name optional
     *
     * @return $this
     */
    public function setReplyTo($addresses, $name = null)

This method seems to be duplicated in your project.

    {
        if (!is_array($addresses) && isset($name)) {
            $addresses = array($addresses => $name);
        }

        if (!$this->_setHeaderFieldModel('Reply-To', (array)$addresses)) {
            $this->getHeaders()->addMailboxHeader('Reply-To', (array)$addresses);
        }

        return $this;
    }

    /**
     * Get the reply-to address of this message.
     *
     * @return null|string[]
     */
    public function getReplyTo()
    {
        return $this->_getHeaderFieldModel('Reply-To');

The expression $this->_getHeaderFieldModel('Reply-To'); of type null|string[]|string adds the type string to the return on line 289 which is incompatible with the return type declared by the interface Swift_Mime_Message::getReplyTo of type string[].

    }

    /**
     * Add a To: address to this message.
     *
     * If $name is passed this name will be associated with the address.
     *
     * @param string $address
     * @param string $name optional
     *
     * @return $this
     */
    public function addTo($address, $name = null)
    {
        $current = $this->getTo();
        $current[$address] = $name;

        return $this->setTo($current);
    }

    /**
     * Set the to addresses of this message.
     *
     * If multiple recipients will receive the message an array should be used.
     * Example: array('receiver@domain.org', 'other@domain.org' => 'A name')
     *
     * If $name is passed and the first parameter is a string, this name will be
     * associated with the address.
     *
     * @param mixed $addresses
     * @param string $name optional
     *
     * @return $this
     */
    public function setTo($addresses, $name = null)

This method seems to be duplicated in your project.

    {
        if (!is_array($addresses) && isset($name)) {
            $addresses = array($addresses => $name);
        }

        if (!$this->_setHeaderFieldModel('To', (array)$addresses)) {
            $this->getHeaders()->addMailboxHeader('To', (array)$addresses);
        }

        return $this;
    }

    /**
     * Get the To addresses of this message.
     *
     * @return null|string[]
     */
    public function getTo()
    {
        return $this->_getHeaderFieldModel('To');

The expression $this->_getHeaderFieldModel('To'); of type null|string[]|string adds the type string to the return on line 344 which is incompatible with the return type declared by the interface Swift_Mime_Message::getTo of type string[].

    }

    /**
     * Add a Cc: address to this message.
     *
     * If $name is passed this name will be associated with the address.
     *
     * @param string $address
     * @param string $name optional
     *
     * @return $this
     */
    public function addCc($address, $name = null)
    {
        $current = $this->getCc();
        $current[$address] = $name;

        return $this->setCc($current);
    }

    /**
     * Set the Cc addresses of this message.
     *
     * If $name is passed and the first parameter is a string, this name will be
     * associated with the address.
     *
     * @param string[]|string $addresses
     * @param string $name optional
     *
     * @return $this
     */
    public function setCc($addresses, $name = null)

This method seems to be duplicated in your project.

    {
        if (!is_array($addresses) && isset($name)) {
            $addresses = array($addresses => $name);
        }

        if (!$this->_setHeaderFieldModel('Cc', (array)$addresses)) {
            $this->getHeaders()->addMailboxHeader('Cc', (array)$addresses);
        }

        return $this;
    }

    /**
     * Get the Cc address of this message.
     *
     * @return null|string[]
     */
    public function getCc()
    {
        return $this->_getHeaderFieldModel('Cc');

The expression $this->_getHeaderFieldModel('Cc'); of type null|string[]|string adds the type string to the return on line 396 which is incompatible with the return type declared by the interface Swift_Mime_Message::getCc of type string[].

    }

    /**
     * Add a Bcc: address to this message.
     *
     * If $name is passed this name will be associated with the address.
     *
     * @param string $address
     * @param string $name optional
     *
     * @return $this
     */
    public function addBcc($address, $name = null)
    {
        $current = $this->getBcc();
        $current[$address] = $name;

        return $this->setBcc($current);
    }

    /**
     * Set the Bcc addresses of this message.
     *
     * If $name is passed and the first parameter is a string, this name will be
     * associated with the address.
     *
     * @param mixed $addresses
     * @param string $name optional
     *
     * @return $this
     */
    public function setBcc($addresses, $name = null)

This method seems to be duplicated in your project.

    {
        if (!is_array($addresses) && isset($name)) {
            $addresses = array($addresses => $name);
        }

        if (!$this->_setHeaderFieldModel('Bcc', (array)$addresses)) {
            $this->getHeaders()->addMailboxHeader('Bcc', (array)$addresses);
        }

        return $this;
    }

    /**
     * Get the Bcc addresses of this message.
     *
     * @return null|string[]
     */
    public function getBcc()
    {
        return $this->_getHeaderFieldModel('Bcc');

The expression $this->_getHeaderFieldModel('Bcc'); of type null|string[]|string adds the type string to the return on line 448 which is incompatible with the return type declared by the interface Swift_Mime_Message::getBcc of type string[].

    }

    /**
     * Set the priority of this message.
     *
     * The value is an integer where 1 is the highest priority and 5 is the lowest.
     *
     * @param int $priority
     *
     * @return $this
     */
    public function setPriority($priority)
    {
        $priorityMap = array(
            self::PRIORITY_HIGHEST => 'Highest',
            self::PRIORITY_HIGH => 'High',
            self::PRIORITY_NORMAL => 'Normal',
            self::PRIORITY_LOW => 'Low',
            self::PRIORITY_LOWEST => 'Lowest',
            );
        $pMapKeys = array_keys($priorityMap);
        if ($priority > max($pMapKeys)) {
            $priority = max($pMapKeys);
        } elseif ($priority < min($pMapKeys)) {
            $priority = min($pMapKeys);
        }
        if (!$this->_setHeaderFieldModel('X-Priority',
            sprintf('%d (%s)', $priority, $priorityMap[$priority]))
        ) {
            $this->getHeaders()->addTextHeader('X-Priority',
                sprintf('%d (%s)', $priority, $priorityMap[$priority]));
        }

        return $this;
    }

    /**
     * Get the priority of this message.
     *
     * The returned value is an integer where 1 is the highest priority and 5
     * is the lowest.
     *
     * @return int
     */
    public function getPriority()
    {
        /** @noinspection PrintfScanfArgumentsInspection */
        list($priority) = sscanf($this->_getHeaderFieldModel('X-Priority'), '%[1-5]');

        return isset($priority) ? $priority : 3;
    }

    /**
     * Ask for a delivery receipt from the recipient to be sent to $addresses.
     *
     * @param array $addresses
     *
     * @return $this
     */
    public function setReadReceiptTo($addresses)
    {
        if (!$this->_setHeaderFieldModel('Disposition-Notification-To', $addresses)) {
            $this->getHeaders()->addMailboxHeader('Disposition-Notification-To', $addresses);
        }

        return $this;
    }

    /**
     * Get the addresses to which a read-receipt will be sent.
     *
     * @return null|string[]
     */
    public function getReadReceiptTo()
    {
        return $this->_getHeaderFieldModel('Disposition-Notification-To');
    }

    /**
     * Attach a {@link Swift_Mime_MimeEntity} such as an Attachment or MimePart.
     *
     * @param Swift_Mime_MimeEntity $entity
     *
     * @return $this
     */
    public function attach(Swift_Mime_MimeEntity $entity)
    {
        $this->setChildren(array_merge($this->getChildren(), array($entity)));

        return $this;
    }

    /**
     * Remove an already attached entity.
     *
     * @param Swift_Mime_MimeEntity $entity
     *
     * @return $this
     */
    public function detach(Swift_Mime_MimeEntity $entity)
    {
        $newChildren = array();
        foreach ($this->getChildren() as $child) {
            if ($entity !== $child) {
                $newChildren[] = $child;
            }
        }
        $this->setChildren($newChildren);

        return $this;
    }

    /**
     * Attach a {@link Swift_Mime_MimeEntity} and return it's CID source.
     * This method should be used when embedding images or other data in a message.
     *
     * @param Swift_Mime_MimeEntity $entity
     *
     * @return string
     */
    public function embed(Swift_Mime_MimeEntity $entity)
    {
        $this->attach($entity);

        return 'cid:' . $entity->getId();
    }

    /**
     * Get this message as a complete string.
     *
     * @return string
     */
    public function toString()

This method seems to be duplicated in your project.

    {
        $children = $this->getChildren();

        if (
            count($children) > 0
            &&
            $this->getBody() // WARNING: don't try to use strict comparision here
        ) {
            $this->setChildren(array_merge(array($this->_becomeMimePart()), $children));
            $string = parent::toString();
            $this->setChildren($children);
        } else {
            $string = parent::toString();
        }

        return $string;
    }

    /**
     * Returns a string representation of this object.
     *
     * @see toString()
     *
     * @return string
     */
    public function __toString()
    {
        return $this->toString();
    }

    /**
     * Write this message to a {@link Swift_InputByteStream}.
     *
     * @param Swift_InputByteStream $is
     */
    public function toByteStream(Swift_InputByteStream $is)

This method seems to be duplicated in your project.

    {
        $children = $this->getChildren();

        if (
            count($children) > 0
            &&
            $this->getBody() // WARNING: don't try to use strict comparision here
        ) {
            $this->setChildren(array_merge(array($this->_becomeMimePart()), $children));
            parent::toByteStream($is);
            $this->setChildren($children);
        } else {
            parent::toByteStream($is);
        }
    }

    /** @see Swift_Mime_SimpleMimeEntity::_getIdField() */
    protected function _getIdField()
    {
        return 'Message-ID';
    }

    /** Turn the body of this message into a child of itself if needed */
    protected function _becomeMimePart()
    {
        $part = new parent(
            $this->getHeaders()->newInstance(),
            $this->getEncoder(),
            $this->_getCache(),
            $this->_getIdGenerator(),
            $this->_userCharset
        );
        $part->setContentType($this->_userContentType);
        $part->setBody($this->getBody());
        $part->setFormat($this->_userFormat);
        $part->setDelSp($this->_userDelSp);
        $part->setMaxLineLength($this->getMaxLineLength());
        $part->_setNestingLevel($this->_getTopNestingLevel());

        return $part;
    }

    /** Get the highest nesting level nested inside this message */
    private function _getTopNestingLevel()
    {
        $highestLevel = $this->getNestingLevel();
        foreach ($this->getChildren() as $child) {
            $childLevel = $child->getNestingLevel();
            if ($highestLevel < $childLevel) {
                $highestLevel = $childLevel;
            }
        }

        return $highestLevel;
    }
}