Documentation for class BpMail



/**
 *  @package:   bpl - brain pies library
 * 	class		BpMail
 * 
 *  @author:    BrainPies Team
 *  @copyright: BrainPies Team
 *  @link:		https://brainpies.com
 * 
 *  @license:   GNU/GPL v.3.0 or any later version
 *  @link:		https://www.gnu.org/licenses/gpl-3.0.html GNU/GPL
 * 
 *  @version:   1.0.0
 * 
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 3 of the License, or (at your option)
 * any later version.

 * This program is distributed 'as is', in the hope that it will be useful, 
 * but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details.

 * You should have received a copy of the GNU General Public License along
 * with this program (COPYING); if not, go to http://www.fsf.org/ or write
 * to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

	/**
	 * @method	send
	 * Method to send an email message using joomla core function
	 *
	 * @param	object	$data	all mail data
	 * 							$data->to				mandatory	the recipient email address
	 * 							$data->toName			optional	the recipient name
	 * 							$data->subj				mandatory	the mail subject
	 * 							$data->body				mandatory	the mail message text
	 * 							$data->cc				optional	the recipient email address of carbon copy message
	 * 							$data->bcc				optional	the recipient email address of blind carbon copy message
	 * 							$data->mailFrom			optional	the sender email address - Joomla's default config data will be used if missing
	 * 							$data->mailFromName		optional	the sender name - - Joomla's default config data will be used if missing
	 * 							$data->isHtml			optional	bool	if true the email message will be sent in html mode - default is true
	 * 							$data->encode			optional	string	the encode mode - base64 by default
	 * 							$data->replyTo			optional	email address to set as reply to address
	 * 							
	 * @return	string			'sent' on success or error message if fails
	 * 
	 * @since	1.0
	 * 
	 * @todo	complete the switch encode
	 * @todo	complete with attachment management
	*/

	/**
	 * @method	isEmailAddress
	 * Method to verify if the supplied string is a valid email address
	 * 
	 * @param	string	$email
	 * 
	 * @return	bool	true if the email address has the correct format
	 * 
	 * @since	1.0.0
	 */

	/**
	 * @method	cleanAddress
	 * Method to sanitize the email address
	 * 
	 * @param	string	$email
	 * 
	 * @return	string|false email address string or boolean false if injected headers are present
	 * 
	 * @since	1.0.0
	 */