[mms] Deprecated Horde_Mime::generateMessageId() and move to Horde_Mi…

…me_Headers.
horde · Sep 23, 2014 · fc2016c · fc2016c
1 parent 4fe8879
commit fc2016c
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 12 deletions.
diff --git a/framework/Mime/doc/Horde/Mime/UPGRADING b/framework/Mime/doc/Horde/Mime/UPGRADING
@@ -16,10 +16,21 @@ Upgrading to 2.5
 
   - Horde_Mime
 
+    - generateMessageId()
+
+      This method is deprecated. Use Horde_Mime_Headers#generateMessageId()
+      instead.
+
     - uudecode()
 
       This method is deprecated. Use the Horde_Mime_Uudecode() class instead.
 
+  - Horde_Mime_Headers
+
+    - generateMessageId()
+
+       This method was added.
+
   - Horde_Mime_Uudecode
 
     This class was added.

diff --git a/framework/Mime/lib/Horde/Mime.php b/framework/Mime/lib/Horde/Mime.php
@@ -541,17 +541,6 @@ static public function decodeParam($type, $data)
         return $ret;
     }
 
-    /**
-     * Generates a Message-ID string conforming to RFC 2822 [3.6.4] and the
-     * standards outlined in 'draft-ietf-usefor-message-id-01.txt'.
-     *
-     * @param string  A message ID string.
-     */
-    static public function generateMessageId()
-    {
-        return '<' . strval(new Horde_Support_Guid(array('prefix' => 'Horde'))) . '>';
-    }
-
     /**
      * Performs MIME ID "arithmetic" on a given ID.
      *
@@ -642,6 +631,15 @@ static public function isChild($base, $id)
 
     /* Deprecated methods. */
 
+    /**
+     * @deprecated  Use Horde_Mime_Headers#generateMessageId() instead.
+     */
+    static public function generateMessageId()
+    {
+        $hdr = new Horde_Mime_Headers();
+        return $hdr->generateMessageId();
+    }
+
     /**
      * @deprecated  Use Horde_Mime_Uudecode instead.
      */

diff --git a/framework/Mime/lib/Horde/Mime/Headers.php b/framework/Mime/lib/Horde/Mime/Headers.php
@@ -285,10 +285,28 @@ public function addReceivedHeader(array $opts = array())
 
     /**
      * Generate the 'Message-ID' header.
+     *
+     * @todo All messages require Message-ID, so this should be done
+     *       automatically.
      */
     public function addMessageIdHeader()
     {
-        $this->addHeader('Message-ID', Horde_Mime::generateMessageId());
+        $this->addHeader('Message-ID', $this->generateMessageId());
+    }
+
+    /**
+     * Generates a Message-ID string conforming to RFC 2822 [3.6.4] and the
+     * standards outlined in 'draft-ietf-usefor-message-id-01.txt'.
+     *
+     * @since 2.5.0
+     *
+     * @param string $prefix  A unique prefix to use.
+     *
+     * @return string  A message ID.
+     */
+    public function generateMessageId($prefix = 'Horde')
+    {
+        return '<' . strval(new Horde_Support_Guid(array('prefix' => $prefix))) . '>';
     }
 
     /**

diff --git a/framework/Mime/package.xml b/framework/Mime/package.xml
@@ -28,6 +28,7 @@
  </stability>
  <license uri="http://www.horde.org/licenses/lgpl21">LGPL-2.1</license>
  <notes>
+* [mms] Deprecated Horde_Mime::generateMessageId() and move to Horde_Mime_Headers.
 * [mms] Deprecated Horde_Mime::uudecode() and move to new Horde_Mime_Uudecode class.
 * [mms] Add Auto-Submitted header to outgoing MDN messages.
  </notes>
@@ -1435,6 +1436,7 @@
    <date>2014-09-20</date>
    <license uri="http://www.horde.org/licenses/lgpl21">LGPL-2.1</license>
    <notes>
+* [mms] Deprecated Horde_Mime::generateMessageId() and move to Horde_Mime_Headers.
 * [mms] Deprecated Horde_Mime::uudecode() and move to new Horde_Mime_Uudecode class.
 * [mms] Add Auto-Submitted header to outgoing MDN messages.
    </notes>