Create a fast count method for queries #216

Author: Webklex

CHANGELOG.md

@@ -12,6 +12,7 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip
 
 ### Added
 - Message::getFolder() method
+- Create a fast count method for queries #216
 
 ### Affected Classes
 - [Message::class](src/IMAP/Message.php)

README.md

@@ -20,6 +20,7 @@ Laravel IMAP is an easy way to integrate the native php imap library into your *
     - [Facade](#facade)
     - [Folder / Mailbox](#folder--mailbox)
     - [Search](#search-for-messages)
+    - [Counting messages](#counting-messages)
     - [Result limiting](#result-limiting)
     - [Pagination](#pagination)
     - [View examples](#view-examples)
@@ -332,6 +333,19 @@ Limiting the request emails:
 $aMessage = $oFolder->query()->since('15.03.2018')->limit(10, 2)->get();
 ```
 
+#### Counting messages
+Count all available messages matching the current search criteria:
+``` php
+/** @var \Webklex\IMAP\Folder $oFolder */
+
+//Count all messages
+/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
+$count = $oFolder->query()->all()->count();
+
+//Count all messages since march 15 2018
+$count = $oFolder->query()->since('15.03.2018')->count();
+```
+
 #### Pagination
 Paginate a query:
 ``` php
@@ -707,6 +721,7 @@ if you're just wishing a feature ;)
 | body               | string $value                     | WhereQuery        | Select messages matching a given HTML body |
 | before             | string $value                     | WhereQuery        | Select messages before a given date |
 | bcc                | string $value                     | WhereQuery        | Select messages matching a given receiver (BCC:) |
+| count              |                                   | integer           | Count all available messages matching the current search criteria |
 | get                |                                   | MessageCollection | Fetch messages with the current query |
 | limit              | integer $limit, integer $page = 1 | WhereQuery        | Limit the amount of messages being fetched |
 | setFetchOptions    | boolean $fetch_options            | WhereQuery        | Set the fetch options |

src/IMAP/Query/Query.php

@@ -165,6 +165,16 @@ protected function search(){
         return collect();
     }
 
+    /**
+     * Count all available messages matching the current search criteria
+     *
+     * @return int
+     * @throws \Webklex\IMAP\Exceptions\ConnectionFailedException
+     */
+    public function count() {
+        return $this->search()->count();
+    }
+
     /**
      * Fetch the current query and return all found messages
      *