Improve IDE intellisense

Author: stevebauman

src/Collections/MessageCollection.php

@@ -2,16 +2,17 @@
 
 namespace DirectoryTree\ImapEngine\Collections;
 
-use DirectoryTree\ImapEngine\Message;
 use DirectoryTree\ImapEngine\MessageInterface;
 
 /**
- * @template-extends PaginatedCollection<array-key, MessageInterface>
+ * @template-extends PaginatedCollection<array-key, \DirectoryTree\ImapEngine\MessageInterface|\DirectoryTree\ImapEngine\Message>
  */
 class MessageCollection extends PaginatedCollection
 {
     /**
      * Find a message by its UID.
+     *
+     * @return \DirectoryTree\ImapEngine\Message|null
      */
     public function find(int $uid): ?MessageInterface
     {
@@ -22,6 +23,8 @@ public function find(int $uid): ?MessageInterface
 
     /**
      * Find a message by its UID or throw an exception.
+     *
+     * @return \DirectoryTree\ImapEngine\Message
      */
     public function findOrFail(int $uid): MessageInterface
     {

src/Message.php

@@ -313,6 +313,8 @@ public function copy(string $folder): ?int
 
     /**
      * Move the message to the given folder.
+     *
+     * @throws ImapCapabilityException
      */
     public function move(string $folder, bool $expunge = false): ?int
     {

src/MessageQuery.php

@@ -44,6 +44,8 @@ public function count(): int
 
     /**
      * Get the first message in the resulting collection.
+     *
+     * @return Message|null
      */
     public function first(): ?MessageInterface
     {
@@ -56,6 +58,8 @@ public function first(): ?MessageInterface
 
     /**
      * Get the first message in the resulting collection or throw an exception.
+     *
+     * @return Message
      */
     public function firstOrFail(): MessageInterface
     {
@@ -158,6 +162,8 @@ public function paginate(int $perPage = 5, $page = null, string $pageName = 'pag
 
     /**
      * Find a message by the given identifier type or throw an exception.
+     *
+     * @return Message
      */
     public function findOrFail(int $id, ImapFetchIdentifier $identifier = ImapFetchIdentifier::Uid): MessageInterface
     {
@@ -173,6 +179,8 @@ public function findOrFail(int $id, ImapFetchIdentifier $identifier = ImapFetchI
 
     /**
      * Find a message by the given identifier type.
+     *
+     * @return Message|null
      */
     public function find(int $id, ImapFetchIdentifier $identifier = ImapFetchIdentifier::Uid): ?MessageInterface
     {

src/MessageQueryInterface.php

@@ -118,11 +118,15 @@ public function count(): int;
 
     /**
      * Get the first message in the resulting collection.
+     *
+     * @return \DirectoryTree\ImapEngine\Message|null
      */
     public function first(): ?MessageInterface;
 
     /**
      * Get the first message in the resulting collection or throw an exception.
+     *
+     * @return \DirectoryTree\ImapEngine\Message
      */
     public function firstOrFail(): MessageInterface;
 
@@ -153,11 +157,15 @@ public function paginate(int $perPage = 5, $page = null, string $pageName = 'pag
 
     /**
      * Find a message by the given identifier type or throw an exception.
+     *
+     * @return \DirectoryTree\ImapEngine\Message
      */
     public function findOrFail(int $id, ImapFetchIdentifier $identifier = ImapFetchIdentifier::Uid): MessageInterface;
 
     /**
      * Find a message by the given identifier type.
+     *
+     * @return \DirectoryTree\ImapEngine\Message|null
      */
     public function find(int $id, ImapFetchIdentifier $identifier = ImapFetchIdentifier::Uid): ?MessageInterface;