add rename delete create noop commands

Author: Mikhail Sazanov

src/Commands/CreateCommand.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Sazanof\PhpImapSockets\Commands;
+
+use Sazanof\PhpImapSockets\Traits\PrepareArgument;
+
+class CreateCommand extends Command
+{
+	protected string $name = 'CREATE';
+
+	use PrepareArgument;
+
+	public function __construct(string $pathOrName)
+	{
+
+		$this->setArguments($this->addQuotes($pathOrName));
+	}
+}

src/Commands/DeleteCommand.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Sazanof\PhpImapSockets\Commands;
+
+use Sazanof\PhpImapSockets\Traits\PrepareArgument;
+
+class DeleteCommand extends Command
+{
+	use PrepareArgument;
+
+	protected string $name = 'DELETE';
+
+	public function __construct(string $pathOrName)
+	{
+
+		$this->setArguments($this->addQuotes($pathOrName));
+	}
+}

src/Commands/ExamineCommand.php

@@ -18,6 +18,6 @@ class ExamineCommand extends Command
 	public function __construct(string $root)
 	{
 
-		$this->setArguments($this->addQuotes($root));
+		$this->setArguments($root);
 	}
 }

src/Commands/ListCommand.php

@@ -24,7 +24,7 @@ public function __construct(string $root, string $search)
 		$this->root = $root;
 		$this->search = $search;
 		if (str_contains($this->root, ' ') || str_contains($this->root, '-') || strlen($this->root) === 0) {
-			$this->root = '"' . $this->addQuotes($this->root) . '"';
+			$this->root = '"' . $this->root . '"';
 		}
 		$this->setArguments($this->root . ' ' . $this->search);
 	}

src/Commands/NoopCommand.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Sazanof\PhpImapSockets\Commands;
+
+class NoopCommand extends Command
+{
+	protected string $name = 'NOOP';
+}

src/Commands/RenameCommand.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Sazanof\PhpImapSockets\Commands;
+
+use Sazanof\PhpImapSockets\Traits\PrepareArgument;
+
+class RenameCommand extends Command
+{
+	protected string $name = 'RENAME';
+
+	use PrepareArgument;
+
+	public function __construct(string $currentName, string $newName)
+	{
+		$this->setArguments($this->addQuotes($currentName) . ' ' . $this->addQuotes($newName));
+	}
+}

src/Commands/SelectCommand.php

@@ -17,6 +17,6 @@ class SelectCommand extends Command
 
 	public function __construct(string $folder)
 	{
-		$this->setArguments($this->addQuotes($folder));
+		$this->setArguments($folder);
 	}
 }

src/Connection.php

@@ -12,13 +12,20 @@
 use ReflectionMethod;
 use Sazanof\PhpImapSockets\Collections\MailboxCollection;
 use Sazanof\PhpImapSockets\Commands\Command;
+use Sazanof\PhpImapSockets\Commands\CreateCommand;
+use Sazanof\PhpImapSockets\Commands\DeleteCommand;
+use Sazanof\PhpImapSockets\Commands\ExamineCommand;
 use Sazanof\PhpImapSockets\Commands\ListCommand;
 use Sazanof\PhpImapSockets\Commands\LoginCommand;
 use Sazanof\PhpImapSockets\Commands\LogoutCommand;
+use Sazanof\PhpImapSockets\Commands\NoopCommand;
+use Sazanof\PhpImapSockets\Commands\RenameCommand;
 use Sazanof\PhpImapSockets\Commands\SelectCommand;
 use Sazanof\PhpImapSockets\Exceptions\ConnectionException;
+use Sazanof\PhpImapSockets\Exceptions\MailboxOperationException;
 use Sazanof\PhpImapSockets\Exceptions\LoginFailedException;
 use Sazanof\PhpImapSockets\Models\Mailbox;
+use Sazanof\PhpImapSockets\Response\ExamineResponse;
 use Sazanof\PhpImapSockets\Response\Response;
 use Sazanof\PhpImapSockets\Response\SelectResponse;
 use Sazanof\PhpImapSockets\Socket;
@@ -356,4 +363,64 @@ public function select($mailboxName): ?SelectResponse
 		$response = $this->command(SelectCommand::class, [$mailboxName]);
 		return $response->isOk() ? new SelectResponse($response) : null;
 	}
+
+	/**
+	 * @return bool
+	 * @throws ReflectionException
+	 */
+	public function noop(): bool
+	{
+		return $this->command(NoopCommand::class)->isOk();
+	}
+
+	public function examine(string $path)
+	{
+		return $this->command(ExamineCommand::class, [$path])->asCollection(ExamineResponse::class);
+	}
+
+	/**
+	 * @param string $pathOrName
+	 * @return bool
+	 * @throws MailboxOperationException
+	 * @throws ReflectionException
+	 */
+	public function createMailbox(string $pathOrName): bool
+	{
+		$response = $this->command(CreateCommand::class, [$pathOrName]);
+		if ($response->isNotOk()) {
+			throw new MailboxOperationException($response->lastLine());
+		}
+		return $response->isOk();
+	}
+
+	/**
+	 * @param string $pathOrName
+	 * @return bool
+	 * @throws MailboxOperationException
+	 * @throws ReflectionException
+	 */
+	public function deleteMailbox(string $pathOrName): bool
+	{
+		$response = $this->command(DeleteCommand::class, [$pathOrName]);
+		if ($response->isNotOk()) {
+			throw new MailboxOperationException($response->lastLine());
+		}
+		return $response->isOk();
+	}
+
+	/**
+	 * @param string $currentName
+	 * @param string $newName
+	 * @return bool
+	 * @throws MailboxOperationException
+	 * @throws ReflectionException
+	 */
+	public function renameMailbox(string $currentName, string $newName): bool
+	{
+		$response = $this->command(RenameCommand::class, [$currentName, $newName]);
+		if ($response->isNotOk()) {
+			throw new MailboxOperationException($response->lastLine());
+		}
+		return $response->isOk();
+	}
 }

