simplemail.php

<?php
/**
 * LightPHP Framework
 * LitePHP is a framework that has been designed to be lite waight, extensible and fast.
 * 
 * @author Robert Pitt <robertpitt1988@gmail.com>
 * @category core
 * @copyright 2013 Robert Pitt
 * @license GPL v3 - GNU Public License v3
 * @version 1.0.0
 */

/**
 * This class phpsimplemail
 * @link(PHP Simple Mail, https://github.com/eoghanobrien/php-simple-mail)
 */
class Simplemail_Library
{
    /**
     * Control-Return-Line-Feed used to seperate data in the email.
     */
    const CRLF = "\r\n";

    /**
     * @var int $_wrap
     */
    protected $_wrap = 78;

    /**
     * @var string $_to
     */
    protected $_to = array();

    /**
     * @var string $_bcc
     */
    protected $_bcc = array();

    /**
     * @var string $_subject
     */
    protected $_subject;

    /**
     * @var string $_message
     */
    protected $_message;

    /**
     * @var array $_headers
     */
    protected $_headers = array();

    /**
     * @var string $_parameters
     */
    protected $_parameters;

    /**
     * @var array $_attachments
     */
    protected $_attachments = array();

    /**
     * @var array $_attachmentsPath
     */
    protected $_attachmentsPath = array();

    /**
     * @var array $_attachment_filename
     */
    protected $_attachmentsFilename = array();

    /**
     * __construct.
     */
    public function __construct()
    {
        $this->reset();
    }

    /**
     * Resets all variables to initial state.
     *
     * @return Simplemail_Library
     */
    public function reset()
    {
        $this->to                   = array();
        $this->bcc                  = array();
        $this->_headers             = array();
        $this->_subject             = null;
        $this->_message             = null;
        $this->_wrap                = 78;
        $this->_parameters          = null;
        $this->_attachments         = array();
        $this->_attachmentsPath     = array();
        $this->_attachmentsFilename = array();

        //Return the context
        return $this;
    }

    /**
     * setTo.
     *
     * @param  string $email
     * @param  string $name
     *
     * @throws InvalidArgumentException on non string value for $email
     * @throws InvalidArgumentException on non string value for $name
     *
     * @return Simplemail_Library
     */
    public function setTo($email, $name)
    {
        if (! is_string($email)) {
            throw new InvalidArgumentException('$email - must be a string');
        }

        if (! is_string($name)) {
            throw new InvalidArgumentException('$name - must be a string.');
        }

        $this->to[] = $this->formatHeader($email, $name);

        return $this;
    }

    /**
     * setTo.
     *
     * @param  string $email
     * @param  string $name
     *
     * @throws InvalidArgumentException on non string value for $email
     * @throws InvalidArgumentException on non string value for $name
     *
     * @return Simplemail_Library
     */
    public function setBcc($email, $name)
    {
        if (! is_string($email)) {
            throw new InvalidArgumentException('$email - must be a string');
        }

        if (! is_string($name)) {
            throw new InvalidArgumentException('$name - must be a string.');
        }

        $this->bcc[] = $this->formatHeader($email, $name);

        return $this;
    }

    /**
     * Return an array of formatted To addresses.
     *
     * @return array
     */
    public function getTo()
    {
        return $this->to;
    }

    /**
     * setSubject function.
     *
     * @param  string$subject
     * @throws InvalidArgumentException on non string value for $subject
     * @return Simplemail_Library
     */
    public function setSubject($subject)
    {
        if (! is_string($subject)) {
            throw new InvalidArgumentException('$subject - must be a string.');
        }

        $this->_subject = $this->filterOther($subject);

        return $this;
    }

    /**
     * getSubject function.
     *
     * @return string
     */
    public function getSubject()
    {
        return $this->_subject;
    }

    /**
     * setMessage function.
     *
     * @access public
     * @param  string $message
     * @throws InvalidArgumentException on non string value for $message
     * @return Simplemail_Library
     */
    public function setMessage($message)
    {
        if (! is_string($message)) {
            throw new InvalidArgumentException('$message - must be a string.');
        }

        $this->_message = str_replace("\n.", "\n..", $message);

        return $this;
    }

    /**
     * getMessage function.
     *
     * @return string
     */
    public function getMessage()
    {
        return $this->_message;
    }

    /**
     * addAttachment function.
     *
     * @todo   Test this.
     * @access public
     * @param  string $path
     * @param  string $filename
     * @return Simplemail_Library
     */
    public function addAttachment($path, $filename = null)
    {
        $filename = empty($filename) ? basename($path) : $filename;
        $this->addAttachmentPath($path);
        $this->addAttachmentFilename($filename);
        $this->_attachments[] = $this->getAttachmentData($path);

        return $this;
    }

