Implement bulk-move

Fixes ddeboer#305

src/Mailbox.php

@@ -247,4 +247,25 @@ public function getThread(): array
 
         return false !== $tree ? $tree : [];
     }
+
+    /**
+     * Bulk move messages.
+     *
+     * @param array|MessageIteratorInterface|string $numbers Message numbers
+     * @param MailboxInterface                      $mailbox Destination Mailbox to move the messages to
+     *
+     * @return bool true on success
+     */
+    public function move($numbers, MailboxInterface $mailbox): bool
+    {
+        if ($numbers instanceof MessageIterator) {
+            $numbers = $numbers->getArrayCopy();
+        }
+
+        if (\is_array($numbers)) {
+            $numbers = \implode(',', $numbers);
+        }
+
+        return \imap_mail_move($this->resource->getStream(), (string) $numbers, $mailbox->getEncodedName(), \CP_UID);
+    }
 }

src/MailboxInterface.php

@@ -118,4 +118,14 @@ public function addMessage(string $message, string $options = null, DateTimeInte
      * @return array
      */
     public function getThread(): array;
+
+    /**
+     * Bulk move messages.
+     *
+     * @param array|MessageIteratorInterface|string $numbers Message numbers
+     * @param MailboxInterface                      $mailbox Destination Mailbox to move the messages to
+     *
+     * @return bool true on success
+     */
+    public function move($numbers, self $mailbox): bool;
 }

tests/MailboxTest.php

@@ -7,7 +7,7 @@
 use DateTimeImmutable;
 use Ddeboer\Imap\Exception\MessageDoesNotExistException;
 use Ddeboer\Imap\Exception\ReopenMailboxException;
-use Ddeboer\Imap\Mailbox;
+use Ddeboer\Imap\MailboxInterface;
 
 /**
  * @covers \Ddeboer\Imap\Exception\AbstractException
@@ -16,6 +16,7 @@
  */
 final class MailboxTest extends AbstractTest
 {
+    /** @var MailboxInterface */
     protected $mailbox;
 
     protected function setUp()
@@ -215,4 +216,27 @@ public function testAppendOptionalArguments()
         $this->assertTrue($message->isSeen());
         $this->assertSame(' 3-Jan-2012 09:30:03 +0000', $message->getHeaders()->get('maildate'));
     }
+
+    public function testBulkMove()
+    {
+        $anotherMailbox = $this->createMailbox();
+
+        // Test move by id
+        $messages = [1, 2, 3];
+
+        $this->assertSame(0, $anotherMailbox->count());
+        $this->mailbox->move($messages, $anotherMailbox);
+        $this->getConnection()->expunge();
+
+        $this->assertSame(3, $anotherMailbox->count());
+        $this->assertSame(0, $this->mailbox->count());
+
+        // move back by iterator
+        $messages = $anotherMailbox->getMessages();
+        $anotherMailbox->move($messages, $this->mailbox);
+        $this->getConnection()->expunge();
+
+        $this->assertSame(0, $anotherMailbox->count());
+        $this->assertSame(3, $this->mailbox->count());
+    }
 }