* Copyright 2005-2007, Cake Software Foundation, Inc. * 1785 E. Sahara Avenue, Suite 490-204 * Las Vegas, Nevada 89104 * * Licensed under The MIT License * Redistributions of files must retain the above copyright notice. * * @filesource * @copyright Copyright 2005-2007, Cake Software Foundation, Inc. * @link http://www.cakefoundation.org/projects/info/cakephp CakePHP(tm) Project * @package cake * @subpackage cake.cake.libs.controller.components * @since CakePHP(tm) v 1.2.0.3467 * @version $Revision$ * @modifiedby $LastChangedBy$ * @lastmodified $Date$ * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ /** * Short description for file. * * Long description for file * * @package cake * @subpackage cake.cake.libs.controller.components * */ class EmailComponent extends Object{ /** * Recipient of the email * * @var string * @access public */ var $to = null; /** * The mail which the email is sent from * * @var string * @access public */ var $from = null; /** * The email the recipient will reply to * * @var string * @access public */ var $replyTo = null; /** * The mail that will be used in case of any errors like * - Remote mailserver down * - Remote user has exceeded his quota * - Unknown user * * @var string * @access public */ var $return = null; /** * Carbon Copy * * List of email's that should receive a copy of the email. * The Recipient WILL be able to see this list * * @var array * @access public */ var $cc = array(); /** * Blind Carbon Copy * * List of email's that should receive a copy of the email. * The Recipient WILL NOT be able to see this list * * @var array * @access public */ var $bcc = array(); /** * The subject of the email * * @var string * @access public */ var $subject = null; /** * Associative array of a user defined headers * Keys will be prefixed 'X-' as per RFC822 Section 4.7.5 * * @var array * @access public */ var $headers = array(); /** * List of additional headers * * These will NOT be used if you are using safemode and mail() * * @var string * @access public */ var $additionalParams = null; /** * Layout for the View * * @var string * @access public */ var $layout = 'default'; /** * Template for the view * * @var string * @access public */ var $template = null; /** * What format should the email be sent in * * Supported formats: * - text * - html * - both * * @var string * @access public */ var $sendAs = 'text'; /** * What method should the email be sent by * * Supported methods: * - mail * - smtp * - debug * * @var string * @access public */ var $delivery = 'mail'; /** * charset the email is sent in * * @var string * @access public */ var $charset = 'ISO-8859-15'; /** * List of files that should be attached to the email. * * Can be both absolute and relative paths * * @var array * @access public */ var $attachments = array(); /** * What mailer should EmailComponent identify itself as * * @var string * @access public */ var $xMailer = 'CakePHP Email Component'; /** * The list of paths to search if an attachment isnt absolute * * @var array * @access public */ var $filePaths = array(); /** * List of options to use for smtp mail method * * Options is: * - port * - host * - timeout * * @var array * @access public */ var $smtpOptions = array('port'=> 25, 'host' => 'localhost', 'timeout' => 30); /** * Placeholder for any errors that might happen with the * smtp mail methods * * @var string * @access public */ var $smtpError = null; /** * If set to true, the mail method will be auto-set to 'debug' * * @var string * @access protected */ var $_debug = false; /** * Enter description here... * * @var string * @access protected */ var $_error = false; /** * New lines char * * @var string * @access protected */ var $_newLine = "\n"; /** * Enter description here... * * @var integer * @access protected */ var $_lineLength = 70; /** * Enter description here... * * @var string * @access private */ var $__header = null; /** * Enter description here... * * @var string * @access private */ var $__boundary = null; /** * Enter description here... * * @var string * @access private */ var $__message = null; /** * Variable that holds SMTP connection * * @var resource * @access private */ var $__smtpConnection = null; /** * Enter description here... * * @param unknown_type $controller * @access public */ function startup(&$controller) { $this->Controller = & $controller; } /** * Enter description here... * * @param mixed $content * @return unknown * @access public */ function send($content = null, $template = null, $layout = null) { $this->__createHeader(); $this->subject = $this->__encode($this->subject); if ($template) { $this->template = $template; } if ($layout) { $this->layout = $layout; } if ($template === null && $this->template === null) { if (is_array($content)) { $message = null; foreach ($content as $key => $value) { $message .= $value . $this->_newLine; } } else { $message = $content; } $this->__formatMessage($message); } else { $this->__message = $this->__renderTemplate($content); } if (!empty($this->attachments)) { $this->__attachFiles(); } if (!is_null($this->__boundary)) { $this->__message .= $this->_newLine .'--' . $this->__boundary . '--' . $this->_newLine . $this->_newLine; } if ($this->_debug) { $this->delivery = 'debug'; } $__method = '__'.$this->delivery; return $this->$__method(); } /** * Enter description here... * * @access public */ function reset() { $this->template = null; $this->to = null; $this->from = null; $this->replyTo = null; $this->return = null; $this->cc = array(); $this->bcc = array(); $this->subject = null; $this->additionalParams = null; $this->__header = null; $this->__boundary = null; $this->__message = null; } /** * Enter description here... * * @param string $content * @return unknown * @access private */ function __renderTemplate($content) { $View = new View($this->Controller); $View->layout = $this->layout; $content = $this->__strip($content); if ($this->sendAs === 'both') { $htmlContent = $content; $msg = '--' . $this->__boundary . $this->_newLine; $msg .= 'Content-Type: text/plain; charset=' . $this->charset . $this->_newLine; $msg .= 'Content-Transfer-Encoding: 8bit' . $this->_newLine . $this->_newLine; $content = $View->renderElement('email' . DS . 'text' . DS . $this->template, array('content' => $content), true); $View->layoutPath = 'email' . DS . 'text'; $msg .= $View->renderLayout($content) . $this->_newLine; $msg .= $this->_newLine. '--' . $this->__boundary . $this->_newLine; $msg .= 'Content-Type: text/html; charset=' . $this->charset . $this->_newLine; $msg .= 'Content-Transfer-Encoding: 8bit' . $this->_newLine . $this->_newLine; $content = $View->renderElement('email' . DS . 'html' . DS . $this->template, array('content' => $htmlContent), true); $View->layoutPath = 'email' . DS . 'html'; $msg .= $View->renderLayout($content); return $msg; } else { $content = $View->renderElement('email' . DS . $this->sendAs . DS . $this->template, array('content' => $content), true); $View->layoutPath = 'email' . DS . $this->sendAs; return $View->renderLayout($content); } } /** * Enter description here... * * @access private */ function __createBoundary() { $this->__boundary = md5(uniqid(time())); } /** * Enter description here... * * @access private */ function __createHeader() { $this->__header .= 'From: ' . $this->__formatAddress($this->from) . $this->_newLine; if (!empty($this->replyTo)) { $this->__header .= 'Reply-To: ' . $this->__formatAddress($this->replyTo) . $this->_newLine; } if (!empty($this->return)) { $this->__header .= 'Return-Path: ' . $this->__formatAddress($this->return) . $this->_newLine; } $addresses = null; if (!empty($this->cc)) { foreach ($this->cc as $cc) { $addresses .= ', ' . $this->__formatAddress($cc); } $this->__header .= 'cc: ' . substr($addresses, 2) . $this->_newLine; } $addresses = null; if (!empty($this->bcc)) { foreach ($this->bcc as $bcc) { $addresses .= ', ' . $this->__formatAddress($bcc); } $this->__header .= 'Bcc: ' . substr($addresses, 2) . $this->_newLine; } $this->__header .= 'X-Mailer: ' . $this->xMailer . $this->_newLine; if (!empty($this->headers)) { foreach ($this->headers as $key => $val) { $this->__header .= 'X-'.$key.': '.$val . $this->_newLine; } } if (!empty($this->attachments) && $this->sendAs === 'text') { $this->__createBoundary(); $this->__header .= 'MIME-Version: 1.0' . $this->_newLine; $this->__header .= 'Content-Type: multipart/mixed; boundary="' . $this->__boundary . '"' . $this->_newLine; } elseif (!empty($this->attachments) && $this->sendAs === 'html') { $this->__createBoundary(); $this->__header .= 'MIME-Version: 1.0' . $this->_newLine; $this->__header .= 'Content-Type: multipart/related; boundary="' . $this->__boundary . '"' . $this->_newLine; } elseif ($this->sendAs === 'html') { $this->__header .= 'Content-Type: text/html; charset=' . $this->charset . $this->_newLine; $this->__header .= 'Content-Transfer-Encoding: 8bit' . $this->_newLine; } elseif ($this->sendAs === 'both') { $this->__createBoundary(); $this->__header .= 'MIME-Version: 1.0' . $this->_newLine; $this->__header .= 'Content-Type: multipart/alternative; boundary="' . $this->__boundary . '"' . $this->_newLine; } } /** * Enter description here... * * @param string $message * @access private */ function __formatMessage($message) { $message = $this->__wrap($message); if ($this->sendAs === 'both') { $this->__message = '--' . $this->__boundary . $this->_newLine; $this->__message .= 'Content-Type: text/plain; charset=' . $this->charset . $this->_newLine; $this->__message .= 'Content-Transfer-Encoding: 8bit' . $this->_newLine; $this->__message .= 'If you are seeing this is because you may need to change your'.$this->_newLine; $this->__message .= 'preferred message format from HTML to plain text.'.$this->_newLine.$this->_newLine; $this->__message .= strip_tags($message) . $this->_newLine; $this->__message .= '--' . $this->__boundary . $this->_newLine; $this->__message .= 'Content-Type: text/html; charset=' . $this->charset . $this->_newLine; $this->__message .= 'Content-Transfer-Encoding: 8bit' . $this->_newLine; $this->__message .= $message . $this->_newLine; $this->__message .= $this->_newLine . $this->_newLine; } else { $this->__message .= $message . $this->_newLine; } } /** * Enter description here... * * @access private */ function __attachFiles() { foreach ($this->attachments as $attachment) { $files[] = $this->__findFiles($attachment); } foreach ($files as $file) { $handle = fopen($file, 'rb'); $data = fread($handle, filesize($file)); $data = chunk_split(base64_encode($data)) ; $filetype = mime_content_type($file); $this->__message .= '--' . $this->__boundary . $this->_newLine; $this->__message .= 'Content-Type: ' . $filetype . '; name="' . basename($file) . '"' . $this->_newLine; $this->__message .= 'Content-Transfer-Encoding: base64' . $this->_newLine; $this->__message .= 'Content-Disposition: attachment; filename="' . basename($file) . '"' . $this->_newLine . $this->_newLine; $this->__message .= $data . $this->_newLine . $this->_newLine; } } /** * Enter description here... * * @param string $attachment * @return unknown * @access private */ function __findFiles($attachment) { foreach ($this->filePaths as $path) { if (file_exists($path . DS . $attachment)) { $file = $path . DS . $attachment; return $file; } } } /** * Enter description here... * * @param string $message * @return unknown * @access private */ function __wrap($message) { $message = $this->__strip($message, true); $message = str_replace(array('\r','\n'), '\n', $message); $words = explode('\n', $message); $formated = null; foreach ($words as $word) { $formated .= wordwrap($word, $this->_lineLength, "\n", true); $formated .= "\n"; } return $formated; } /** * Enter description here... * * @param string $subject * @return unknown * @access private */ function __encode($subject) { $subject = $this->__strip($subject); if (low($this->charset) !== 'iso-8859-15') { $start = "=?" . $this->charset . "?B?"; $end = "?="; $spacer = $end . "\n " . $start; $length = 75 - strlen($start) - strlen($end); $length = $length - ($length % 4); $subject = base64_encode($subject); $subject = chunk_split($subject, $length, $spacer); $spacer = preg_quote($spacer); $subject = preg_replace("/" . $spacer . "$/", "", $subject); $subject = $start . $subject . $end; } return $subject; } /** * Enter description here... * * @param string $string * @return unknown * @access private */ function __formatAddress($string) { if (strpos($string, '<') !== false) { $value = explode('<', $string); $string = $this->__encode($value[0]) . ' <' . $value[1]; } return $this->__strip($string); } /** * Enter description here... * * @param string $value * @param boolean $message * @return unknown * @access private */ function __strip($value, $message = false) { $search = array('/%0a/i', '/%0d/i', '/Content-Type\:/i', '/charset\=/i', '/mime-version\:/i', '/multipart\/mixed/i', '/bcc\:/i','/to\:/i','/cc\:/i', '/\\r/i', '/\\n/i'); if ($message === true) { $search = array_slice($search, 0, -2); } return preg_replace($search, '', $value); } /** * Enter description here... * * @return unknown * @access private */ function __mail() { if (ini_get('safe_mode')) { return @mail($this->to, $this->subject, $this->__message, $this->__header); } return @mail($this->to, $this->subject, $this->__message, $this->__header, $this->additionalParams); } /** * Sends out email via SMTP * * @access private */ function __smtp() { $response = $this->__smtpConnect(); if ($response['errno'] != 0 && $response['status'] === false) { $this->smtpError = "{$response['errno']}: {$response['errstr']}"; return false; } if (!$this->__sendData("HELO cake\r\n")) { return false; } if (!$this->__sendData("MAIL FROM: {$this->from}\r\n")) { return false; } if (!$this->__sendData("RCPT TO: {$this->to}\r\n")) { return false; } $this->__sendData("DATA\r\n{$this->__header}\r\n{$this->__message}\r\n\r\n\r\n.\r\n", false); $this->__sendData("QUIT\r\n", false); return true; } /** * Private method for connecting to an SMTP server * * @access private * @param array $options SMTP connection options * @return array */ function __smtpConnect() { $status = true; $this->__smtpConnection = @fsockopen($this->smtpOptions['host'], $this->smtpOptions['port'], $errno, $errstr, $this->smtpOptions['timeout']); if ($this->__smtpConnection == false) { $status = false; } $response = $this->__getSmtpResponse(); return array('status' => $status, 'errno' => $errno, 'errstr' => $errstr); } /** * Private method for getting SMTP response */ function __getSmtpResponse() { $response = @fgets($this->__smtpConnection, 512); return $response; } /** * Private method for sending data to SMTP connection * * @param string $data data to be sent to SMTP server * @param boolean $check check for response from server */ function __sendData($data, $check = true) { @fwrite($this->__smtpConnection, $data); $response = $this->__getSmtpResponse(); if ($check != false) { if (stristr($response, '250') === false) { $this->smtpError = $response; return false; } } return true; } /** * Enter description here... * * @return unknown * @access private */ function __debug() { $fm = '
'; if ($this->delivery == 'smtp') { $fm .= sprintf("%s %s\n", 'Host:', $this->smtpOptions['host']); $fm .= sprintf("%s %s\n", 'Port:', $this->smtpOptions['port']); $fm .= sprintf("%s %s\n", 'Timeout:', $this->smtpOptions['timeout']); } $fm .= sprintf("%s %s\n", 'To:', $this->to); $fm .= sprintf("%s %s\n", 'From:', $this->from); $fm .= sprintf("%s %s\n", 'Subject:', $this->subject); $fm .= sprintf("%s\n\n%s", 'Header:', $this->__header); $fm .= sprintf("%s\n\n%s", 'Parameters:', $this->additionalParams); $fm .= sprintf("%s\n\n%s", 'Message:', $this->__message); $fm .= ''; $this->Controller->Session->setFlash($fm, 'default', null, 'email'); return true; } } ?>