Implemented method to set/get Message-ID.

cakephp · Apr 13, 2011 · ace4258 · ace4258
1 parent 30dced7
commit ace4258
Show file tree

Hide file tree

Showing 2 changed files with 64 additions and 1 deletion.
diff --git a/lib/Cake/Network/CakeEmail.php b/lib/Cake/Network/CakeEmail.php
@@ -92,6 +92,13 @@ class CakeEmail {
  */
 	protected $_bcc = array();
 
+/**
+ * Message ID
+ *
+ * @var mixed True to generate, False to ignore, String with value
+ */
+	protected $_messageId = true;
+
 /**
  * The subject of the email
  *
@@ -531,6 +538,13 @@ public function getHeaders($include = array()) {
 		if (!isset($headers['Date'])) {
 			$headers['Date'] = date(DATE_RFC2822);
 		}
+		if ($this->_messageId !== false) {
+			if ($this->_messageId === true) {
+				$headers['Message-ID'] = '<' . String::UUID() . '@' . env('HTTP_HOST') . '>';
+			} else {
+				$headers['Message-ID'] = $this->_messageId;
+			}
+		}
 
 		$relation = array(
 			'from' => 'From',
@@ -615,6 +629,24 @@ public function setTransport($name) {
 		$this->_transportName = (string)$name;
 	}
 
+/**
+ * Set Message-ID
+ *
+ * @param mixed $message True to generate a new Message-ID, False to ignore (not send in email), String to set as Message-ID
+ * @return void
+ * @thrown SocketException
+ */
+	public function setMessageID($message) {
+		if (is_bool($message)) {
+			$this->_messageId = $message;
+		} else {
+			if (!preg_match('/^\<.+@.+\>$/', $message)) {
+				throw new SocketException(__('Invalid format to Message-ID. The text should be something like "<uuid@server.com>"'));
+			}
+			$this->_messageId = $message;
+		}
+	}
+
 /**
  * Set attachments
  *
@@ -678,6 +710,7 @@ public function reset() {
 		$this->_returnPath = array();
 		$this->_cc = array();
 		$this->_bcc = array();
+		$this->_messageId = true;
 		$this->_subject = '';
 		$this->_headers = array();
 		$this->_layout = 'default';

diff --git a/lib/Cake/tests/Case/Network/CakeEmailTest.php b/lib/Cake/tests/Case/Network/CakeEmailTest.php
@@ -139,7 +139,7 @@ public static function invalidEmails() {
  *
  * @dataProvider invalidEmails
  * @expectedException SocketException
- * return void
+ * @return void
  */
 	public function testInvalidEmail($value) {
 		$this->CakeEmail->setTo($value);
@@ -168,6 +168,35 @@ public function testFormatAddress() {
 		$this->assertIdentical($result, $expected);
 	}
 
+/**
+ * testMessageId method
+ *
+ * @return void
+ */
+	public function testMessageId() {
+		$this->CakeEmail->setMessageId(true);
+		$result = $this->CakeEmail->getHeaders();
+		$this->assertTrue(isset($result['Message-ID']));
+
+		$this->CakeEmail->setMessageId(false);
+		$result = $this->CakeEmail->getHeaders();
+		$this->assertFalse(isset($result['Message-ID']));
+
+		$this->CakeEmail->setMessageId('<my-email@localhost>');
+		$result = $this->CakeEmail->getHeaders();
+		$this->assertIdentical($result['Message-ID'], '<my-email@localhost>');
+	}
+
+/**
+ * testMessageIdInvalid method
+ *
+ * @return void
+ * @expectedException SocketException
+ */
+	public function testMessageIdInvalid() {
+		$this->CakeEmail->setMessageId('my-email@localhost');
+	}
+
 /**
  * testSubject method
  *
@@ -190,6 +219,7 @@ public function testSubject() {
  * @return void
  */
 	public function testHeaders() {
+		$this->CakeEmail->setMessageId(false);
 		$this->CakeEmail->setHeaders(array('X-Something' => 'nice'));
 		$expected = array(
 			'X-Something' => 'nice',