Technology & photography webblog

<?php
/**
 * This object redirects e-mails if development or test mode is enabled so customers are not bothered with test e-mails.
 * It should always be used instead of Zend_Mail where e-mails should be redirected to the testing address.
 * The most current known working version with which this object was tested is Zend Framework 1.7.0.
 * 
 * @version 1.0 
 * @uses Zend_Mail
 */
class ZendC_Mail extends Zend_Mail
{
     // ...

    /**
     * Global registry.
     * @var Zend_Registry
     */
    private $_registry;
    /**
     * Contains an array with all recipients.
     * @var array (of strings)
     */
    private $_tempRecipients;
    /**
     * Contains an array with original 'To' recipients when in test mode.
     * @var array (of strings)
     */
    private $_tempTo;
    /**
     * Contains an array with original 'Cc' recipients when in test mode.
     * @var mixed
     */
    private $_TempCc;
    /**
     * Contains an array with original 'Bcc' recipients when in test mode.
     * @var mixed
     */
    private $_TempBcc;
    /**
     * Contains a boolean value, is this enviroment test or not.
     * @var boolean
     */
    private $_devMode;

    /**
     * Public constructor
     *
     * @param string $charset
     */
    public function __construct ($charset = 'iso-8859-1')
    {
        // Set charset for this e-mail
        $this->_charset = $charset;
        // Get registry from Initializer.
        $this->_registry = Zend_Controller_Front::getInstance()->getPlugin('Initializer')->getRegistry();
        // Get the current enviroment mode.
        $env = Zend_Controller_Front::getInstance()->getPlugin('Initializer')->getEnv();
        // Set addTo to test address if development mode is enabled, or enviroment is not production.
        if ($this->_registry->developmentConfig->developmentMode || $env != 'production') {
            $this->_devMode = true;
            parent::addTo($this->_registry->developmentConfig->emailTestEmail, 'TEST recipient');
        } else {
            $this->_devMode = false;
        }
    }

    /**
     * Adds To-header and recipient
     *
     * @param  string $name
     * @param  string $email
     * @return Zend_Mail Provides fluent interface
     */
    public function addTo ($email, $name = '')
    {
        // Do nothing if development mode is enabled
        if ($this->_devMode) {
            if (parent::getBodyText() || parent::getBodyHtml()) {
                // Throw error if the body is already set before adding all recipients.
                // All recipients should be known in dev mode before body is set so no e-mail adrresses are omitted
                // in _tempRecipients for addition to the body text/hmtl later.
                throw new Zend_Mail_Exception('Error: Should set e-mail body after adding ALL the recipients!');
            }
            if ($name != '') {
                $this->_TempTo[] = $name . ' <' . $email . '>';
            } else {
                $this->_TempTo[] = $email;
            }
            $this->_tempRecipients[] = $email;
            return $this;
        } else {
            return parent::addTo($email, $name);
        }
    }
    /**
     * Adds Cc-header and recipient
     *
     * @param  string    $name
     * @param  string    $email
     * @return Zend_Mail Provides fluent interface
     */
    public function addCc ($email, $name = '')
    {
        // Do nothing if development mode is enabled
        if ($this->_devMode) {
            if (parent::getBodyText() || parent::getBodyHtml()) {
                // Throw error if the body is already set before adding all recipients.
                // All recipients should be known in dev mode before body is set so no e-mail adrresses are omitted
                // in _tempRecipients for addition to the body text/hmtl later.
                throw new Zend_Mail_Exception('Error: Should set e-mail body after adding ALL the recipients!');
            }
            if ($name != '') {
                $this->_TempCc[] = $name . ' <' . $email . '>';
            } else {
                $this->_TempCc[] = $email;
            }
            $this->_tempRecipients[] = $email;
            return $this;
        } else {
            return parent::addCc($email, $name);
        }
    }
    /**
     * Adds Bcc recipient
     *
     * @param  string    $email
     * @return Zend_Mail Provides fluent interface
     */
    public function addBcc ($email)
    {
        // Do nothing if development mode is enabled
        if ($this->_devMode) {
            if (parent::getBodyText() || parent::getBodyHtml()) {
                // Throw error if the body is already set before adding all recipients.
                // All recipients should be known in dev mode before body is set so no e-mail adrresses are omitted
                // in _tempRecipients for addition to the body text/hmtl later.
                throw new Zend_Mail_Exception('Error: Should set e-mail body after adding ALL the recipients!');
            }
            $this->_TempBcc[] = $email;
            $this->_tempRecipients[] = $email;
            return $this;
        } else {
            return parent::addBcc($email);
        }
    }

    // Disable custom, always return actual recipients not original in testmode.
    // Other application logic could use these and fail because the method returns the test address instead of the real addresses.
    // But it could be usefull in some cases so I wrote the method, but commented it out.
    //    /**
    //     * Return list of recipient email addresses
    //     *
    //     * @return array (of strings)
    //     */
    //    public function getRecipients()
    //    {
    //        // Do nothing if development mode is enabled
    //        if($this->_devMode) {
    //            return $this->_tempRecipients;
    //        } else {
    //            return parent::getRecipients();
    //        }
    //    }

