Get messages by UID sequence (#373)

* Added getMessageSequence method to Mailbox * Added tests and fixed code style * Added test for empty sequence
ddeboer · Dec 4, 2018 · 6eee3d3 · 6eee3d3
1 parent 0078d24
commit 6eee3d3
Show file tree

Hide file tree

Showing 3 changed files with 62 additions and 0 deletions.
diff --git a/src/Mailbox.php b/src/Mailbox.php
@@ -178,6 +178,31 @@ public function getMessages(ConditionInterface $search = null, int $sortCriteria
         return new MessageIterator($this->resource, $messageNumbers);
     }
 
+    /**
+     * Get message iterator for a sequence.
+     *
+     * @param string $sequence Message numbers
+     *
+     * @return MessageIteratorInterface
+     */
+    public function getMessageSequence(string $sequence): MessageIteratorInterface
+    {
+        \imap_errors();
+
+        $overview = \imap_fetch_overview($this->resource->getStream(), $sequence, FT_UID);
+        if (empty($overview)) {
+            if (false !== \imap_last_error()) {
+                throw new InvalidSearchCriteriaException(\sprintf('Invalid sequence [%s]', $sequence));
+            }
+
+            $messageNumbers = [];
+        } else {
+            $messageNumbers = \array_column($overview, 'uid');
+        }
+
+        return new MessageIterator($this->resource, $messageNumbers);
+    }
+
     /**
      * Get a message by message number.
      *

diff --git a/src/MailboxInterface.php b/src/MailboxInterface.php
@@ -85,6 +85,15 @@ public function clearFlag(string $flag, $numbers): bool;
      */
     public function getMessages(ConditionInterface $search = null, int $sortCriteria = null, bool $descending = false): MessageIteratorInterface;
 
+    /**
+     * Get message iterator for a sequence.
+     *
+     * @param string $sequence Message numbers
+     *
+     * @return MessageIteratorInterface
+     */
+    public function getMessageSequence(string $sequence): MessageIteratorInterface;
+
     /**
      * Get a message by message number.
      *

diff --git a/tests/MailboxTest.php b/tests/MailboxTest.php
@@ -5,6 +5,7 @@
 namespace Ddeboer\Imap\Tests;
 
 use DateTimeImmutable;
+use Ddeboer\Imap\Exception\InvalidSearchCriteriaException;
 use Ddeboer\Imap\Exception\MessageCopyException;
 use Ddeboer\Imap\Exception\MessageDoesNotExistException;
 use Ddeboer\Imap\Exception\MessageMoveException;
@@ -71,6 +72,33 @@ public function testGetMessages()
         $this->assertSame(3, $aggregateIteratorMethodInc);
     }
 
+    public function testGetMessageSequence()
+    {
+        $inc = 0;
+        foreach ($this->mailbox->getMessageSequence('1:*') as $message) {
+            ++$inc;
+        }
+        $this->assertSame(3, $inc);
+
+        $inc = 0;
+        foreach ($this->mailbox->getMessageSequence('1:2') as $message) {
+            ++$inc;
+        }
+
+        $this->assertSame(2, $inc);
+        $inc = 0;
+        foreach ($this->mailbox->getMessageSequence('99998:99999') as $message) {
+            ++$inc;
+        }
+        $this->assertSame(0, $inc);
+    }
+
+    public function testGetMessageSequenceThrowsException()
+    {
+        $this->expectException(InvalidSearchCriteriaException::class);
+        $this->mailbox->getMessageSequence('-1:x');
+    }
+
     public function testGetMessageThrowsException()
     {
         $message = $this->mailbox->getMessage(999);