Use new Mailer namespace.

src/Database/Type/YearType.php

@@ -0,0 +1,72 @@
+<?php
+namespace Tools\Database\Type;
+
+use Cake\Database\Driver;
+use Cake\Database\Type;
+use PDO;
+
+/**
+ * Experimental year type (MySQL)
+ * 
+ * Needs:
+ * - Type::map('year', 'Tools\Database\Type\YearType'); in bootstrap
+ * - Manual FormHelper $this->Form->input('published', ['type' => 'year']);
+ * 
+ * 
+ */
+class YearType extends Type {
+
+	/**
+	 * Date format for DateTime object
+	 *
+	 * @var string
+	 */
+	protected $_format = 'Y';
+
+	/**
+	 * Convert binary data into the database format.
+	 *
+	 * Binary data is not altered before being inserted into the database.
+	 * As PDO will handle reading file handles.
+	 *
+	 * @param string|resource $value The value to convert.
+	 * @param Driver $driver The driver instance to convert with.
+	 * @return string|resource
+	 */
+	public function toDatabase($value, Driver $driver) {
+		if (is_array($value)) {
+			$value = $value['year'];
+		}
+		if ($value === null || !(int)$value) {
+			return null;
+		}
+		return $value;
+	}
+
+	/**
+	 * Convert binary into resource handles
+	 *
+	 * @param null|string|resource $value The value to convert.
+	 * @param Driver $driver The driver instance to convert with.
+	 * @return resource|null
+	 * @throws \Cake\Core\Exception\Exception
+	 */
+	public function toPHP($value, Driver $driver) {
+		if ($value === null || !(int)$value) {
+			return null;
+		}
+		return $value;
+	}
+
+	/**
+	 * Get the correct PDO binding type for Year data.
+	 *
+	 * @param mixed $value The value being bound.
+	 * @param Driver $driver The driver.
+	 * @return int
+	 */
+	public function toStatement($value, Driver $driver) {
+		return PDO::PARAM_INT;
+	}
+
+}

src/Mailer/Email.php

