Added getUnseenMessages (#33)

* Added getUnseenMessages

Gets all messages flagged as unread..

* Changelog & Readme

Updated CHANGELOG.md & README.md

Author: k9uma

CHANGELOG.md

@@ -14,6 +14,9 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip
 ### Affected Classes
 - All
 
+## [1.0.3.6] - 2017-10-24
+### Added
+- A method to get only unread messages from email folders to [Client::class](src/IMAP/client.php)
 
 ## [1.0.3.5] - 2017-10-18
 ### Fixed

README.md

@@ -150,6 +150,7 @@ You can define your accounts inside the [config/imap.php](src/config/imap.php) f
 | openFolder            | \Webklex\IMAP\Folder $folder                      |          | Open a given folder.                                                                                                          |
 | createFolder          | string $name                                      |          | Create a new folder.                                                                                                          |
 | getMessages           | \Webklex\IMAP\Folder $folder, string $criteria    | array    | Get messages from folder.                                                                                                     |
+| getUnseenMessages     | \Webklex\IMAP\Folder $folder, string $criteria    | array    | Get Unseen messages from folder. |
 | getQuota              |                                                   | array    | Retrieve the quota level settings, and usage statics per mailbox                                                              |
 | getQuotaRoot          | string $quota_root                                | array    | Retrieve the quota settings per user                                                                                          |
 | countMessages         |                                                   | int      | Gets the number of messages in the current mailbox                                                                            |

src/IMAP/Client.php

@@ -311,6 +311,41 @@ public function getMessages(Folder $folder, $criteria = 'ALL', $fetch_options =
         }
     }
 
+    /**
+     * Get all unseen messages from folder
+     *
+     * @param Folder $folder
+     * @param string $criteria
+     * @param integer $fetch_options
+     *
+     * @return array
+     * @throws GetMessagesFailedException
+     */
+    public function getUnseenMessages(Folder $folder, $criteria = 'UNSEEN', $fetch_options = null) {
+        $this->checkConnection();
+
+        try {
+            $this->openFolder($folder);
+            $messages = [];
+            $availableMessages = imap_search($this->connection, $criteria, SE_UID);
+
+            if ($availableMessages !== false) {
+                $msglist = 1;
+                foreach ($availableMessages as $msgno) {
+                    $message = new Message($msgno, $msglist, $this, $fetch_options);
+
+                    $messages[$message->message_id] = $message;
+                    $msglist++;
+                }
+            }
+            return $messages;
+        } catch (\Exception $e) {
+            $message = $e->getMessage();
+
+            throw new GetMessagesFailedException($message);
+        }
+    }
+
     /**
      * Get option for imap_open and imap_reopen.
      * It supports only isReadOnly feature.