Get Folder instance by name

Author: Webklex

src/IMAP/Client.php

@@ -221,6 +221,30 @@ public function disconnect() {
         return $this;
     }
 
+    /**
+     * Get a folder instance by a folder name
+     * -------------------------------------------------------
+     * PLEASE NOTE: This is a completely experimental function
+     * -------------------------------------------------------
+     * @param string        $folder_name
+     * @param int           $attributes
+     * @param null|string   $delimiter
+     *
+     * @return Folder
+     */
+    public function getFolder($folder_name, $attributes = 32, $delimiter = null){
+
+        $delimiter = $delimiter == null ? config('imap.options.delimiter', '/') : $delimiter;
+
+        $oFolder = new Folder($this, (object)[
+            'name'       => $this->getAddress().$folder_name,
+            'attributes' => $attributes,
+            'delimiter'  => $delimiter
+        ]);
+
+        return $oFolder;
+    }
+
     /**
      * Get folders list.
      * If hierarchical order is set to true, it will make a tree of folders, otherwise it will return flat array.

src/config/imap.php

@@ -69,6 +69,9 @@
     |--------------------------------------------------------------------------
     |
     | Available php imap config parameters are listed below
+    |   -Delimiter (optional):
+    |       This option is only used wehen calling $oClient->
+    |       You can use any supported char such as ".", "/", (...)
     |   -Fetch option:
     |       FT_UID  - Message marked as read by fetching the message
     |       FT_PEEK - Fetch the message without setting the "read" flag
@@ -80,6 +83,7 @@
     |
     */
     'options' => [
+        'delimiter' => '/',
         'fetch' => FT_UID,
         'open' => [
             // 'DISABLE_AUTHENTICATOR' => 'GSSAPI'