@@ -0,0 +1,553 @@
+<?php
+namespace Tools\Mailer;
+
+use Cake\Core\Configure;
+use Cake\Mailer\Email as CakeEmail;
+use Tools\Utility\Text;
+use InvalidArgumentException;
+use Tools\Utility\Mime;
+use Cake\Log\LogTrait;
+use Psr\Log\LogLevel;
+
+class Email extends CakeEmail {
+
+	use LogTrait;
+
+	protected $_wrapLength = null;
+
+	protected $_priority = null;
+
+	protected $_error = null;
+
+	public function __construct($config = null) {
+		if ($config === null) {
+			$config = 'default';
+		}
+		parent::__construct($config);
+	}
+
+	/**
+	 * Change the layout
+	 *
+	 * @param string $layout Layout to use (or false to use none)
+	 * @return resource EmailLib
+	 */
+	public function layout($layout = false) {
+		if ($layout !== false) {
+			$this->_layout = $layout;
+		}
+		return $this;
+	}
+
+	/**
+	 * Set/Get wrapLength
+	 *
+	 * @param int $length Must not be more than CakeEmail::LINE_LENGTH_MUST
+	 * @return int|CakeEmail
+	 */
+	public function wrapLength($length = null) {
+		if ($length === null) {
+			return $this->_wrapLength;
+		}
+		$this->_wrapLength = $length;
+		return $this;
+	}
+
+	/**
+	 * Set/Get priority
+	 *
+	 * @param int $priority 1 (highest) to 5 (lowest)
+	 * @return int|CakeEmail
+	 */
+	public function priority($priority = null) {
+		if ($priority === null) {
+			return $this->_priority;
+		}
+		$this->_priority = $priority;
+		return $this;
+	}
+
+	/**
+	 * Fix line length
+	 *
+	 * @overwrite
+	 * @param string $message Message to wrap
+	 * @return array Wrapped message
+	 */
+	protected function _wrap($message, $wrapLength = CakeEmail::LINE_LENGTH_MUST) {
+		if ($this->_wrapLength !== null) {
+			$wrapLength = $this->_wrapLength;
+		}
+		return parent::_wrap($message, $wrapLength);
+	}
+
+	/**
+	 * EmailLib::resetAndSet()
+	 *
+	 * @return void
+	 */
+	public function reset() {
+		parent::reset();
+		$this->_priority = null;
+		$this->_wrapLength = null;
+
+		$this->_error = null;
+		$this->_debug = null;
+	}
+
+	/**
+	 * Ovewrite to allow custom enhancements
+	 *
+	 * @param mixed $config
+	 * @return null|$this
+	 */
+	public function profile($config = null) {
+		if ($config === null) {
+			return $this->_profile;
+		}
+		if (!is_array($config)) {
+			$config = (string)$config;
+		}
+		$this->_applyConfig($config);
+
+		if ($fromEmail = Configure::read('Config.systemEmail')) {
+			$fromName = Configure::read('Config.systemName');
+		} else {
+			$fromEmail = Configure::read('Config.adminEmail');
+			$fromName = Configure::read('Config.adminName');
+		}
+		if ($fromEmail) {
+			$this->from($fromEmail, $fromName);
+		}
+
+		if ($xMailer = Configure::read('Config.xMailer')) {
+			$this->addHeaders(['X-Mailer' => $xMailer]);
+		}
+
+		return $this;
+	}
+
+	/**
+	 * Overwrite to allow mimetype detection
+	 *
+	 * @param mixed $attachments
+	 * @return
+	 */
+	public function attachments($attachments = null) {
+		if ($attachments === null) {
+			return $this->_attachments;
+		}
+		$attach = [];
+		foreach ((array)$attachments as $name => $fileInfo) {
+			if (!is_array($fileInfo)) {
+				$fileInfo = ['file' => $fileInfo];
+			}
+			if (!isset($fileInfo['file'])) {
+				if (!isset($fileInfo['data'])) {
+					throw new InvalidArgumentException('No file or data specified.');
+				}
+				if (is_int($name)) {
+					throw new InvalidArgumentException('No filename specified.');
+				}
+				$fileInfo['data'] = chunk_split(base64_encode($fileInfo['data']), 76, "\r\n");
+			} else {
+				$fileName = $fileInfo['file'];
+				$fileInfo['file'] = realpath($fileInfo['file']);
+				if ($fileInfo['file'] === false || !file_exists($fileInfo['file'])) {
+					throw new InvalidArgumentException(sprintf('File not found: "%s"', $fileName));
+				}
+				if (is_int($name)) {
+					$name = basename($fileInfo['file']);
+				}
+			}
+			if (!isset($fileInfo['mimetype'])) {
+				$ext = pathinfo($name, PATHINFO_EXTENSION);
+				$fileInfo['mimetype'] = $this->_getMimeByExtension($ext);
+			}
+			$attach[$name] = $fileInfo;
+		}
+		$this->_attachments = $attach;
+		return $this;
+	}
+
+	/**
+	 * Add an attachment from file
+	 *
+	 * @param string $file: absolute path
+	 * @param string $filename
+	 * @param array $fileInfo
+	 * @return resource EmailLib
+	 */
+	public function addAttachment($file, $name = null, $fileInfo = []) {
+		$fileInfo['file'] = $file;
+		if (!empty($name)) {
+			$fileInfo = [$name => $fileInfo];
+		} else {
+			$fileInfo = [$fileInfo];
+		}
+		return $this->addAttachments($fileInfo);
+	}
+
+	/**
+	 * Add an attachment as blob
+	 *
+	 * @param binary $content: blob data
+	 * @param string $filename to attach it
+	 * @param string $mimeType (leave it empty to get mimetype from $filename)
+	 * @param array $fileInfo
+	 * @return resource EmailLib
+	 */
+	public function addBlobAttachment($content, $filename, $mimeType = null, $fileInfo = []) {
+		if ($mimeType === null) {
+			$ext = pathinfo($filename, PATHINFO_EXTENSION);
+			$mimeType = $this->_getMimeByExtension($ext);
+		}
+		$fileInfo['data'] = $content;
+		$fileInfo['mimetype'] = $mimeType;
+		$file = [$filename => $fileInfo];
+		return $this->addAttachments($file);
+	}
+
+	/**
+	 * Add an inline attachment from file
+	 *
+	 * Options:
+	 * - mimetype
+	 * - contentDisposition
+	 *
+	 * @param string $file: absolute path
+	 * @param string $filename (optional)
+	 * @param string $contentId (optional)
+	 * @param array $options Options
+	 * @return mixed resource $EmailLib or string $contentId
+	 */
+	public function addEmbeddedAttachment($file, $name = null, $contentId = null, $options = []) {
+		if (empty($name)) {
+			$name = basename($file);
+		}
+		if ($contentId === null && ($cid = $this->_isEmbeddedAttachment($file, $name))) {
+			return $cid;
+		}
+
+		$options['file'] = $file;
+		if (empty($options['mimetype'])) {
+			$options['mimetype'] = $this->_getMime($file);
+		}
+		$options['contentId'] = $contentId ? $contentId : str_replace('-', '', Text::uuid()) . '@' . $this->_domain;
+		$file = [$name => $options];
+		$res = $this->addAttachments($file);
+		if ($contentId === null) {
+			return $options['contentId'];
+		}
+		return $res;
+	}
+
+	/**
+	 * Add an inline attachment as blob
+	 *
+	 * Options:
+	 * - contentDisposition
+	 *
+	 * @param binary $content: blob data
+	 * @param string $filename to attach it
+	 * @param string $mimeType (leave it empty to get mimetype from $filename)
+	 * @param string $contentId (optional)
+	 * @param array $options Options
+	 * @return mixed resource $EmailLib or string $contentId
+	 */
+	public function addEmbeddedBlobAttachment($content, $filename, $mimeType = null, $contentId = null, $options = []) {
+		if ($mimeType === null) {
+			$ext = pathinfo($filename, PATHINFO_EXTENSION);
+			$mimeType = $this->_getMimeByExtension($ext);
+		}
+		$options['data'] = $content;
+		$options['mimetype'] = $mimeType;
+		$options['contentId'] = $contentId ? $contentId : str_replace('-', '', Text::uuid()) . '@' . $this->_domain;
+		$file = [$filename => $options];
+		$res = $this->addAttachments($file);
+		if ($contentId === null) {
+			return $options['contentId'];
+		}
+		return $res;
+	}
+
+	/**
+	 * Returns if this particular file has already been attached as embedded file with this exact name
+	 * to prevent the same image to overwrite each other and also to only send this image once.
+	 * Allows multiple usage of the same embedded image (using the same cid)
+	 *
+	 * @return string cid of the found file or false if no such attachment can be found
+	 */
+	protected function _isEmbeddedAttachment($file, $name) {
+		foreach ($this->_attachments as $filename => $fileInfo) {
+			if ($filename !== $name) {
+				continue;
+			}
+			if ($fileInfo['file'] === $file) {
+				return $fileInfo['contentId'];
+			}
+		}
+		return false;
+	}
+
+	protected function _getMimeByExtension($ext, $default = 'application/octet-stream') {
+		if (!isset($this->_Mime)) {
+			$this->_Mime = new Mime();
+		}
+		$mime = $this->_Mime->getMimeTypeByAlias($ext);
+		if (!$mime) {
+			$mime = $default;
+		}
+		return $mime;
+	}
+
+	/**
+	 * Try to find mimetype by file extension
+	 *
+	 * @param string $ext lowercase (jpg, png, pdf, ...)
+	 * @param string $defaultMimeType
+	 * @return string Mimetype (falls back to `application/octet-stream`)
+	 */
+	protected function _getMime($filename, $default = 'application/octet-stream') {
+		if (!isset($this->_Mime)) {
+			$this->_Mime = new Mime();
+		}
+		$mime = $this->_Mime->detectMimeType($filename);
+		// Some environments falsely return the default too fast, better fallback to extension here
+		if (!$mime || $mime === $default) {
+			$ext = pathinfo($filename, PATHINFO_EXTENSION);
+			$mime = $this->_Mime->getMimeTypeByAlias($ext);
+		}
+		return $mime;
+	}
+
+	/**
+	 * Read the file contents and return a base64 version of the file contents.
+	 * Overwrite parent to avoid File class and file_exists to false negative existent
+	 * remove images.
+	 * Also fixes file_get_contents (used via File class) to close the connection again
+	 * after getting remote files. So far it would have kept the connection open in HTTP/1.1.
+	 *
+	 * @param string $path The absolute path to the file to read.
+	 * @return string File contents in base64 encoding
+	 */
+	protected function _readFile($path) {
+		$context = stream_context_create(
+			['http' => ['header' => 'Connection: close']]);
+		$content = file_get_contents($path, 0, $context);
+		if (!$content) {
+			trigger_error('No content found for ' . $path);
+		}
+		return chunk_split(base64_encode($content));
+	}
+
+	/**
+	 * Validate if the email has the required fields necessary to make send() work.
+	 * Assumes layouting (does not check on content to be present or if view/layout files are missing).
+	 *
+	 * @return bool Success
+	 */
+	public function validates() {
+		if (!empty($this->_subject) && !empty($this->_to)) {
+			return true;
+		}
+		return false;
+	}
+
+	/**
+	 * Set the body of the mail as we send it.
+	 * Note: the text can be an array, each element will appear as a seperate line in the message body.
+	 *
+	 * Do NOT pass a message if you use $this->set() in combination with templates
+	 *
+	 * @overwrite
+	 * @param string/array: message
+	 * @return bool Success
+	 */
+	public function send($message = null) {
+		$this->_log = [
+			'to' => $this->_to,
+			'from' => $this->_from,
+			'sender' => $this->_sender,
+			'replyTo' => $this->_replyTo,
+			'cc' => $this->_cc,
+			'subject' => $this->_subject,
+			'bcc' => $this->_bcc,
+			'transport' => get_class($this->_transport),
+		];
+		if ($this->_priority) {
+			$this->_headers['X-Priority'] = $this->_priority;
+			//$this->_headers['X-MSMail-Priority'] = 'High';
+			//$this->_headers['Importance'] = 'High';
+		}
+
+		// if not live, just log but do not send any mails //TODO: remove and use Debug Transport!
+		if (!Configure::read('Config.live')) {
+			$this->_logEmail();
+			return true;
+		}
+
+		// Security measure to not sent to the actual addressee in debug mode while email sending is live
+		if (Configure::read('debug') && Configure::read('Config.live')) {
+			$adminEmail = Configure::read('Config.adminEmail');
+
+			if (!$adminEmail) {
+				$adminEmail = Configure::read('Config.systemEmail');
+			}
+
+			foreach ($this->_to as $k => $v) {
+				if ($k === $adminEmail) {
+					continue;
+				}
+				unset($this->_to[$k]);
+				$this->_to[$adminEmail] = $v;
+			}
+			foreach ($this->_cc as $k => $v) {
+				if ($k === $adminEmail) {
+					continue;
+				}
+				unset($this->_cc[$k]);
+				$this->_cc[$adminEmail] = $v;
+			}
+			foreach ($this->_bcc as $k => $v) {
+				if ($k === $adminEmail) {
+					continue;
+				}
+				unset($this->_bcc[$k]);
+				$this->_bcc[] = $v;
+			}
+		}
+
+		try {
+			$this->_debug = parent::send($message);
+		} catch (\Exception $e) {
+			$this->_error = $e->getMessage();
+			$this->_error .= ' (line ' . $e->getLine() . ' in ' . $e->getFile() . ')' . PHP_EOL .
+				$e->getTraceAsString();
+
+			// always log report
+			$this->_logEmail(LogLevel::ERROR);
+
+			// log error
+			$this->log($this->_error, LogLevel::ERROR);
+
+			return false;
+		}
+
+		if (!empty($this->_profile['logReport'])) {
+			$this->_logEmail();
+		}
+
+		return true;
+	}
+
+	/**
+	 * @param string $level
+	 * @return void
+	 */
+	protected function _logEmail($level = LogLevel::INFO)
+	{
+		$content =
+			$this->_log['transport'] . (!Configure::read('Config.live') ? ' (simulated)' : '')
+			. ' - ' . 'TO:' . implode(',', array_keys($this->_log['to']))
+			. '||FROM:' . implode(',', array_keys($this->_log['from']))
+			. '||REPLY:' . implode(',', array_keys($this->_log['replyTo']))
+			. '||S:' . $this->_log['subject'];
+
+		$this->log($content, $level);
+	}
+
+	/**
+	 * Attach inline/embedded files to the message.
+	 *
+	 * CUSTOM FIX: blob data support
+	 *
+	 * @override
+	 * @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 = [];
+		foreach ($this->_attachments as $filename => $fileInfo) {
+			if (empty($fileInfo['contentId'])) {
+				continue;
+			}
+			if (!empty($fileInfo['data'])) {
+				$data = $fileInfo['data'];
+				$data = chunk_split(base64_encode($data));
+			} elseif (!empty($fileInfo['file'])) {
+				$data = $this->_readFile($fileInfo['file']);
+			} else {
+				continue;
+			}
+
+			$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;
+	}
+
+	/**
+	 * Attach non-embedded files by adding file contents inside boundaries.
+	 *
+	 * CUSTOM FIX: blob data support
+	 *
+	 * @override
+	 * @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 = [];
+		foreach ($this->_attachments as $filename => $fileInfo) {
+			if (!empty($fileInfo['contentId'])) {
+				continue;
+			}
+			if (!empty($fileInfo['data'])) {
+				$data = $fileInfo['data'];
+				$data = chunk_split(base64_encode($data));
+			} elseif (!empty($fileInfo['file'])) {
+				$data = $this->_readFile($fileInfo['file']);
+			} else {
+				continue;
+			}
+
+			$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;
+	}
+
+	/**
+	 * Returns the error if existent
+	 *
+	 * @return string
+	 */
+	public function getError() {
+		return $this->_error;
+	}
+
+}

src/Network/Email/Email.php

@@ -2,14 +2,14 @@
 namespace Tools\Network\Email;
 
 use Cake\Core\Configure;
-use Cake\Network\Email\Email as CakeEmail;
+use Tools\Mailer\Email as ToolsEmail;
 use Tools\Utility\Text;
 use InvalidArgumentException;
 use Tools\Utility\Mime;
 use Cake\Log\LogTrait;
 use Psr\Log\LogLevel;
 
-class Email extends CakeEmail {
+class Email extends ToolsEmail {
 
 	use LogTrait;
 
@@ -20,6 +20,7 @@ class Email extends CakeEmail {
 	protected $_error = null;
 
 	public function __construct($config = null) {
+		trigger_error('Use Tools\Mailer\Email instead.', E_USER_DEPRECATED);
 		if ($config === null) {
 			$config = 'default';
 		}