Add charset for imap_search or imap_sort (#402)

Closes #337 #401
ddeboer · Mar 1, 2019 · 4ac25b7 · 4ac25b7
1 parent a21db3f
commit 4ac25b7
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 27 deletions.
diff --git a/src/Mailbox.php b/src/Mailbox.php
@@ -167,7 +167,7 @@ public function clearFlag(string $flag, $numbers): bool
      *
      * @return MessageIteratorInterface
      */
-    public function getMessages(ConditionInterface $search = null, int $sortCriteria = null, bool $descending = false): MessageIteratorInterface
+    public function getMessages(ConditionInterface $search = null, int $sortCriteria = null, bool $descending = false, string $charset = 'UTF-8'): MessageIteratorInterface
     {
         if (null === $search) {
             $search = new All();
@@ -179,9 +179,9 @@ public function getMessages(ConditionInterface $search = null, int $sortCriteria
         \imap_errors();
 
         if (null !== $sortCriteria) {
-            $messageNumbers = \imap_sort($this->resource->getStream(), $sortCriteria, $descending ? 1 : 0, \SE_UID, $query);
+            $messageNumbers = \imap_sort($this->resource->getStream(), $sortCriteria, $descending ? 1 : 0, \SE_UID, $query, $charset);
         } else {
-            $messageNumbers = \imap_search($this->resource->getStream(), $query, \SE_UID);
+            $messageNumbers = \imap_search($this->resource->getStream(), $query, \SE_UID, $charset);
         }
         if (false === $messageNumbers) {
             if (false !== \imap_last_error()) {

diff --git a/src/MailboxInterface.php b/src/MailboxInterface.php
@@ -83,7 +83,7 @@ public function clearFlag(string $flag, $numbers): bool;
      *
      * @return MessageIteratorInterface
      */
-    public function getMessages(ConditionInterface $search = null, int $sortCriteria = null, bool $descending = false): MessageIteratorInterface;
+    public function getMessages(ConditionInterface $search = null, int $sortCriteria = null, bool $descending = false, string $charset = 'UTF-8'): MessageIteratorInterface;
 
     /**
      * Get message iterator for a sequence.

diff --git a/tests/MailboxTest.php b/tests/MailboxTest.php
@@ -12,6 +12,8 @@
 use Ddeboer\Imap\Exception\ReopenMailboxException;
 use Ddeboer\Imap\MailboxInterface;
 use Ddeboer\Imap\MessageIterator;
+use Ddeboer\Imap\MessageIteratorInterface;
+use Ddeboer\Imap\Search;
 
 /**
  * @covers \Ddeboer\Imap\Exception\AbstractException
@@ -298,4 +300,54 @@ public function testBulkCopy()
         $this->expectException(MessageCopyException::class);
         $this->mailbox->copy($messages, $anotherMailbox);
     }
+
+    public function testSort()
+    {
+        $anotherMailbox = $this->createMailbox();
+        $this->createTestMessage($anotherMailbox, 'B');
+        $this->createTestMessage($anotherMailbox, 'A');
+        $this->createTestMessage($anotherMailbox, 'C');
+
+        $concatSubjects = function (MessageIteratorInterface $it) {
+            $subject = '';
+            foreach ($it as $message) {
+                $subject .= $message->getSubject();
+            }
+
+            return $subject;
+        };
+
+        $this->assertSame('BAC', $concatSubjects($anotherMailbox->getMessages()));
+        $this->assertSame('ABC', $concatSubjects($anotherMailbox->getMessages(null, \SORTSUBJECT)));
+        $this->assertSame('CBA', $concatSubjects($anotherMailbox->getMessages(null, \SORTSUBJECT, true)));
+        $this->assertSame('B', $concatSubjects($anotherMailbox->getMessages(new Search\Text\Subject('B'), \SORTSUBJECT, true)));
+    }
+
+    public function testGetMessagesWithUtf8Subject()
+    {
+        $anotherMailbox = $this->createMailbox();
+        $this->createTestMessage($anotherMailbox, '1', 'Ж П');
+        $this->createTestMessage($anotherMailbox, '2', 'Ж б');
+        $this->createTestMessage($anotherMailbox, '3', 'б П');
+
+        $messagesFound = '';
+        foreach ($anotherMailbox->getMessages(new Search\Text\Body(\mb_convert_encoding('б', 'Windows-1251', 'UTF-8')), null, false, 'Windows-1251') as $message) {
+            $subject = $message->getSubject();
+            $this->assertIsString($subject);
+
+            $messagesFound .= \substr($subject, 0, 1);
+        }
+
+        $this->assertSame('23', $messagesFound);
+
+        $messagesFound = '';
+        foreach ($anotherMailbox->getMessages(new Search\Text\Body(\mb_convert_encoding('П', 'Windows-1251', 'UTF-8')), \SORTSUBJECT, true, 'Windows-1251') as $message) {
+            $subject = $message->getSubject();
+            $this->assertIsString($subject);
+
+            $messagesFound .= \substr($subject, 0, 1);
+        }
+
+        $this->assertSame('31', $messagesFound);
+    }
 }
diff --git a/tests/MessageTest.php b/tests/MessageTest.php
@@ -15,8 +15,6 @@
 use Ddeboer\Imap\Message\PartInterface;
 use Ddeboer\Imap\Message\Transcoder;
 use Ddeboer\Imap\MessageInterface;
-use Ddeboer\Imap\MessageIteratorInterface;
-use Ddeboer\Imap\Search;
 use PHPUnit\Framework\Error\Deprecated;
 use ReflectionClass;
 use Zend\Mail;
@@ -759,27 +757,6 @@ public function testIssue142()
         $this->assertCount(1, $message->getAttachments());
     }
 
-    public function testSort()
-    {
-        $this->createTestMessage($this->mailbox, 'B');
-        $this->createTestMessage($this->mailbox, 'A');
-        $this->createTestMessage($this->mailbox, 'C');
-
-        $concatSubjects = function (MessageIteratorInterface $it) {
-            $subject = '';
-            foreach ($it as $message) {
-                $subject .= $message->getSubject();
-            }
-
-            return $subject;
-        };
-
-        $this->assertSame('BAC', $concatSubjects($this->mailbox->getMessages()));
-        $this->assertSame('ABC', $concatSubjects($this->mailbox->getMessages(null, \SORTSUBJECT)));
-        $this->assertSame('CBA', $concatSubjects($this->mailbox->getMessages(null, \SORTSUBJECT, true)));
-        $this->assertSame('B', $concatSubjects($this->mailbox->getMessages(new Search\Text\Subject('B'), \SORTSUBJECT, true)));
-    }
-
     public function testSignedMessage()
     {
         $fixture = $this->getFixture('pec');