Typos fixed and docs extended

Author: Webklex

src/Connection/Protocols/ImapProtocol.php

@@ -563,7 +563,7 @@ public function examineFolder(string $folder = 'INBOX') {
  *
  * @return string|array if only one item of one message is fetched it's returned as string
  * if items of one message are fetched it's returned as (name => value)
- * if one items of messages are fetched it's returned as (msgno => value)
+ * if one item of messages are fetched it's returned as (msgno => value)
  * if items of messages are fetched it's returned as (msgno => (name => value))
  * @throws RuntimeException
  */

src/Connection/Protocols/Protocol.php

@@ -38,7 +38,7 @@ abstract class Protocol implements ProtocolInterface {
  protected $enable_uid_cache = true;
 
  /**
- * @var false|resource
+ * @var false|\IMAP\Connection|resource
  */
  public $stream = false;
 

src/Connection/Protocols/ProtocolInterface.php

@@ -90,7 +90,7 @@ public function getCapabilities(): array;
  * Change the current folder
  *
  * @param string $folder change to this folder
- * @return bool|array see examineOrselect()
+ * @return bool|array see examineOrSelect()
  * @throws RuntimeException
  */
  public function selectFolder(string $folder = 'INBOX');
@@ -224,7 +224,7 @@ public function copyMessage(string $folder, $from, $to = null, $uid = IMAP::ST_U
  public function copyManyMessages(array $messages, string $folder, $uid = IMAP::ST_UID);
 
  /**
- * Move a message set from current folder to an other folder
+ * Move a message set from current folder to another folder
  * @param string $folder destination folder
  * @param $from
  * @param int|null $to if null only one message ($from) is fetched, else it's the

src/Folder.php

@@ -278,7 +278,7 @@ public function overview(string $sequence = null): array {
  */
  public function appendMessage(string $message, array $options = null, $internal_date = null): bool {
  /**
- * Check if $internal_date is parsed. If it is null it should not be set. Otherwise the message can't be stored.
+ * Check if $internal_date is parsed. If it is null it should not be set. Otherwise, the message can't be stored.
  * If this parameter is set, it will set the INTERNALDATE on the appended message. The parameter should be a
  * date string that conforms to the rfc2060 specifications for a date_time value or be a Carbon object.
  */
@@ -377,6 +377,7 @@ public function idle(callable $callback, int $timeout = 300, bool $auto_reconnec
 
  while (true) {
  try {
+ // This polymorphic call is fine - Protocol::idle() will throw an exception beforehand
  $line = $connection->nextLine();
 
  if (($pos = strpos($line, "EXISTS")) !== false) {

src/Header.php

@@ -347,7 +347,7 @@ public function mime_header_decode(string $text): array {
  }
 
  /**
- * Check if a given pair of strings has ben decoded
+ * Check if a given pair of strings has been decoded
  * @param $encoded
  * @param $decoded
  *

src/Message.php

@@ -55,6 +55,7 @@
  * @method Attribute getPriority()
  * @method Attribute getSubject()
  * @method Attribute getMessageId()
+ * @method Attribute getMessageNo()
  * @method Attribute getReferences()
  * @method Attribute getDate()
  * @method Attribute getFrom()

src/Part.php

@@ -202,7 +202,7 @@ protected function parse(){
  }
 
  /**
- * Find all available headers and return the left over body segment
+ * Find all available headers and return the leftover body segment
  *
  * @return string
  * @throws InvalidMessageDateException

src/Query/Query.php

@@ -711,6 +711,7 @@ public function setClient(Client $client): Query {
  }
 
  /**
+ * Get the set fetch limit
  * @return int
  */
  public function getLimit() {