Fix up flagging

Author: stevebauman

src/Connection/ImapConnection.php

@@ -35,9 +35,9 @@ public function login(string $user, string $password): TaggedResponse
      */
     public function authenticate(string $user, string $token): TaggedResponse
     {
-        $authenticateParams = ['XOAUTH2', base64_encode("user=$user\1auth=Bearer $token\1\1")];
+        $credentials = base64_encode("user=$user\1auth=Bearer $token\1\1");
 
-        $this->send('AUTHENTICATE', $authenticateParams, $tag);
+        $this->send('AUTHENTICATE', ['XOAUTH2', $credentials], $tag);
 
         return $this->assertTaggedResponse($tag, fn () => new AuthFailedException('Failed to authenticate'));
     }
@@ -84,13 +84,9 @@ public function examineFolder(string $folder = 'INBOX'): ResponseCollection
 
     /**
      * Examine and select have the same response.
-     *
-     * @param  string  $command  can be 'EXAMINE' or 'SELECT'
-     * @param  string  $folder  target folder
      */
     protected function examineOrSelect(string $command = 'EXAMINE', string $folder = 'INBOX'): ResponseCollection
     {
-        // Send the command and retrieve the tag.
         $this->send($command, [$this->escapeString($folder)], $tag);
 
         $this->assertTaggedResponse($tag, fn () => new RuntimeException('Failed to select folder'));

src/Connection/Responses/Data/Data.php

@@ -19,6 +19,8 @@ public function __construct(
 
     /**
      * Get the tokens.
+     *
+     * @return Token[]|Data[]
      */
     public function tokens(): array
     {

src/Connection/Responses/HasTokens.php

@@ -9,6 +9,8 @@ trait HasTokens
 {
     /**
      * Get the response tokens.
+     *
+     * @return Token[]|Data[]
      */
     abstract public function tokens(): array;
 

src/Connection/Responses/Response.php

@@ -20,6 +20,8 @@ public function __construct(
 
     /**
      * Get the response tokens.
+     *
+     * @return Token[]|Data[]
      */
     public function tokens(): array
     {

src/Folder.php

@@ -90,7 +90,7 @@ public function messages(): MessageQuery
      */
     public function idle(callable $callback, int $timeout = 300): void
     {
-        if (! $this->hasIdleSupport()) {
+        if (! $this->hasCapability('IDLE')) {
             throw new RuntimeException('IMAP server does not support IDLE');
         }
 
@@ -123,33 +123,27 @@ function (int $msgn) use ($callback, $fetch) {
     /**
      * Move or rename the current folder.
      */
-    public function move(string $newPath, bool $expunge = true): array
+    public function move(string $newPath, bool $expunge = true): void
     {
-        $status = $this->mailbox->connection()
-            ->renameFolder($this->path, $newPath)
-            ->getValidatedData();
+        $this->mailbox->connection()->renameFolder($this->path, $newPath);
 
         if ($expunge) {
             $this->expunge();
         }
 
         $this->path = $newPath;
-
-        return $status;
     }
 
     /**
      * Delete the current folder.
      */
-    public function delete(bool $expunge = true): array
+    public function delete(bool $expunge = true): void
     {
         $this->mailbox->connection()->deleteFolder($this->path);
 
         if ($expunge) {
-            return $this->expunge();
+            $this->expunge();
         }
-
-        return [];
     }
 
     /**
@@ -186,7 +180,7 @@ public function examine(): array
     {
         return $this->mailbox->connection()->examineFolder($this->path)->map(
             fn (UntaggedResponse $response) => $response->toArray()
-        );
+        )->all();
     }
 
     /**
@@ -196,15 +190,15 @@ public function expunge(): array
     {
         return $this->mailbox->connection()->expunge()->map(
             fn (UntaggedResponse $response) => $response->tokenAt(1)->value
-        );
+        )->all();
     }
 
     /**
-     * Determine if the mailbox has IDLE support.
+     * Determine if the mailbox has the given capability.
      */
-    protected function hasIdleSupport(): bool
+    public function hasCapability(string $capability): bool
     {
-        return in_array('IDLE', $this->capabilities());
+        return in_array($capability, $this->capabilities());
     }
 
     /**

src/Message.php

@@ -283,6 +283,22 @@ public function header(string $name, int $offset = 0): ?IHeader
         return $this->parse()->getHeader($name, $offset);
     }
 
+    /**
+     * Mark the message as read. Alias for markSeen.
+     */
+    public function markRead(bool $expunge = true): void
+    {
+        $this->markSeen($expunge);
+    }
+
+    /**
+     * Mark the message as unread. Alias for unmarkSeen.
+     */
+    public function markUnread(bool $expunge = true): void
+    {
+        $this->unmarkSeen($expunge);
+    }
+
     /**
      * Mark the message as seen.
      */
@@ -380,15 +396,15 @@ public function unmarkRecent(bool $expunge = true): void
     }
 
     /**
-     * Set or remove a flag from the message.
+     * Add or remove a flag from the message.
      */
     public function flag(array|string $flag, string $operation = '+', bool $expunge = true): void
     {
         $flag = '\\'.trim(is_array($flag) ? implode(' \\', $flag) : $flag);
 
-        $this->folder->mailbox()->connection()
-            ->store([$flag], $this->uid, null, $operation, true)
-            ->getValidatedData();
+        $this->folder->mailbox()
+            ->connection()
+            ->store([$flag], $this->uid, null, $operation, true);
 
         if ($expunge) {
             $this->folder->expunge();