    /**
     * Sets the text body for the message.
     *
     * @param  string $txt
     * @param  string $charset
     * @param  string $encoding
     * @return Zend_Mail Provides fluent interface
     */
    public function setBodyText ($txt, $charset = null, $encoding = Zend_Mime::ENCODING_QUOTEDPRINTABLE)
    {
        if ($this->_devMode) {
            if (count($this->_tempRecipients) == 0) {
                // Throw error if the body is set before adding all recipients.
                // All recipients should be known in dev mode before body is set.
                throw new Zend_Mail_Exception('Error: Should set e-mail body only after adding ALL the recipients!');
            }
            $txt = "Orginal reciepients:\n" . implode("\n", $this->_tempRecipients) . "\n\nOriginal text:\n" . $txt;
            return parent::setBodyText($txt, $charset, $encoding);
        } else {
            return parent::setBodyText($txt, $charset, $encoding);
        }
    }
    /**
     * Sets the HTML body for the message
     *
     * @param  string    $html
     * @param  string    $charset
     * @param  string    $encoding
     * @return Zend_Mail Provides fluent interface
     */
    public function setBodyHtml ($html, $charset = null, $encoding = Zend_Mime::ENCODING_QUOTEDPRINTABLE)
    {
        if ($this->_devMode) {
            if (count($this->_tempRecipients) == 0) {
                // Throw error if the body is set before adding all recipients.
                // All recipients should be known in dev mode before body is set.
                throw new Zend_Mail_Exception('Error: Should set e-mail body only after adding ALL the recipients!');
            }
            $html = 'Orginal reciepients:<br/>' . implode('<br/>', $this->_tempRecipients) . '<br/><br/>Original text:<br/>' . $html;
            return parent::setBodyHtml($html, $charset, $encoding);
        } else {
            return parent::setBodyHtml($html, $charset, $encoding);
        }
    }

    /**
     * Sets the subject of the message
     *
     * @param  string    $subject
     * @return Zend_Mail Provides fluent interface
     */
    public function setSubject ($subject)
    {
        if ($this->_devMode) {
            $subject = 'TEST ' . $subject;
        }
        return parent::setSubject($subject);
    }

}

$content = 'Content of the e-mail';
$mail = new ZendC_Mail();
$mail->addTo('to@address.com', 'name');
$mail->setFrom('from@address.com', 'name');
$mail->setSubject('Subject');
$mail->setBodyText($content);
$mail->send();

<?php
/**
 * This object redirects e-mails if development or test mode is enabled so customers are not bothered with test e-mails.
 * It should always be used instead of Zend_Mail where e-mails should be redirected to the testing address.
 * The most current known working version with which this object was tested is Zend Framework 1.7.0.
 * 
 * @version 1.0 
 * @uses Zend_Mail
 */