    /**
     * addAttachmentPath function.
     *
     * @todo   Test this.
     * @param  string $path
     * @return Simplemail_Library
     */
    public function addAttachmentPath($path)
    {
        $this->_attachmentsPath[] = $path;

        return $this;
    }

    /**
     * addAttachmentFilename function.
     *
     * @todo   Test this.
     * @param  string $filename
     * @return Simplemail_Library
     */
    public function addAttachmentFilename($filename)
    {
        $this->_attachmentsFilename[] = $filename;

        return $this;
    }

    /**
     * getAttachmentData function.
     *
     * @todo   Test this.
     * @param  string $path
     * @return string
     */
    public function getAttachmentData($path)
    {
        $filesize   = filesize($path);
        $handle     = fopen($path, "r");
        $attachment = fread($handle, $filesize);
        fclose($handle);

        return chunk_split(base64_encode($attachment));
    }

    /**
     * setFrom.
     *
     * @param  string $email
     * @param  string $name
     *
     * @throws InvalidArgumentException on non string value for $email
     * @throws InvalidArgumentException on non string value for $name
     *
     * @return Simplemail_Library
     */
    public function setFrom($email, $name)
    {
        if ( ! is_string($email)) {
            throw new InvalidArgumentException();
        }

        if ( ! is_string($name)) {
            throw new InvalidArgumentException();
        }

        $this->addMailHeader('From', $email, $name);

        return $this;
    }

    /**
     * addMailHeader function.
     *
     * @param  string $header
     * @param  string $email
     * @param  string $name
     *
     * @throws InvalidArgumentException on non string value for $header
     * @throws InvalidArgumentException on non string value for $email
     * @throws InvalidArgumentException on non string value for $name
     *
     * @return Simplemail_Library
     */
    public function addMailHeader($header, $email = null, $name = null)
    {
        if ( ! is_string($header)) {
            throw new InvalidArgumentException('$header must be a string.');
        }

        if ( ! is_string($email)) {
            throw new InvalidArgumentException('$email must be a string.');
        }

        if ( ! is_string($name)) {
            throw new InvalidArgumentException('$name must be a string.');
        }

        $address = $this->formatHeader($email, $name);
        $this->_headers[] = sprintf('%s: %s', $header, $address);

        return $this;
    }

    /**
     * addGenericHeader function.
     *
     * @param  string $header
     * @param  mixed $value
     *
     * @throws InvalidArgumentException on non string value for $header
     * @throws InvalidArgumentException on non string value for $value
     *
     * @return Simplemail_Library
     */
    public function addGenericHeader($header, $value)
    {
        if ( ! is_string($header)) {
            throw new InvalidArgumentException('$header must be a string.');
        }

        if ( ! is_string($value) || ! is_string($value)) {
            throw new InvalidArgumentException('$value must be a string.');
        }

        $this->_headers[] = "$header: $value";

        return $this;
    }

    /**
     * Return the headers registered so far as an array.
     *
     * @return array
     */
    public function getHeaders()
    {
        return $this->_headers;
    }

    /**
     * setAdditionalParameters function.
     *
     * Such as "-fyouremail@yourserver.com
     *
     * @param  string $additionalParameters
     * @throws InvalidArgumentException on non string $additionalParameters
     * @return Simplemail_Library
     */
    public function setParameters($additionalParameters)
    {
        if (! is_string($additionalParameters)) {
            throw new InvalidArgumentException(
                '$additionalParameters must be a string.'
            );
        }

        $this->_parameters = $additionalParameters;

        return $this;
    }

    /**
     * getAdditionalParameters function
     *
     * @return string
     */
    public function getParameters()
    {
        return $this->_parameters;
    }

    /**
     * setWrap function.
     *
     * @param  int  $wrap
     *
     * @throws InvalidArgumentException on non int value
     * @throws InvalidArgumentException on int less than 1 for $wrap
     *
     * @return Simplemail_Library
     */
    public function setWrap($wrap = 78)
    {
        if (! is_int($wrap) || $wrap < 1) {
            throw new InvalidArgumentException('Wrap must be an integer larger than 0');
        }

        $this->_wrap = $wrap;

        return $this;
    }

    /**
     * getWrap function.
     *
     * @return int
     */
    public function getWrap()
    {
        return $this->_wrap;
    }

    /**
     * Checks if the email has an registered attachments.
     *
     * @return bool
     */
    public function hasAttachments()
    {
        return !!count($this->_attachments);
    }

