Comments updated

Author: Webklex

src/IMAP/Client.php

@@ -169,6 +169,8 @@ public function isReadOnly() {
 
     /**
      * Determine if connection was established and connect if not.
+     *
+     * @throws ConnectionFailedException
      */
     public function checkConnection() {
         if (!$this->isConnected()) {
@@ -252,6 +254,7 @@ public function getFolder($folder_name, $attributes = 32, $delimiter = null){
      * @param null $parent_folder
      *
      * @return FolderCollection
+     * @throws ConnectionFailedException
      */
     public function getFolders($hierarchical = true, $parent_folder = null) {
         $this->checkConnection();
@@ -279,8 +282,10 @@ public function getFolders($hierarchical = true, $parent_folder = null) {
     /**
      * Open folder.
      *
-     * @param Folder  $folder
-     * @param integer $attempts
+     * @param Folder $folder
+     * @param int    $attempts
+     *
+     * @throws ConnectionFailedException
      */
     public function openFolder(Folder $folder, $attempts = 3) {
         $this->checkConnection();
@@ -312,6 +317,7 @@ public function createFolder($name){
      * @param boolean $parse_body
      *
      * @return MessageCollection
+     * @throws ConnectionFailedException
      * @throws GetMessagesFailedException
      * @throws MessageSearchValidationException
      *
@@ -331,6 +337,7 @@ public function getMessages(Folder $folder, $criteria = 'ALL', $fetch_options =
      * @param bool   $parse_body
      *
      * @return MessageCollection
+     * @throws ConnectionFailedException
      * @throws GetMessagesFailedException
      * @throws MessageSearchValidationException
      *
@@ -351,6 +358,7 @@ public function getUnseenMessages(Folder $folder, $criteria = 'UNSEEN', $fetch_o
      * @param string  $charset
      *
      * @return MessageCollection
+     * @throws ConnectionFailedException
      * @throws GetMessagesFailedException
      * @throws MessageSearchValidationException
      *

src/IMAP/ClientManager.php

@@ -45,7 +45,7 @@ public function __construct($app) {
      *
      * @param  string  $name
      *
-     * @return \Webklex\IMAP\Client
+     * @return Client
      */
     public function account($name = null) {
         $name = $name ?: $this->getDefaultAccount();
@@ -65,7 +65,7 @@ public function account($name = null) {
      *
      * @param  string  $name
      *
-     * @return \Webklex\IMAP\Client
+     * @return Client
      */
     protected function resolve($name) {
         $config = $this->getConfig($name);

src/IMAP/Folder.php

@@ -169,6 +169,7 @@ public function getMessage($uid, $msglist = null){
      * @param bool $parse_body
      *
      * @return MessageCollection
+     * @throws Exceptions\ConnectionFailedException
      * @throws GetMessagesFailedException
      * @throws MessageSearchValidationException
      */
@@ -184,6 +185,7 @@ public function getMessages($criteria = 'ALL', $fetch_options = null, $parse_bod
      * @param bool $parse_body
      *
      * @return MessageCollection
+     * @throws Exceptions\ConnectionFailedException
      * @throws GetMessagesFailedException
      * @throws MessageSearchValidationException
      *
@@ -209,12 +211,13 @@ public function getUnseenMessages($criteria = 'UNSEEN', $fetch_options = null, $
      *                        The following sample would search for all flagged messages:
      *                        [['FLAGGED']]
      *                        ---------------------------------------------------------------------------------------
-     * @param Folder  $folder
      * @param null    $fetch_options
      * @param boolean $parse_body
      * @param string  $charset
      *
      * @return MessageCollection
+     *
+     * @throws Exceptions\ConnectionFailedException
      * @throws GetMessagesFailedException
      * @throws MessageSearchValidationException
      *
@@ -252,7 +255,6 @@ public function getUnseenMessages($criteria = 'UNSEEN', $fetch_options = null, $
      *                                           ;  M:-12; N:+1; Y:+12
      *                  / ( ("+" / "-") 4DIGIT ) ; Local differential
      *                                           ;  hours+min. (HHMM)
-     *
      */
     public function searchMessages(array $where, $fetch_options = null, $parse_body = true, $charset = "UTF-8") {
 

src/IMAP/Message.php

@@ -25,7 +25,7 @@ class Message {
     /**
      * Client instance
      *
-     * @var \Webklex\IMAP\Client
+     * @var Client
      */
     private $client = Client::class;