Code commented

Author: Webklex

src/IMAP/Client.php

@@ -17,8 +17,7 @@
 use Webklex\IMAP\Exceptions\ConnectionFailedException;
 use Webklex\IMAP\Exceptions\GetMessagesFailedException;
 
-class Client
-{
+class Client {
     /**
      * @var bool|resource
      */
@@ -242,6 +241,12 @@ public function openFolder(Folder $folder)
         }
     }
 
+    /**
+     * Create a new Folder
+     * @param $name
+     *
+     * @return bool
+     */
     public function createFolder($name){
         return imap_createmailbox($this->connection, imap_utf7_encode($name));
     }
@@ -310,4 +315,4 @@ protected function getAddress()
 
         return $address;
     }
-}
+}

src/IMAP/ClientManager.php

@@ -12,35 +12,37 @@
 
 namespace Webklex\IMAP;
 
-class ClientManager
-{
+class ClientManager {
+
     /**
      * The application instance.
      *
      * @var \Illuminate\Foundation\Application
      */
     protected $app;
 
+    /**
+     * @var array $accounts
+     */
     protected $accounts = [];
 
     /**
      * Create a new client manager instance.
      *
      * @param  \Illuminate\Foundation\Application  $app
      */
-    public function __construct($app)
-    {
+    public function __construct($app) {
         $this->app = $app;
     }
 
     /**
      * Resolve a account instance.
      *
      * @param  string  $name
+     *
      * @return \Webklex\IMAP\Client
      */
-    public function account($name = null)
-    {
+    public function account($name = null) {
         $name = $name ?: $this->getDefaultAccount();
 
         // If the connection has not been resolved yet we will resolve it now as all
@@ -57,10 +59,10 @@ public function account($name = null)
      * Resolve a account.
      *
      * @param  string  $name
+     *
      * @return \Webklex\IMAP\Client
      */
-    protected function resolve($name)
-    {
+    protected function resolve($name) {
         $config = $this->getConfig($name);
 
         return new Client($config);
@@ -70,10 +72,10 @@ protected function resolve($name)
      * Get the account configuration.
      *
      * @param  string  $name
+     *
      * @return array
      */
-    protected function getConfig($name)
-    {
+    protected function getConfig($name) {
         if ($name === null || $name === 'null') {
             return ['driver' => 'null'];
         }
@@ -86,19 +88,18 @@ protected function getConfig($name)
      *
      * @return string
      */
-    public function getDefaultAccount()
-    {
+    public function getDefaultAccount() {
         return $this->app['config']['imap.default'];
     }
 
     /**
      * Set the name of the default account.
      *
      * @param  string  $name
+     *
      * @return void
      */
-    public function setDefaultAccount($name)
-    {
+    public function setDefaultAccount($name) {
         $this->app['config']['imap.default'] = $name;
     }
 
@@ -107,10 +108,10 @@ public function setDefaultAccount($name)
      *
      * @param  string  $method
      * @param  array   $parameters
+     *
      * @return mixed
      */
-    public function __call($method, $parameters)
-    {
+    public function __call($method, $parameters) {
         $callable = [$this->account(), $method];
 
         return call_user_func_array($callable, $parameters);

src/IMAP/Folder.php

@@ -12,8 +12,7 @@
 
 namespace Webklex\IMAP;
 
-class Folder
-{
+class Folder {
     /**
      * Client instance
      *
@@ -99,16 +98,16 @@ class Folder
      * Folder constructor.
      *
      * @param \Webklex\IMAP\Client $client
+     *
      * @param $folder
      */
-    public function __construct(Client $client, $folder)
-    {
+    public function __construct(Client $client, $folder) {
         $this->client = $client;
 
         $this->delimiter = $folder->delimiter;
-        $this->path = $folder->name;
-        $this->fullName = $this->decodeName($folder->name);
-        $this->name = $this->getSimpleName($this->delimiter, $this->fullName);
+        $this->path      = $folder->name;
+        $this->fullName  = $this->decodeName($folder->name);
+        $this->name      = $this->getSimpleName($this->delimiter, $this->fullName);
 
         $this->parseAttributes($folder->attributes);
     }
@@ -118,8 +117,7 @@ public function __construct(Client $client, $folder)
      *
      * @return bool
      */
-    public function hasChildren()
-    {
+    public function hasChildren() {
         return $this->has_children;
     }
 
@@ -128,8 +126,7 @@ public function hasChildren()
      *
      * @param array $children
      */
-    public function setChildren($children = [])
-    {
+    public function setChildren($children = []) {
         $this->children = $children;
     }
 
@@ -140,8 +137,7 @@ public function setChildren($children = [])
      *
      * @return array
      */
-    public function getMessages($criteria = 'ALL')
-    {
+    public function getMessages($criteria = 'ALL') {
         return $this->client->getMessages($this, $criteria);
     }
 
@@ -153,8 +149,7 @@ public function getMessages($criteria = 'ALL')
      *
      * @return mixed|string
      */
-    protected function decodeName($name)
-    {
+    protected function decodeName($name) {
         preg_match('#\{(.*)\}(.*)#', $name, $preg);
         return mb_convert_encoding($preg[2], "UTF-8", "UTF7-IMAP");
     }
@@ -167,8 +162,7 @@ protected function decodeName($name)
      *
      * @return mixed
      */
-    protected function getSimpleName($delimiter, $fullName)
-    {
+    protected function getSimpleName($delimiter, $fullName) {
         $arr = explode($delimiter, $fullName);
 
         return end($arr);
@@ -179,8 +173,7 @@ protected function getSimpleName($delimiter, $fullName)
      *
      * @param $attributes
      */
-    protected function parseAttributes($attributes)
-    {
+    protected function parseAttributes($attributes) {
         $this->no_inferiors = ($attributes & LATT_NOINFERIORS)  ? true : false;
         $this->no_select    = ($attributes & LATT_NOSELECT)     ? true : false;
         $this->marked       = ($attributes & LATT_MARKED)       ? true : false;