src/Exceptions/MailboxOperationException.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Sazanof\PhpImapSockets\Exceptions;
+
+class MailboxOperationException extends \Exception
+{
+	public function __construct(string $message = "Error creating folder", int $code = 0, ?\Throwable $previous = null)
+	{
+		if (preg_match('/^(\d+) (BAD|NO) (.+?)\./', $message, $m)) {
+			$message = $m[3];
+		}
+		parent::__construct($message, $code, $previous);
+	}
+}

src/Models/Mailbox.php

@@ -7,13 +7,16 @@
 
 namespace Sazanof\PhpImapSockets\Models;
 
+use ReflectionException;
 use Sazanof\PhpImapSockets\Collections\BodyStructureCollection;
 use Sazanof\PhpImapSockets\Collections\Collection;
 use Sazanof\PhpImapSockets\Collections\MailboxCollection;
 use Sazanof\PhpImapSockets\Commands\ExamineCommand;
 use Sazanof\PhpImapSockets\Commands\FetchCommand;
 use Sazanof\PhpImapSockets\Commands\SearchCommand;
 use Sazanof\PhpImapSockets\Connection;
+use Sazanof\PhpImapSockets\Exceptions\MailboxOperationException;
+use Sazanof\PhpImapSockets\Exceptions\NoResultsException;
 use Sazanof\PhpImapSockets\Query\FetchQuery;
 use Sazanof\PhpImapSockets\Query\SearchQuery;
 use Sazanof\PhpImapSockets\Response\ExamineResponse;
@@ -106,9 +109,7 @@ public function parseLine(string $line)
 
 	public function examine()
 	{
-		$response = new ExamineResponse(
-			$this->getConnection()->command(ExamineCommand::class, [$this->getOriginalPath()])
-		);
+		$response = $this->getConnection()->examine($this->getOriginalPath());
 		$this->uidvalidity = $response->uidvalidiry;
 		$this->uidnext = $response->uidnext;
 		$this->unseen = $response->unseen;
@@ -124,24 +125,82 @@ public function select()
 		return $this;
 	}
 
-	public function search(SearchQuery $query)
+	/**
+	 * @param string $folder
+	 * @param bool $insideCurrent
+	 * @return bool
+	 * @throws MailboxOperationException
+	 * @throws ReflectionException
+	 */
+	public function create(string $folder, bool $insideCurrent = false): bool
+	{
+		$name = $insideCurrent ? $this->getPath() . $this->getDelimiter() . $folder : $folder;
+		return $this->getConnection()->createMailbox($name);
+	}
+
+	/**
+	 * @param string $folder
+	 * @param bool $insideCurrent
+	 * @return bool
+	 * @throws ReflectionException
+	 * @throws MailboxOperationException
+	 */
+	public function delete(string $folder, bool $insideCurrent = false): bool
+	{
+		$name = $insideCurrent ? $this->getPath() . $this->getDelimiter() . $folder : $folder;
+		return $this->getConnection()->deleteMailbox($name);
+	}
+
+	/**
+	 * @param string $currentName
+	 * @param string $newName
+	 * @return bool
+	 * @throws MailboxOperationException
+	 * @throws ReflectionException
+	 */
+	public function rename(string $currentName, string $newName): bool
+	{
+		return $this->getConnection()->renameMailbox($currentName, $newName);
+	}
+
+	/**
+	 * @param SearchQuery $query
+	 * @return SearchResponse
+	 * @throws ReflectionException
+	 * @throws NoResultsException
+	 */
+	public function search(SearchQuery $query): SearchResponse
 	{
 		return new SearchResponse(
 			$this->connection->command(SearchCommand::class, [$query])
 		);
 	}
 
-	public function fetch(array $nums, FetchQuery $query)
+	/**
+	 * @param array $nums
+	 * @param FetchQuery $query
+	 * @return Response
+	 * @throws ReflectionException
+	 */
+	public function fetch(array $nums, FetchQuery $query): Response
 	{
 		return $this->connection->command(FetchCommand::class, [$nums, $query]);
 	}
 
+	/**
+	 * @param array $nums
+	 * @return BodyStructureCollection
+	 * @throws ReflectionException
+	 */
 	public function getBodyStructure(array $nums): BodyStructureCollection
 	{
 		$query = new FetchQuery();
 		return $this->connection->command(FetchCommand::class, [$nums, $query->bodystructure()])->asCollection(BodyStructureCollection::class);
 	}
 
+	/**
+	 * @return bool
+	 */
 	public function hasChildren()
 	{
 		return !empty(array_intersect(self::SPECIAL_ATTRIBUTES['haschildren'], $this->attributes->toArray()));