<?php
/**
 * @version		$Id$
 * @package		Joomla.Framework
 * @subpackage	Mail
 * @copyright	Copyright (C) 2005 - 2009 Open Source Matters, Inc. All rights reserved.
 * @license		GNU General Public License version 2 or later; see LICENSE.txt
 */

defined('JPATH_FRAMEWORK') or die;

/**
 * E-Mail Class.  Provides a common interface to send e-mail from the Joomla! Framework
 *
 * @package 	Joomla.Framework
 * @subpackage	Mail
 * @since		1.5
 */
class JMail
{
	const PRIORITY_HIGH = 1;
	const PRIORITY_NORMAL = 3;
	const PRIORITY_LOW = 5;

	/**
	 * The mail priority value.
	 *
	 * @var		integer
	 * @since	2.0
	 */
	protected $_priority = 3;

	/**
	 * The mail character encoding type.
	 *
	 * @var		string
	 * @since	2.0
	 */
	protected $_charset = 'utf-8';

	/**
	 * The mail mime content type. Default is "text/plain".
	 *
	 * @var		string
	 * @since	2.0
	 */
	protected $_mime = 'text/plain';

	/**
	 * The mail encoding type. Default is "8bit".  Other acceptable values are:
	 * "7bit", "binary", "base64", and "quoted-printable".
	 *
	 * @var		string
	 * @since	2.0
	 */
	protected $_encoding = '8bit';

	/**
	 * The email address for the FROM header for the mail.
	 *
	 * @var		string
	 * @since	2.0
	 */
	protected $_fromAddress = 'admin@localhost';

	/**
	 * The name for the FROM header for the mail.
	 *
	 * @var		string
	 * @since	2.0
	 */
	protected $_fromName = 'Administrator';

	/**
	 * The email address for the Return-Path header for the mail.
	 *
	 * @var		string
	 * @since	2.0
	 */
	protected $_returnPath;

	/**
	 * The subject for the mail.
	 *
	 * @var		string
	 * @since	2.0
	 */
	protected $_subject;

	/**
	 * The HTML body for the mail.
	 *
	 * @var		string
	 * @since	2.0
	 */
	protected $_body_html;

	/**
	 * The text body for the mail.
	 *
	 * @var		string
	 * @since	2.0
	 */
	protected $_body_text;

	/**
	 * The array of JMailAttachment objects for the mail.
	 *
	 * @var		array
	 * @since	2.0
	 */
	protected $_attachments = array();

	/**
	 * Constructor.
	 * 
	 * @return	void
	 * @since	2.0
	 */
	public function __construct()
	{
	}

	/**
	 * Set the mail priority.
	 * 
	 * @param	integer	Mail priority.
	 * @return	void
	 * @since	2.0
	 */
	public function setPriority($priority)
	{
		$priority = (int) $priority;
		if (1 <= $priority <= 5) {
			$this->_priority = $priority;
		}
	}
	
	/**
	 * Set the name and email address for the FROM field.
	 * 
	 * @param	string	Email address to set for FROM field.
	 * @param	string	Name to set for FROM field.
	 * @return	boolean	True on success.
	 * @since	2.0
	 * 
	 * @throws	JException
	 */
	public function setFrom($address, $name = '')
	{
		// Sanitize the address and name.
		$address = trim(preg_replace('/(%0A|%0D|\n+|\r+)(content-type:|to:|cc:|bcc:)/i', '', $address));
		$name = trim(preg_replace('/(%0A|%0D|\n+|\r+)/', '', $name));

		// Validate the FROM email address.
		if (filter_var($address, FILTER_VALIDATE_EMAIL) === false)
		{
			throw new JException('Invalid email address: '.$address.'.', 0, E_WARNING);
			return false;
		}

		// Set the FROM address and name.
		$this->_fromAddress = $address;
		$this->_fromName = $name;

		return true;
	}

	/**
	 * Set the mail subject, sanitizing and securing it against injection attacks.
	 * 
	 * @param	string	Mail subject.
	 * @return	void
	 * @since	2.0
	 */
	public function setSubject($text = '')
	{
		$this->_subject = trim(preg_replace('/(%0A|%0D|\n+|\r+)(content-type:|to:|cc:|bcc:)/i', '', $text));
	}
	
	/**
	 * Set the mail HTML body.  Making modifications for inline images and backgrounds
	 * as necessary and also populating the text body if not already populated.
	 * 
	 * @param	string	HTML body text.
	 * @return	void
	 * @since	2.0
	 */
	public function setBodyHTML($body, $base = '')
	{
		// Sanitize the input.
		$body = trim(preg_replace('/(%0A|%0D|\n+|\r+)(content-type:|to:|cc:|bcc:)/i', '', $body));
		
		// If the text body is empty attempt to populate it from the HTML body.
		if (empty($this->_body_text))
		{
			if($text = html_entity_decode(trim(strip_tags(preg_replace('/<(head|title|style|script)[^>]*>.*?<\/\\1>/is', '', $body))))) {
				$this->_body_text = $text;
			}
			else {
				$this->_body_text = "This message requires an HTML capable client to be read.\n\n";
			}
		}

		// Set the mail mime type and body HTML.
		$this->_mime = 'text/html';
		$this->_body_html = $body;
	}
	
	/**
	 * Set the mail text body.
	 * 
	 * @param	string	Body text.
	 * @return	void
	 * @since	2.0
	 */
	public function setBodyText($body)
	{
		$this->_body_text = trim(preg_replace('/(%0A|%0D|\n+|\r+)(content-type:|to:|cc:|bcc:)/i', '', $body));
	}
}