'ISO-2022-JP' ); /** * Regex for email validation * If null, it will use built in regex * * @var string */ protected $_emailPattern = null; /** * The class name used for email configuration. * * @var string */ protected $_configClass = 'EmailConfig'; /** * Constructor * * @param array|string $config Array of configs, or string to load configs from email.php */ public function __construct($config = null) { $this->_appCharset = Configure::read('App.encoding'); if ($this->_appCharset !== null) { $this->charset = $this->_appCharset; } $this->_domain = preg_replace('/\:\d+$/', '', env('HTTP_HOST')); if (empty($this->_domain)) { $this->_domain = php_uname('n'); } if ($config) { $this->config($config); } if (empty($this->headerCharset)) { $this->headerCharset = $this->charset; } } /** * From * * @param string|array $email * @param string $name * @return array|CakeEmail * @throws SocketException */ public function from($email = null, $name = null) { if ($email === null) { return $this->_from; } return $this->_setEmailSingle('_from', $email, $name, __d('cake_dev', 'From requires only 1 email address.')); } /** * Sender * * @param string|array $email * @param string $name * @return array|CakeEmail * @throws SocketException */ public function sender($email = null, $name = null) { if ($email === null) { return $this->_sender; } return $this->_setEmailSingle('_sender', $email, $name, __d('cake_dev', 'Sender requires only 1 email address.')); } /** * Reply-To * * @param string|array $email * @param string $name * @return array|CakeEmail * @throws SocketException */ public function replyTo($email = null, $name = null) { if ($email === null) { return $this->_replyTo; } return $this->_setEmailSingle('_replyTo', $email, $name, __d('cake_dev', 'Reply-To requires only 1 email address.')); } /** * Read Receipt (Disposition-Notification-To header) * * @param string|array $email * @param string $name * @return array|CakeEmail * @throws SocketException */ public function readReceipt($email = null, $name = null) { if ($email === null) { return $this->_readReceipt; } return $this->_setEmailSingle('_readReceipt', $email, $name, __d('cake_dev', 'Disposition-Notification-To requires only 1 email address.')); } /** * Return Path * * @param string|array $email * @param string $name * @return array|CakeEmail * @throws SocketException */ public function returnPath($email = null, $name = null) { if ($email === null) { return $this->_returnPath; } return $this->_setEmailSingle('_returnPath', $email, $name, __d('cake_dev', 'Return-Path requires only 1 email address.')); } /** * To * * @param string|array $email Null to get, String with email, Array with email as key, name as value or email as value (without name) * @param string $name * @return array|CakeEmail */ public function to($email = null, $name = null) { if ($email === null) { return $this->_to; } return $this->_setEmail('_to', $email, $name); } /** * Add To * * @param string|array $email String with email, Array with email as key, name as value or email as value (without name) * @param string $name * @return CakeEmail $this */ public function addTo($email, $name = null) { return $this->_addEmail('_to', $email, $name); } /** * Cc * * @param string|array $email String with email, Array with email as key, name as value or email as value (without name) * @param string $name * @return array|CakeEmail */ public function cc($email = null, $name = null) { if ($email === null) { return $this->_cc; } return $this->_setEmail('_cc', $email, $name); } /** * Add Cc * * @param string|array $email String with email, Array with email as key, name as value or email as value (without name) * @param string $name * @return CakeEmail $this */ public function addCc($email, $name = null) { return $this->_addEmail('_cc', $email, $name); } /** * Bcc * * @param string|array $email String with email, Array with email as key, name as value or email as value (without name) * @param string $name * @return array|CakeEmail */ public function bcc($email = null, $name = null) { if ($email === null) { return $this->_bcc; } return $this->_setEmail('_bcc', $email, $name); } /** * Add Bcc * * @param string|array $email String with email, Array with email as key, name as value or email as value (without name) * @param string $name * @return CakeEmail $this */ public function addBcc($email, $name = null) { return $this->_addEmail('_bcc', $email, $name); } /** * Charset setter/getter * * @param string $charset * @return string $this->charset */ public function charset($charset = null) { if ($charset === null) { return $this->charset; } $this->charset = $charset; if (empty($this->headerCharset)) { $this->headerCharset = $charset; } return $this->charset; } /** * HeaderCharset setter/getter * * @param string $charset * @return string $this->charset */ public function headerCharset($charset = null) { if ($charset === null) { return $this->headerCharset; } return $this->headerCharset = $charset; } /** * EmailPattern setter/getter * * @param string $regex for email address validation * @return string|CakeEmail */ public function emailPattern($regex = null) { if ($regex === null) { return $this->_emailPattern; } $this->_emailPattern = $regex; return $this; } /** * Set email * * @param string $varName * @param string|array $email * @param string $name * @return CakeEmail $this * @throws SocketException */ protected function _setEmail($varName, $email, $name) { if (!is_array($email)) { if (!Validation::email($email, false, $this->_emailPattern)) { throw new SocketException(__d('cake_dev', 'Invalid email: "%s"', $email)); } if ($name === null) { $name = $email; } $this->{$varName} = array($email => $name); return $this; } $list = array(); foreach ($email as $key => $value) { if (is_int($key)) { $key = $value; } if (!Validation::email($key, false, $this->_emailPattern)) { throw new SocketException(__d('cake_dev', 'Invalid email: "%s"', $key)); } $list[$key] = $value; } $this->{$varName} = $list; return $this; } /** * Set only 1 email * * @param string $varName * @param string|array $email * @param string $name * @param string $throwMessage * @return CakeEmail $this * @throws SocketException */ protected function _setEmailSingle($varName, $email, $name, $throwMessage) { $current = $this->{$varName}; $this->_setEmail($varName, $email, $name); if (count($this->{$varName}) !== 1) { $this->{$varName} = $current; throw new SocketException($throwMessage); } return $this; } /** * Add email * * @param string $varName * @param string|array $email * @param string $name * @return CakeEmail $this * @throws SocketException */ protected function _addEmail($varName, $email, $name) { if (!is_array($email)) { if (!Validation::email($email, false, $this->_emailPattern)) { throw new SocketException(__d('cake_dev', 'Invalid email: "%s"', $email)); } if ($name === null) { $name = $email; } $this->{$varName}[$email] = $name; return $this; } $list = array(); foreach ($email as $key => $value) { if (is_int($key)) { $key = $value; } if (!Validation::email($key, false, $this->_emailPattern)) { throw new SocketException(__d('cake_dev', 'Invalid email: "%s"', $key)); } $list[$key] = $value; } $this->{$varName} = array_merge($this->{$varName}, $list); return $this; } /** * Get/Set Subject. * * @param string $subject * @return string|CakeEmail */ public function subject($subject = null) { if ($subject === null) { return $this->_subject; } $this->_subject = $this->_encode((string)$subject); return $this; } /** * Sets headers for the message * * @param array $headers Associative array containing headers to be set. * @return CakeEmail $this * @throws SocketException */ public function setHeaders($headers) { if (!is_array($headers)) { throw new SocketException(__d('cake_dev', '$headers should be an array.')); } $this->_headers = $headers; return $this; } /** * Add header for the message * * @param array $headers * @return object $this * @throws SocketException */ public function addHeaders($headers) { if (!is_array($headers)) { throw new SocketException(__d('cake_dev', '$headers should be an array.')); } $this->_headers = array_merge($this->_headers, $headers); return $this; } /** * Get list of headers * * ### Includes: * * - `from` * - `replyTo` * - `readReceipt` * - `returnPath` * - `to` * - `cc` * - `bcc` * - `subject` * * @param array $include * @return array */ public function getHeaders($include = array()) { if ($include == array_values($include)) { $include = array_fill_keys($include, true); } $defaults = array_fill_keys(array('from', 'sender', 'replyTo', 'readReceipt', 'returnPath', 'to', 'cc', 'bcc', 'subject'), false); $include += $defaults; $headers = array(); $relation = array( 'from' => 'From', 'replyTo' => 'Reply-To', 'readReceipt' => 'Disposition-Notification-To', 'returnPath' => 'Return-Path' ); foreach ($relation as $var => $header) { if ($include[$var]) { $var = '_' . $var; $headers[$header] = current($this->_formatAddress($this->{$var})); } } if ($include['sender']) { if (key($this->_sender) === key($this->_from)) { $headers['Sender'] = ''; } else { $headers['Sender'] = current($this->_formatAddress($this->_sender)); } } foreach (array('to', 'cc', 'bcc') as $var) { if ($include[$var]) { $classVar = '_' . $var; $headers[ucfirst($var)] = implode(', ', $this->_formatAddress($this->{$classVar})); } } $headers += $this->_headers; if (!isset($headers['X-Mailer'])) { $headers['X-Mailer'] = self::EMAIL_CLIENT; } if (!isset($headers['Date'])) { $headers['Date'] = date(DATE_RFC2822); } if ($this->_messageId !== false) { if ($this->_messageId === true) { $headers['Message-ID'] = '<' . str_replace('-', '', String::UUID()) . '@' . $this->_domain . '>'; } else { $headers['Message-ID'] = $this->_messageId; } } if ($include['subject']) { $headers['Subject'] = $this->_subject; } $headers['MIME-Version'] = '1.0'; if (!empty($this->_attachments) || $this->_emailFormat === 'both') { $headers['Content-Type'] = 'multipart/mixed; boundary="' . $this->_boundary . '"'; } elseif ($this->_emailFormat === 'text') { $headers['Content-Type'] = 'text/plain; charset=' . $this->_getContentTypeCharset(); } elseif ($this->_emailFormat === 'html') { $headers['Content-Type'] = 'text/html; charset=' . $this->_getContentTypeCharset(); } $headers['Content-Transfer-Encoding'] = $this->_getContentTransferEncoding(); return $headers; } /** * Format addresses * * If the address contains non alphanumeric/whitespace characters, it will * be quoted as characters like `:` and `,` are known to cause issues * in address header fields. * * @param array $address * @return array */ protected function _formatAddress($address) { $return = array(); foreach ($address as $email => $alias) { if ($email === $alias) { $return[] = $email; } else { $encoded = $this->_encode($alias); if ($encoded === $alias && preg_match('/[^a-z0-9 ]/i', $encoded)) { $encoded = '"' . str_replace('"', '\"', $encoded) . '"'; } $return[] = sprintf('%s <%s>', $encoded, $email); } } return $return; } /** * Template and layout * * @param boolean|string $template Template name or null to not use * @param boolean|string $layout Layout name or null to not use * @return array|CakeEmail */ public function template($template = false, $layout = false) { if ($template === false) { return array( 'template' => $this->_template, 'layout' => $this->_layout ); } $this->_template = $template; if ($layout !== false) { $this->_layout = $layout; } return $this; } /** * View class for render * * @param string $viewClass * @return string|CakeEmail */ public function viewRender($viewClass = null) { if ($viewClass === null) { return $this->_viewRender; } $this->_viewRender = $viewClass; return $this; } /** * Variables to be set on render * * @param array $viewVars * @return array|CakeEmail */ public function viewVars($viewVars = null) { if ($viewVars === null) { return $this->_viewVars; } $this->_viewVars = array_merge($this->_viewVars, (array)$viewVars); return $this; } /** * Theme to use when rendering * * @param string $theme * @return string|CakeEmail */ public function theme($theme = null) { if ($theme === null) { return $this->_theme; } $this->_theme = $theme; return $this; } /** * Helpers to be used in render * * @param array $helpers * @return array|CakeEmail */ public function helpers($helpers = null) { if ($helpers === null) { return $this->_helpers; } $this->_helpers = (array)$helpers; return $this; } /** * Email format * * @param string $format * @return string|CakeEmail * @throws SocketException */ public function emailFormat($format = null) { if ($format === null) { return $this->_emailFormat; } if (!in_array($format, $this->_emailFormatAvailable)) { throw new SocketException(__d('cake_dev', 'Format not available.')); } $this->_emailFormat = $format; return $this; } /** * Transport name * * @param string $name * @return string|CakeEmail */ public function transport($name = null) { if ($name === null) { return $this->_transportName; } $this->_transportName = (string)$name; $this->_transportClass = null; return $this; } /** * Return the transport class * * @return CakeEmail * @throws SocketException */ public function transportClass() { if ($this->_transportClass) { return $this->_transportClass; } list($plugin, $transportClassname) = pluginSplit($this->_transportName, true); $transportClassname .= 'Transport'; App::uses($transportClassname, $plugin . 'Network/Email'); if (!class_exists($transportClassname)) { throw new SocketException(__d('cake_dev', 'Class "%s" not found.', $transportClassname)); } elseif (!method_exists($transportClassname, 'send')) { throw new SocketException(__d('cake_dev', 'The "%s" does not have a %s method.', $transportClassname, 'send()')); } return $this->_transportClass = new $transportClassname(); } /** * Message-ID * * @param boolean|string $message True to generate a new Message-ID, False to ignore (not send in email), String to set as Message-ID * @return boolean|string|CakeEmail * @throws SocketException */ public function messageId($message = null) { if ($message === null) { return $this->_messageId; } if (is_bool($message)) { $this->_messageId = $message; } else { if (!preg_match('/^\<.+@.+\>$/', $message)) { throw new SocketException(__d('cake_dev', 'Invalid format for Message-ID. The text should be something like ""')); } $this->_messageId = $message; } return $this; } /** * Domain as top level (the part after @) * * @param string $domain Manually set the domain for CLI mailing * @return string|CakeEmail */ public function domain($domain = null) { if ($domain === null) { return $this->_domain; } $this->_domain = $domain; return $this; } /** * Add attachments to the email message * * Attachments can be defined in a few forms depending on how much control you need: * * Attach a single file: * * {{{ * $email->attachments('path/to/file'); * }}} * * Attach a file with a different filename: * * {{{ * $email->attachments(array('custom_name.txt' => 'path/to/file.txt')); * }}} * * Attach a file and specify additional properties: * * {{{ * $email->attachments(array('custom_name.png' => array( * 'file' => 'path/to/file', * 'mimetype' => 'image/png', * 'contentId' => 'abc123', * 'contentDisposition' => false * )); * }}} * * Attach a file from string and specify additional properties: * * {{{ * $email->attachments(array('custom_name.png' => array( * 'data' => file_get_contents('path/to/file'), * 'mimetype' => 'image/png' * )); * }}} * * The `contentId` key allows you to specify an inline attachment. In your email text, you * can use `` to display the image inline. * * The `contentDisposition` key allows you to disable the `Content-Disposition` header, this can improve * attachment compatibility with outlook email clients. * * @param string|array $attachments String with the filename or array with filenames * @return array|CakeEmail Either the array of attachments when getting or $this when setting. * @throws SocketException */ public function attachments($attachments = null) { if ($attachments === null) { return $this->_attachments; } $attach = array(); foreach ((array)$attachments as $name => $fileInfo) { if (!is_array($fileInfo)) { $fileInfo = array('file' => $fileInfo); } if (!isset($fileInfo['file'])) { if (!isset($fileInfo['data'])) { throw new SocketException(__d('cake_dev', 'No file or data specified.')); } if (is_int($name)) { throw new SocketException(__d('cake_dev', 'No filename specified.')); } $fileInfo['data'] = chunk_split(base64_encode($fileInfo['data']), 76, "\r\n"); } else { $fileInfo['file'] = realpath($fileInfo['file']); if ($fileInfo['file'] === false || !file_exists($fileInfo['file'])) { throw new SocketException(__d('cake_dev', 'File not found: "%s"', $fileInfo['file'])); } if (is_int($name)) { $name = basename($fileInfo['file']); } } if (!isset($fileInfo['mimetype'])) { $fileInfo['mimetype'] = 'application/octet-stream'; } $attach[$name] = $fileInfo; } $this->_attachments = $attach; return $this; } /** * Add attachments * * @param string|array $attachments String with the filename or array with filenames * @return CakeEmail $this * @throws SocketException * @see CakeEmail::attachments() */ public function addAttachments($attachments) { $current = $this->_attachments; $this->attachments($attachments); $this->_attachments = array_merge($current, $this->_attachments); return $this; } /** * Get generated message (used by transport classes) * * @param string $type Use MESSAGE_* constants or null to return the full message as array * @return string|array String if have type, array if type is null */ public function message($type = null) { switch ($type) { case self::MESSAGE_HTML: return $this->_htmlMessage; case self::MESSAGE_TEXT: return $this->_textMessage; } return $this->_message; } /** * Configuration to use when send email * * ### Usage * * Load configuration from `app/Config/email.php`: * * `$email->config('default');` * * Merge an array of configuration into the instance: * * `$email->config(array('to' => 'bill@example.com'));` * * @param string|array $config String with configuration name (from email.php), array with config or null to return current config * @return string|array|CakeEmail */ public function config($config = null) { if ($config === null) { return $this->_config; } if (!is_array($config)) { $config = (string)$config; } $this->_applyConfig($config); return $this; } /** * Send an email using the specified content, template and layout * * @param string|array $content String with message or array with messages * @return array * @throws SocketException */ public function send($content = null) { if (empty($this->_from)) { throw new SocketException(__d('cake_dev', 'From is not specified.')); } if (empty($this->_to) && empty($this->_cc) && empty($this->_bcc)) { throw new SocketException(__d('cake_dev', 'You need to specify at least one destination for to, cc or bcc.')); } if (is_array($content)) { $content = implode("\n", $content) . "\n"; } $this->_message = $this->_render($this->_wrap($content)); $contents = $this->transportClass()->send($this); if (!empty($this->_config['log'])) { $config = array( 'level' => LOG_DEBUG, 'scope' => 'email' ); if ($this->_config['log'] !== true) { if (!is_array($this->_config['log'])) { $this->_config['log'] = array('level' => $this->_config['log']); } $config = array_merge($config, $this->_config['log']); } CakeLog::write( $config['level'], PHP_EOL . $contents['headers'] . PHP_EOL . $contents['message'], $config['scope'] ); } return $contents; } /** * Static method to fast create an instance of CakeEmail * * @param string|array $to Address to send (see CakeEmail::to()). If null, will try to use 'to' from transport config * @param string $subject String of subject or null to use 'subject' from transport config * @param string|array $message String with message or array with variables to be used in render * @param string|array $transportConfig String to use config from EmailConfig or array with configs * @param boolean $send Send the email or just return the instance pre-configured * @return CakeEmail Instance of CakeEmail * @throws SocketException */ public static function deliver($to = null, $subject = null, $message = null, $transportConfig = 'fast', $send = true) { $class = __CLASS__; $instance = new $class($transportConfig); if ($to !== null) { $instance->to($to); } if ($subject !== null) { $instance->subject($subject); } if (is_array($message)) { $instance->viewVars($message); $message = null; } elseif ($message === null && array_key_exists('message', $config = $instance->config())) { $message = $config['message']; } if ($send === true) { $instance->send($message); } return $instance; } /** * Apply the config to an instance * * @param array $config * @return void * @throws ConfigureException When configuration file cannot be found, or is missing * the named config. */ protected function _applyConfig($config) { if (is_string($config)) { if (!class_exists($this->_configClass) && !config('email')) { throw new ConfigureException(__d('cake_dev', '%s not found.', APP . 'Config' . DS . 'email.php')); } $configs = new $this->_configClass(); if (!isset($configs->{$config})) { throw new ConfigureException(__d('cake_dev', 'Unknown email configuration "%s".', $config)); } $config = $configs->{$config}; } $this->_config = array_merge($this->_config, $config); if (!empty($config['charset'])) { $this->charset = $config['charset']; } if (!empty($config['headerCharset'])) { $this->headerCharset = $config['headerCharset']; } if (empty($this->headerCharset)) { $this->headerCharset = $this->charset; } $simpleMethods = array( 'from', 'sender', 'to', 'replyTo', 'readReceipt', 'returnPath', 'cc', 'bcc', 'messageId', 'domain', 'subject', 'viewRender', 'viewVars', 'attachments', 'transport', 'emailFormat', 'theme', 'helpers', 'emailPattern' ); foreach ($simpleMethods as $method) { if (isset($config[$method])) { $this->$method($config[$method]); unset($config[$method]); } } if (isset($config['headers'])) { $this->setHeaders($config['headers']); unset($config['headers']); } if (array_key_exists('template', $config)) { $layout = false; if (array_key_exists('layout', $config)) { $layout = $config['layout']; unset($config['layout']); } $this->template($config['template'], $layout); unset($config['template']); } $this->transportClass()->config($config); } /** * Reset all CakeEmail internal variables to be able to send out a new email. * * @return CakeEmail $this */ public function reset() { $this->_to = array(); $this->_from = array(); $this->_sender = array(); $this->_replyTo = array(); $this->_readReceipt = array(); $this->_returnPath = array(); $this->_cc = array(); $this->_bcc = array(); $this->_messageId = true; $this->_subject = ''; $this->_headers = array(); $this->_layout = 'default'; $this->_template = ''; $this->_viewRender = 'View'; $this->_viewVars = array(); $this->_theme = null; $this->_helpers = array('Html'); $this->_textMessage = ''; $this->_htmlMessage = ''; $this->_message = ''; $this->_emailFormat = 'text'; $this->_transportName = 'Mail'; $this->_transportClass = null; $this->charset = 'utf-8'; $this->headerCharset = null; $this->_attachments = array(); $this->_config = array(); $this->_emailPattern = null; return $this; } /** * Encode the specified string using the current charset * * @param string $text String to encode * @return string Encoded string */ protected function _encode($text) { $internalEncoding = function_exists('mb_internal_encoding'); if ($internalEncoding) { $restore = mb_internal_encoding(); mb_internal_encoding($this->_appCharset); } if (empty($this->headerCharset)) { $this->headerCharset = $this->charset; } $return = mb_encode_mimeheader($text, $this->headerCharset, 'B'); if ($internalEncoding) { mb_internal_encoding($restore); } return $return; } /** * Translates a string for one charset to another if the App.encoding value * differs and the mb_convert_encoding function exists * * @param string $text The text to be converted * @param string $charset the target encoding * @return string */ protected function _encodeString($text, $charset) { if ($this->_appCharset === $charset || !function_exists('mb_convert_encoding')) { return $text; } return mb_convert_encoding($text, $charset, $this->_appCharset); } /** * Wrap the message to follow the RFC 2822 - 2.1.1 * * @param string $message Message to wrap * @return array Wrapped message */ protected function _wrap($message, $wrapLength = CakeEmail::LINE_LENGTH_MUST) { if (strlen($message) === 0) { return array(''); } $message = str_replace(array("\r\n", "\r"), "\n", $message); $lines = explode("\n", $message); $formatted = array(); $cut = ($wrapLength == CakeEmail::LINE_LENGTH_MUST); foreach ($lines as $line) { if (empty($line)) { $formatted[] = ''; continue; } if (strlen($line) < $wrapLength) { $formatted[] = $line; continue; } if (!preg_match('/<[a-z]+.*>/i', $line)) { $formatted = array_merge( $formatted, explode("\n", wordwrap($line, $wrapLength, "\n", $cut)) ); continue; } $tagOpen = false; $tmpLine = $tag = ''; $tmpLineLength = 0; for ($i = 0, $count = strlen($line); $i < $count; $i++) { $char = $line[$i]; if ($tagOpen) { $tag .= $char; if ($char === '>') { $tagLength = strlen($tag); if ($tagLength + $tmpLineLength < $wrapLength) { $tmpLine .= $tag; $tmpLineLength += $tagLength; } else { if ($tmpLineLength > 0) { $formatted = array_merge( $formatted, explode("\n", wordwrap(trim($tmpLine), $wrapLength, "\n", $cut)) ); $tmpLine = ''; $tmpLineLength = 0; } if ($tagLength > $wrapLength) { $formatted[] = $tag; } else { $tmpLine = $tag; $tmpLineLength = $tagLength; } } $tag = ''; $tagOpen = false; } continue; } if ($char === '<') { $tagOpen = true; $tag = '<'; continue; } if ($char === ' ' && $tmpLineLength >= $wrapLength) { $formatted[] = $tmpLine; $tmpLineLength = 0; continue; } $tmpLine .= $char; $tmpLineLength++; if ($tmpLineLength === $wrapLength) { $nextChar = $line[$i + 1]; if ($nextChar === ' ' || $nextChar === '<') { $formatted[] = trim($tmpLine); $tmpLine = ''; $tmpLineLength = 0; if ($nextChar === ' ') { $i++; } } else { $lastSpace = strrpos($tmpLine, ' '); if ($lastSpace === false) { continue; } $formatted[] = trim(substr($tmpLine, 0, $lastSpace)); $tmpLine = substr($tmpLine, $lastSpace + 1); $tmpLineLength = strlen($tmpLine); } } } if (!empty($tmpLine)) { $formatted[] = $tmpLine; } } $formatted[] = ''; return $formatted; } /** * Create unique boundary identifier * * @return void */ protected function _createBoundary() { if (!empty($this->_attachments) || $this->_emailFormat === 'both') { $this->_boundary = md5(uniqid(time())); } } /** * Attach non-embedded files by adding file contents inside boundaries. * * @param string $boundary Boundary to use. If null, will default to $this->_boundary * @return array An array of lines to add to the message */ protected function _attachFiles($boundary = null) { if ($boundary === null) { $boundary = $this->_boundary; } $msg = array(); foreach ($this->_attachments as $filename => $fileInfo) { if (!empty($fileInfo['contentId'])) { continue; } $data = isset($fileInfo['data']) ? $fileInfo['data'] : $this->_readFile($fileInfo['file']); $msg[] = '--' . $boundary; $msg[] = 'Content-Type: ' . $fileInfo['mimetype']; $msg[] = 'Content-Transfer-Encoding: base64'; if ( !isset($fileInfo['contentDisposition']) || $fileInfo['contentDisposition'] ) { $msg[] = 'Content-Disposition: attachment; filename="' . $filename . '"'; } $msg[] = ''; $msg[] = $data; $msg[] = ''; } return $msg; } /** * Read the file contents and return a base64 version of the file contents. * * @param string $path The absolute path to the file to read. * @return string File contents in base64 encoding */ protected function _readFile($path) { $File = new File($path); return chunk_split(base64_encode($File->read())); } /** * Attach inline/embedded files to the message. * * @param string $boundary Boundary to use. If null, will default to $this->_boundary * @return array An array of lines to add to the message */ protected function _attachInlineFiles($boundary = null) { if ($boundary === null) { $boundary = $this->_boundary; } $msg = array(); foreach ($this->_attachments as $filename => $fileInfo) { if (empty($fileInfo['contentId'])) { continue; } $data = isset($fileInfo['data']) ? $fileInfo['data'] : $this->_readFile($fileInfo['file']); $msg[] = '--' . $boundary; $msg[] = 'Content-Type: ' . $fileInfo['mimetype']; $msg[] = 'Content-Transfer-Encoding: base64'; $msg[] = 'Content-ID: <' . $fileInfo['contentId'] . '>'; $msg[] = 'Content-Disposition: inline; filename="' . $filename . '"'; $msg[] = ''; $msg[] = $data; $msg[] = ''; } return $msg; } /** * Render the body of the email. * * @param array $content Content to render * @return array Email body ready to be sent */ protected function _render($content) { $this->_textMessage = $this->_htmlMessage = ''; $content = implode("\n", $content); $rendered = $this->_renderTemplates($content); $this->_createBoundary(); $msg = array(); $contentIds = array_filter((array)Hash::extract($this->_attachments, '{s}.contentId')); $hasInlineAttachments = count($contentIds) > 0; $hasAttachments = !empty($this->_attachments); $hasMultipleTypes = count($rendered) > 1; $boundary = $relBoundary = $textBoundary = $this->_boundary; if ($hasInlineAttachments) { $msg[] = '--' . $boundary; $msg[] = 'Content-Type: multipart/related; boundary="rel-' . $boundary . '"'; $msg[] = ''; $relBoundary = $textBoundary = 'rel-' . $boundary; } if ($hasMultipleTypes) { $msg[] = '--' . $relBoundary; $msg[] = 'Content-Type: multipart/alternative; boundary="alt-' . $boundary . '"'; $msg[] = ''; $textBoundary = 'alt-' . $boundary; } if (isset($rendered['text'])) { if ($textBoundary !== $boundary || $hasAttachments) { $msg[] = '--' . $textBoundary; $msg[] = 'Content-Type: text/plain; charset=' . $this->_getContentTypeCharset(); $msg[] = 'Content-Transfer-Encoding: ' . $this->_getContentTransferEncoding(); $msg[] = ''; } $this->_textMessage = $rendered['text']; $content = explode("\n", $this->_textMessage); $msg = array_merge($msg, $content); $msg[] = ''; } if (isset($rendered['html'])) { if ($textBoundary !== $boundary || $hasAttachments) { $msg[] = '--' . $textBoundary; $msg[] = 'Content-Type: text/html; charset=' . $this->_getContentTypeCharset(); $msg[] = 'Content-Transfer-Encoding: ' . $this->_getContentTransferEncoding(); $msg[] = ''; } $this->_htmlMessage = $rendered['html']; $content = explode("\n", $this->_htmlMessage); $msg = array_merge($msg, $content); $msg[] = ''; } if ($hasMultipleTypes) { $msg[] = '--' . $textBoundary . '--'; $msg[] = ''; } if ($hasInlineAttachments) { $attachments = $this->_attachInlineFiles($relBoundary); $msg = array_merge($msg, $attachments); $msg[] = ''; $msg[] = '--' . $relBoundary . '--'; $msg[] = ''; } if ($hasAttachments) { $attachments = $this->_attachFiles($boundary); $msg = array_merge($msg, $attachments); } if ($hasAttachments || $hasMultipleTypes) { $msg[] = ''; $msg[] = '--' . $boundary . '--'; $msg[] = ''; } return $msg; } /** * Gets the text body types that are in this email message * * @return array Array of types. Valid types are 'text' and 'html' */ protected function _getTypes() { $types = array($this->_emailFormat); if ($this->_emailFormat === 'both') { $types = array('html', 'text'); } return $types; } /** * Build and set all the view properties needed to render the templated emails. * If there is no template set, the $content will be returned in a hash * of the text content types for the email. * * @param string $content The content passed in from send() in most cases. * @return array The rendered content with html and text keys. */ protected function _renderTemplates($content) { $types = $this->_getTypes(); $rendered = array(); if (empty($this->_template)) { foreach ($types as $type) { $rendered[$type] = $this->_encodeString($content, $this->charset); } return $rendered; } $viewClass = $this->_viewRender; if ($viewClass !== 'View') { list($plugin, $viewClass) = pluginSplit($viewClass, true); $viewClass .= 'View'; App::uses($viewClass, $plugin . 'View'); } $View = new $viewClass(null); $View->viewVars = $this->_viewVars; $View->helpers = $this->_helpers; $View->loadHelpers(); list($templatePlugin, $template) = pluginSplit($this->_template); list($layoutPlugin, $layout) = pluginSplit($this->_layout); if ($templatePlugin) { $View->plugin = $templatePlugin; } elseif ($layoutPlugin) { $View->plugin = $layoutPlugin; } if ($this->_theme) { $View->theme = $this->_theme; } // Convert null to false, as View needs false to disable // the layout. if ($layout === null) { $layout = false; } if ($View->get('content') === null) { $View->set('content', $content); } foreach ($types as $type) { $View->hasRendered = false; $View->viewPath = $View->layoutPath = 'Emails' . DS . $type; $render = $View->render($template, $layout); $render = str_replace(array("\r\n", "\r"), "\n", $render); $rendered[$type] = $this->_encodeString($render, $this->charset); } foreach ($rendered as $type => $content) { $rendered[$type] = $this->_wrap($content); $rendered[$type] = implode("\n", $rendered[$type]); $rendered[$type] = rtrim($rendered[$type], "\n"); } return $rendered; } /** * Return the Content-Transfer Encoding value based on the set charset * * @return void */ protected function _getContentTransferEncoding() { $charset = strtoupper($this->charset); if (in_array($charset, $this->_charset8bit)) { return '8bit'; } return '7bit'; } /** * Return charset value for Content-Type. * * Checks fallback/compatibility types which include workarounds * for legacy japanese character sets. * * @return string */ protected function _getContentTypeCharset() { $charset = strtoupper($this->charset); if (array_key_exists($charset, $this->_contentTypeCharset)) { return strtoupper($this->_contentTypeCharset[$charset]); } return strtoupper($this->charset); } }