class ZendC_Mail extends Zend_Mail
{
    /**
     * Global registry.
     * @var Zend_Registry
     */
    private $_registry;
    /**
     * Contains an array with all recipients.
     * @var array (of strings)
     */
    private $_tempRecipients;
    /**
     * Contains an array with original 'To' recipients when in test mode.
     * @var array (of strings)
     */
    private $_tempTo;
    /**
     * Contains an array with original 'Cc' recipients when in test mode.
     * @var mixed
     */
    private $_TempCc;
    /**
     * Contains an array with original 'Bcc' recipients when in test mode.
     * @var mixed
     */
    private $_TempBcc;
    /**
     * Contains a boolean value, is this enviroment test or not.
     * @var boolean
     */
    private $_devMode;
    /**
     * Public constructor
     *
     * @param string $charset
     */
    public function __construct ($charset = 'iso-8859-1')
    {
        // Set charset for this e-mail
        $this->_charset = $charset;
        // Get registry from Initializer.
        $this->_registry = Zend_Controller_Front::getInstance()->getPlugin('Initializer')->getRegistry();
        // Get the current enviroment mode.
        $env = Zend_Controller_Front::getInstance()->getPlugin('Initializer')->getEnv();
        // Set addTo to test address if development mode is enabled, or enviroment is not production.
        if ($this->_registry->developmentConfig->developmentMode || $env != 'production') {
            $this->_devMode = true;
            parent::addTo($this->_registry->developmentConfig->emailTestEmail, 'TEST recipient');
        } else {
            $this->_devMode = false;
        }
    }
    /**
     * Adds To-header and recipient
     *
     * @param  string $name
     * @param  string $email
     * @return Zend_Mail Provides fluent interface
     */
    public function addTo ($email, $name = '')
    {
        // Do nothing if development mode is enabled
        if ($this->_devMode) {
            if (parent::getBodyText() || parent::getBodyHtml()) {
                // Throw error if the body is already set before adding all recipients.
                // All recipients should be known in dev mode before body is set so no e-mail adrresses are omitted
                // in _tempRecipients for addition to the body text/hmtl later.
                throw new Zend_Mail_Exception('Error: Should set e-mail body after adding ALL the recipients!');
            }
            if ($name != '') {
                $this->_TempTo[] = $name . ' <' . $email . '>';
            } else {
                $this->_TempTo[] = $email;
            }
            $this->_tempRecipients[] = $email;
            return $this;
        } else {
            return parent::addTo($email, $name);
        }
    }
    /**
     * Adds Cc-header and recipient
     *
     * @param  string    $name
     * @param  string    $email
     * @return Zend_Mail Provides fluent interface
     */
    public function addCc ($email, $name = '')
    {
        // Do nothing if development mode is enabled
        if ($this->_devMode) {
            if (parent::getBodyText() || parent::getBodyHtml()) {
                // Throw error if the body is already set before adding all recipients.
                // All recipients should be known in dev mode before body is set so no e-mail adrresses are omitted
                // in _tempRecipients for addition to the body text/hmtl later.
                throw new Zend_Mail_Exception('Error: Should set e-mail body after adding ALL the recipients!');
            }
            if ($name != '') {
                $this->_TempCc[] = $name . ' <' . $email . '>';
            } else {
                $this->_TempCc[] = $email;
            }
            $this->_tempRecipients[] = $email;
            return $this;
        } else {
            return parent::addCc($email, $name);
        }
    }
    /**
     * Adds Bcc recipient
     *
     * @param  string    $email
     * @return Zend_Mail Provides fluent interface
     */
    public function addBcc ($email)
    {
        // Do nothing if development mode is enabled
        if ($this->_devMode) {
            if (parent::getBodyText() || parent::getBodyHtml()) {
                // Throw error if the body is already set before adding all recipients.
                // All recipients should be known in dev mode before body is set so no e-mail adrresses are omitted
                // in _tempRecipients for addition to the body text/hmtl later.
                throw new Zend_Mail_Exception('Error: Should set e-mail body after adding ALL the recipients!');
            }
            $this->_TempBcc[] = $email;
            $this->_tempRecipients[] = $email;
            return $this;
        } else {
            return parent::addBcc($email);
        }
    }
    // Disable custom, always return actual recipients not original in testmode.
    // Other application logic could use these and fail because the method returns the test address instead of the real addresses.
    // But it could be usefull in some cases so I wrote the method, but commented it out.
    //    /**
    //     * Return list of recipient email addresses
    //     *
    //     * @return array (of strings)
    //     */
    //    public function getRecipients()
    //    {
    //        // Do nothing if development mode is enabled
    //        if($this->_devMode) {
    //            return $this->_tempRecipients;
    //        } else {
    //            return parent::getRecipients();
    //        }
    //    }
    /**
     * Sets the text body for the message.
     *
     * @param  string $txt
     * @param  string $charset
     * @param  string $encoding
     * @return Zend_Mail Provides fluent interface
     */
    public function setBodyText ($txt, $charset = null, $encoding = Zend_Mime::ENCODING_QUOTEDPRINTABLE)
    {
        if ($this->_devMode) {
            if (count($this->_tempRecipients) == 0) {
                // Throw error if the body is set before adding all recipients.
                // All recipients should be known in dev mode before body is set.
                throw new Zend_Mail_Exception('Error: Should set e-mail body only after adding ALL the recipients!');
            }
            $txt = "Orginal reciepients:\n" . implode("\n", $this->_tempRecipients) . "\n\nOriginal text:\n" . $txt;
            return parent::setBodyText($txt, $charset, $encoding);
        } else {
            return parent::setBodyText($txt, $charset, $encoding);
        }
    }
    /**
     * Sets the HTML body for the message
     *
     * @param  string    $html
     * @param  string    $charset
     * @param  string    $encoding
     * @return Zend_Mail Provides fluent interface
     */
    public function setBodyHtml ($html, $charset = null, $encoding = Zend_Mime::ENCODING_QUOTEDPRINTABLE)
    {
        if ($this->_devMode) {
            if (count($this->_tempRecipients) == 0) {
                // Throw error if the body is set before adding all recipients.
                // All recipients should be known in dev mode before body is set.
                throw new Zend_Mail_Exception('Error: Should set e-mail body only after adding ALL the recipients!');
            }
            $html = 'Orginal reciepients:<br/>' . implode('<br/>', $this->_tempRecipients) . '<br/><br/>Original text:<br/>' . $html;
            return parent::setBodyHtml($html, $charset, $encoding);
        } else {
            return parent::setBodyHtml($html, $charset, $encoding);
        }
    }
    /**
     * Sets the subject of the message
     *
     * @param  string    $subject
     * @return Zend_Mail Provides fluent interface
     */
    public function setSubject ($subject)
    {
        if ($this->_devMode) {
            $subject = 'TEST ' . $subject;
        }
        return parent::setSubject($subject);
    }
}