Use PHP enum instead of int for fetch option

Author: stevebauman

src/Connection/Connection.php

@@ -381,7 +381,7 @@ protected function write(string $data): void
     /**
      * Fetch one or more items for one or more messages.
      */
-    public function fetch(array|string $items, array|int $from, mixed $to = null, $identifier = Imap::SEQUENCE_TYPE_UID): ResponseCollection
+    public function fetch(array|string $items, array|int $from, mixed $to = null, ImapFetchIdentifier $identifier = ImapFetchIdentifier::Uid): ResponseCollection
     {
         if (is_array($from) && count($from) > 1) {
             $set = implode(',', $from);
@@ -397,7 +397,7 @@ public function fetch(array|string $items, array|int $from, mixed $to = null, $i
 
         $items = (array) $items;
 
-        $prefix = ($identifier === Imap::SEQUENCE_TYPE_UID) ? 'UID' : '';
+        $prefix = ($identifier === ImapFetchIdentifier::Uid) ? 'UID' : '';
 
         $this->send(trim($prefix.' FETCH'), [$set, $this->escapeList($items)], $tag);
 

src/Connection/ImapConnection.php

@@ -9,7 +9,6 @@
 use DirectoryTree\ImapEngine\Connection\Responses\UntaggedResponse;
 use DirectoryTree\ImapEngine\Exceptions\AuthFailedException;
 use DirectoryTree\ImapEngine\Exceptions\RuntimeException;
-use DirectoryTree\ImapEngine\Imap;
 use Illuminate\Support\Arr;
 use Throwable;
 
@@ -282,7 +281,7 @@ public function store(array|string $flags, int $from, ?int $to = null, ?string $
      */
     public function uids(int|array $msgns): ResponseCollection
     {
-        return $this->fetch(['UID'], (array) $msgns, null, Imap::SEQUENCE_TYPE_MSG_NUMBER);
+        return $this->fetch(['UID'], (array) $msgns, null, ImapFetchIdentifier::MessageNumber);
     }
 
     /**

src/Connection/ImapFetchIdentifier.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace DirectoryTree\ImapEngine\Connection;
+
+enum ImapFetchOption
+{
+    case Uid;
+    case MessageNumber;
+}

src/Folder.php

@@ -2,6 +2,7 @@
 
 namespace DirectoryTree\ImapEngine;
 
+use DirectoryTree\ImapEngine\Connection\ImapFetchIdentifier;
 use DirectoryTree\ImapEngine\Connection\Responses\UntaggedResponse;
 use DirectoryTree\ImapEngine\Exceptions\ResponseException;
 use DirectoryTree\ImapEngine\Exceptions\RuntimeException;
@@ -95,7 +96,7 @@ public function idle(callable $callback, int $timeout = 300): void
         }
 
         $fetch = function (int $msgn) {
-            return $this->messages()->withBody()->find($msgn, Imap::SEQUENCE_TYPE_MSG_NUMBER);
+            return $this->messages()->withBody()->find($msgn, ImapFetchIdentifier::MessageNumber);
         };
 
         (new Idle(clone $this->mailbox, $this->path, $timeout))->await(
@@ -134,18 +135,6 @@ public function move(string $newPath, bool $expunge = true): void
         $this->path = $newPath;
     }
 
-    /**
-     * Delete the current folder.
-     */
-    public function delete(bool $expunge = true): void
-    {
-        $this->mailbox->connection()->deleteFolder($this->path);
-
-        if ($expunge) {
-            $this->expunge();
-        }
-    }
-
     /**
      * Select the current folder.
      */
@@ -193,6 +182,18 @@ public function expunge(): array
         )->all();
     }
 
+    /**
+     * Delete the current folder.
+     */
+    public function delete(bool $expunge = true): void
+    {
+        $this->mailbox->connection()->deleteFolder($this->path);
+
+        if ($expunge) {
+            $this->expunge();
+        }
+    }
+
     /**
      * Determine if the mailbox has the given capability.
      */
@@ -202,7 +203,7 @@ public function hasCapability(string $capability): bool
     }
 
     /**
-     * Get the mailboxes's capabilities.
+     * Get and in-memory cache the mailboxes's capabilities.
      */
     protected function capabilities(): array
     {

src/Imap.php

@@ -7,6 +7,7 @@
 use DateTimeInterface;
 use DirectoryTree\ImapEngine\Collections\MessageCollection;
 use DirectoryTree\ImapEngine\Connection\ConnectionInterface;
+use DirectoryTree\ImapEngine\Connection\ImapFetchIdentifier;
 use DirectoryTree\ImapEngine\Connection\Responses\UntaggedResponse;
 use DirectoryTree\ImapEngine\Connection\Tokens\Atom;
 use DirectoryTree\ImapEngine\Support\Str;
@@ -860,12 +861,12 @@ public function paginate(int $perPage = 5, $page = null, string $pageName = 'pag
     /**
      * Find a message by the given identifier type.
      */
-    public function find(int $id, int $identifier = Imap::SEQUENCE_TYPE_UID): Message
+    public function find(int $id, ImapFetchIdentifier $identifier = ImapFetchIdentifier::Uid): Message
     {
         // If the sequence is not UID, we'll need to fetch the UID first.
         $uid = match ($identifier) {
-            Imap::SEQUENCE_TYPE_UID => $id,
-            Imap::SEQUENCE_TYPE_MSG_NUMBER => $this->connection()->uids([$id]) // ResponseCollection
+            ImapFetchIdentifier::Uid => $id,
+            ImapFetchIdentifier::MessageNumber => $this->connection()->uids([$id]) // ResponseCollection
                 ->firstOrFail() // Untagged response
                 ->tokenAt(3) // ListData
                 ->tokenAt(1) // Atom