    /**
     * assembleAttachment function.
     *
     * @return string
     */
    public function assembleAttachmentHeaders()
    {
        $uid = md5(uniqid(time()));

        /**
         * Construct the headers
         * @var string
         */
        $headers  = sprintf('MIME-Version: 1.0%s', self::CRLF);

        /**
         * Add Bcc to the headers
         */
        $bcc      = (is_array($this->bcc) && !empty($this->bcc)) ? join(", ", $this->bcc) : false;
        if($bcc)
        {
            $headers .= sprintf('Bcc: %s%s', $bcc, self::CRLF);
        }

        $headers .= sprintf('Content-Type: multipart/mixed; boundary="%s"%s%s',$uid,self::CRLF,self::CRLF);
        $headers .= sprintf('This is a multi-part message in MIME format.%s',self::CRLF);

        //Html Version
        $headers .= sprintf('--%s%s', $uid, self::CRLF);
        $headers .= sprintf('Content-type: text/html; charset="utf-8"%s', self::CRLF);
        $headers .= sprintf('Content-Transfer-Encoding: 7bit%s%s', self::CRLF, self::CRLF);
        $headers .= sprintf('%s%s%s', $this->_message, self::CRLF, self::CRLF);

        //Attachemnts
        $headers .= sprintf('--%s%s', $uid, self::CRLF);
        foreach ($this->_attachmentsFilename as $key => $value) {
            $headers .= sprintf('Content-Type: application/octet-stream; name="%s"%s',$value,self::CRLF);
            $headers .= sprintf('Content-Transfer-Encoding: base64%s', self::CRLF);
            $headers .= sprintf('Content-Disposition: attachment; filename="%s"%s%s',$value,self::CRLF,self::CRLF);
            $headers .= sprintf('%s%s%s', $this->_attachments[$key], self::CRLF, self::CRLF);
            $headers .= sprintf('--%s%s', $uid, self::CRLF);
        }

        return $headers;
    }

    /**
     * send function.
     *
     * @throws RuntimeException on no To: address to send to
     * @return boolean
     */
    public function send()
    {
        $headers = (!empty($this->_headers)) ? join("\r\n", $this->_headers) : '';
        $to      = (is_array($this->to) && !empty($this->to)) ? join(", ", $this->to) : false;

        if ($to === false)
        {
            throw new RuntimeException('Unable to send, no To address has been set.');
        }

        /**
         * Assemble the html message and attachment
         */
        $headers .= self::CRLF . $this->assembleAttachmentHeaders();
        return mail($to, $this->_subject, "", $headers, $this->_parameters);
    }

    /**
     * debug function.
     *
     * @return string
     */
    public function debug()
    {
        return '<pre>'.print_r($this, 1).'</pre>';
    }

    /**
     * magic __toString function.
     *
     * @return string
     */
    public function __toString()
    {
        return print_r($this, 1);
    }

    /**
     * formatHeader.
     *
     * Formats a display address for emails according to RFC2822 e.g.
     * Name <address@domain.tld>
     *
     * @todo   Test this.
     * @param  string $email
     * @param  string $name
     * @return string
     */
    public function formatHeader($email, $name = null)
    {
        $email = $this->filterEmail($email);

        if (is_null($name)) {
            return $email;
        }

        $name = $this->filterName($name);
        return sprintf('%s <%s>', $name, $email);
    }

    /**
     * filterEmail.
     *
     * Removes any carriage return, line feed, tab, double quote, comma
     * and angle bracket characters before sanitizing the email address.
     *
     * @todo   Test this.
     * @param  string $email
     * @return string
     */
    public function filterEmail($email)
    {
        $rule = array("\r" => '',
                      "\n" => '',
                      "\t" => '',
                      '"'  => '',
                      ','  => '',
                      '<'  => '',
                      '>'  => '',
        );

        $email = strtr($email, $rule);
        $email = filter_var($email, FILTER_SANITIZE_EMAIL);

        return $email;
    }

    /**
     * Filter of name data.
     *
     * Removes any carriage return, line feed or tab characters. Replaces
     * double quotes with single quotes and angle brackets with square
     * brackets, before sanitizing the string and stripping out html tags.
     *
     * @todo   Test this.
     * @param  string $name
     * @return string
     */
    public function filterName($name)
    {
        $rule = array("\r" => '',
                      "\n" => '',
                      "\t" => '',
                      '"'  => "'",
                      '<'  => '[',
                      '>'  => ']',
        );

        return trim(
            strtr(
                filter_var(
                    $name, FILTER_SANITIZE_STRING, FILTER_FLAG_STRIP_HIGH
                ),
                $rule
            )
        );
    }

    /**
     * Filter of other data.
     *
     * Removes any carriage return, line feed or tab characters.
     *
     * @todo   Test this.
     * @param  string $data
     * @return string
     */
    public function filterOther($data)
    {
        $rule = array("\r" => '',
                      "\n" => '',
                      "\t" => '',
        );

        return strtr(
            filter_var(
                $data, FILTER_SANITIZE_STRING, FILTER_FLAG_STRIP_HIGH
            ),
            $rule
        );
    }
}