Protocol::moveMessage() method added Webklex#29

Author: Webklex

CHANGELOG.md

@@ -10,7 +10,7 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip
 - Missing variable check added to prevent exception while parsing an address [webklex/laravel-imap #356](https://github.com/Webklex/laravel-imap/issues/356)
 
 ### Added
-- NaN
+- `Protocol::moveMessage()` method added #29
 
 ### Affected Classes
 - [Message::class](src/Message.php)

src/Connection/Protocols/ImapProtocol.php

@@ -805,6 +805,25 @@ public function copyMessage($folder, $from, $to = null) {
         return $this->requestAndResponse('COPY', [$set, $this->escapeString($folder)], true);
     }
 
+    /**
+     * Move a message set from current folder to an other folder
+     * @param string $folder destination folder
+     * @param $from
+     * @param int|null $to if null only one message ($from) is fetched, else it's the
+     *                         last message, INF means last message available
+     *
+     * @return bool success
+     * @throws RuntimeException
+     */
+    public function moveMessage($folder, $from, $to = null) {
+        $set = (int)$from;
+        if ($to !== null) {
+            $set .= ':' . ($to == INF ? '*' : (int)$to);
+        }
+
+        return $this->requestAndResponse('MOVE', [$set, $this->escapeString($folder)], true);
+    }
+
     /**
      * Create a new folder (and parent folders if needed)
      * @param string $folder folder name

src/Connection/Protocols/LegacyProtocol.php

@@ -357,6 +357,19 @@ public function copyMessage($folder, $from, $to = null) {
         return \imap_mail_copy($this->stream, $from, $folder, IMAP::CP_UID);
     }
 
+    /**
+     * Move a message set from current folder to an other folder
+     * @param string $folder destination folder
+     * @param $from
+     * @param int|null $to if null only one message ($from) is fetched, else it's the
+     *                         last message, INF means last message available
+     *
+     * @return bool success
+     */
+    public function moveMessage($folder, $from, $to = null) {
+        return \imap_mail_move($this->stream, $from, $folder, IMAP::CP_UID);
+    }
+
     /**
      * Create a new folder (and parent folders if needed)
      * @param string $folder folder name

src/Connection/Protocols/ProtocolInterface.php

@@ -184,6 +184,17 @@ public function appendMessage($folder, $message, $flags = null, $date = null);
      */
     public function copyMessage($folder, $from, $to = null);
 
+    /**
+     * Move a message set from current folder to an other folder
+     * @param string $folder destination folder
+     * @param $from
+     * @param int|null $to if null only one message ($from) is fetched, else it's the
+     *                         last message, INF means last message available
+     *
+     * @return bool success
+     */
+    public function moveMessage($folder, $from, $to = null);
+
     /**
      * Create a new folder
      *