Query::paginate() method added

Author: Webklex

CHANGELOG.md

@@ -6,7 +6,7 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip
 
 ## [1.4.0] - [UNRELEASED]
 ### Fixed
-- iconv(): error supressor for //IGNORE added #184
+- iconv(): error suppressor for //IGNORE added #184
 - Typo Folder attribute fullName changed to full_name
 
 ### Added
@@ -20,6 +20,7 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip
 - Message::getHTMLBody($callback) extended
 - Masks added (take look at the examples for more information on masks)
 - More examples added
+- Query::paginate() method added
 
 ### Affected Classes
 - [Folder::class](src/IMAP/Folder.php)

README.md

@@ -331,6 +331,13 @@ $aMessage = $oFolder->query()->since('15.03.2018')->limit(10, 2)->get();
 ```
 
 #### Pagination
+Paginate a query:
+``` php
+/** @var \Webklex\IMAP\Folder $oFolder */
+
+/** @var \Illuminate\Pagination\LengthAwarePaginator $paginator */
+$paginator = $oFolder->query()->since('15.03.2018')->paginate();
+```
 Paginate a message collection:
 ``` php
 /** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
@@ -700,6 +707,8 @@ if you're just wishing a feature ;)
 | setFetchFlags      | boolean $fetch_flags              | WhereQuery        | Set the fetch flags option |
 | leaveUnread        |                                   | WhereQuery        | Don't mark all messages as "read" while fetching:  |
 | markAsRead         |                                   | WhereQuery        | Mark all messages as "read" while fetching |  
+| paginate           | int $perPage = 5, $page = null, $pageName = 'imap_page' | LengthAwarePaginator | Paginate the current query. |
+     
            
 ### [Attachment::class](src/IMAP/Attachment.php)
 

src/IMAP/Query/Query.php

@@ -191,6 +191,22 @@ public function get() {
         }
     }
 
+    /**
+     * Paginate the current query
+     * @param int $per_page
+     * @param null $page
+     * @param string $page_name
+     *
+     * @return \Illuminate\Pagination\LengthAwarePaginator
+     * @throws GetMessagesFailedException
+     */
+    public function paginate($per_page = 5, $page = null, $page_name = 'imap_page'){
+        $this->page = $page > $this->page ? $page : $this->page;
+        $this->limit = $per_page;
+
+        return $this->get()->paginate($per_page = 5, $this->page, $page_name);
+    }
+
     /**
      * Get the raw IMAP search query
      *