Add new optional beta email parser thats based on ImapEngine instead of Webklex

plugins/vendor/directorytree/imapengine/src/Mailbox.php

@@ -0,0 +1,232 @@
+<?php
+
+namespace DirectoryTree\ImapEngine;
+
+use DirectoryTree\ImapEngine\Connection\ConnectionInterface;
+use DirectoryTree\ImapEngine\Connection\ImapConnection;
+use DirectoryTree\ImapEngine\Connection\Loggers\EchoLogger;
+use DirectoryTree\ImapEngine\Connection\Loggers\FileLogger;
+use DirectoryTree\ImapEngine\Connection\Streams\ImapStream;
+use DirectoryTree\ImapEngine\Connection\Tokens\Token;
+use Exception;
+
+class Mailbox implements MailboxInterface
+{
+    /**
+     * The mailbox configuration.
+     */
+    protected array $config = [
+        'port' => 993,
+        'host' => '',
+        'timeout' => 30,
+        'debug' => false,
+        'username' => '',
+        'password' => '',
+        'encryption' => 'ssl',
+        'validate_cert' => true,
+        'authentication' => 'plain',
+        'proxy' => [
+            'socket' => null,
+            'username' => null,
+            'password' => null,
+            'request_fulluri' => false,
+        ],
+    ];
+
+    /**
+     * The cached mailbox capabilities.
+     *
+     * @see https://datatracker.ietf.org/doc/html/rfc9051#section-6.1.1
+     */
+    protected ?array $capabilities = null;
+
+    /**
+     * The currently selected folder.
+     */
+    protected ?FolderInterface $selected = null;
+
+    /**
+     * The mailbox connection.
+     */
+    protected ?ConnectionInterface $connection = null;
+
+    /**
+     * Constructor.
+     */
+    public function __construct(array $config = [])
+    {
+        $this->config = array_merge($this->config, $config);
+    }
+
+    /**
+     * Prepare the cloned instance.
+     */
+    public function __clone(): void
+    {
+        $this->connection = null;
+    }
+
+    /**
+     * Make a new mailbox instance.
+     */
+    public static function make(array $config = []): static
+    {
+        return new static($config);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function config(?string $key = null, mixed $default = null): mixed
+    {
+        if (is_null($key)) {
+            return $this->config;
+        }
+
+        return data_get($this->config, $key, $default);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function connection(): ConnectionInterface
+    {
+        if (! $this->connection) {
+            $this->connect();
+        }
+
+        return $this->connection;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function connected(): bool
+    {
+        return (bool) $this->connection?->connected();
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function reconnect(): void
+    {
+        $this->disconnect();
+
+        $this->connect();
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function connect(?ConnectionInterface $connection = null): void
+    {
+        if ($this->connected()) {
+            return;
+        }
+
+        $debug = $this->config('debug');
+
+        $this->connection = $connection ?? new ImapConnection(new ImapStream, match (true) {
+            class_exists($debug) => new $debug,
+            is_string($debug) => new FileLogger($debug),
+            is_bool($debug) && $debug => new EchoLogger,
+            default => null,
+        });
+
+        $this->connection->connect($this->config('host'), $this->config('port'), [
+            'proxy' => $this->config('proxy'),
+            'debug' => $this->config('debug'),
+            'timeout' => $this->config('timeout'),
+            'encryption' => $this->config('encryption'),
+            'validate_cert' => $this->config('validate_cert'),
+        ]);
+
+        $this->authenticate();
+    }
+
+    /**
+     * Authenticate the current session.
+     */
+    protected function authenticate(): void
+    {
+        if ($this->config('authentication') === 'oauth') {
+            $this->connection->authenticate(
+                $this->config('username'),
+                $this->config('password')
+            );
+        } else {
+            $this->connection->login(
+                $this->config('username'),
+                $this->config('password'),
+            );
+        }
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function disconnect(): void
+    {
+        try {
+            $this->connection?->logout();
+            $this->connection?->disconnect();
+        } catch (Exception) {
+            // Do nothing.
+        } finally {
+            $this->connection = null;
+        }
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function inbox(): FolderInterface
+    {
+        // "INBOX" is a special name reserved for the user's primary mailbox.
+        // See: https://datatracker.ietf.org/doc/html/rfc9051#section-5.1
+        return $this->folders()->find('INBOX');
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function folders(): FolderRepositoryInterface
+    {
+        // Ensure the connection is established.
+        $this->connection();
+
+        return new FolderRepository($this);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function capabilities(): array
+    {
+        return $this->capabilities ??= array_map(
+            fn (Token $token) => $token->value,
+            $this->connection()->capability()->tokensAfter(2)
+        );
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function select(FolderInterface $folder, bool $force = false): void
+    {
+        if (! $this->selected($folder) || $force) {
+            $this->connection()->select($folder->path());
+        }
+
+        $this->selected = $folder;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function selected(FolderInterface $folder): bool
+    {
+        return $this->selected?->is($folder) ?? false;
+    }
+}