Migrated away from PHP Mail Parser to the new WebKlex PHP IMAP Mail Parser this will open the way to support OAUTH2 for Mail servers such as Microsoft 365 and Google Workspaces

2026-03-01 11:24:52 +00:00 · 2024-06-12 15:39:52 -04:00
parent d64a7ce31e
commit 779527cf6a
218 changed files with 14781 additions and 2722 deletions
--- a/plugins/php-imap/tests/fixtures/FixtureTestCase.php
+++ b/plugins/php-imap/tests/fixtures/FixtureTestCase.php
@@ -0,0 +1,94 @@
+<?php
+/*
+* File: FixtureTestCase.php
+* Category: -
+* Author: M.Goldenbaum
+* Created: 09.03.23 02:24
+* Updated: -
+*
+* Description:
+*  -
+*/
+
+namespace Tests\fixtures;
+
+use PHPUnit\Framework\TestCase;
+use Webklex\PHPIMAP\ClientManager;
+use Webklex\PHPIMAP\Config;
+use Webklex\PHPIMAP\Exceptions\AuthFailedException;
+use Webklex\PHPIMAP\Exceptions\ConnectionFailedException;
+use Webklex\PHPIMAP\Exceptions\ImapBadRequestException;
+use Webklex\PHPIMAP\Exceptions\ImapServerErrorException;
+use Webklex\PHPIMAP\Exceptions\InvalidMessageDateException;
+use Webklex\PHPIMAP\Exceptions\MaskNotFoundException;
+use Webklex\PHPIMAP\Exceptions\MessageContentFetchingException;
+use Webklex\PHPIMAP\Exceptions\ResponseException;
+use Webklex\PHPIMAP\Exceptions\RuntimeException;
+use Webklex\PHPIMAP\Message;
+use \ReflectionException;
+
+/**
+ * Class FixtureTestCase
+ *
+ * @package Tests\fixtures
+ */
+abstract class FixtureTestCase extends TestCase {
+
+    /**
+     * Client manager
+     * @var ClientManager $manager
+     */
+    protected static ClientManager $manager;
+
+    /**
+     * FixtureTestCase constructor.
+     * @param string|null $name
+     * @param array $data
+     * @param $dataName
+     */
+    final public function __construct(?string $name = null, array $data = [], $dataName = '') {
+        parent::__construct($name, $data, $dataName);
+
+        self::$manager = new ClientManager([
+            'options' => [
+                "debug" => $_ENV["LIVE_MAILBOX_DEBUG"] ?? false,
+            ],
+            'accounts' => [
+                'default' => [
+                    'host'          => getenv("LIVE_MAILBOX_HOST"),
+                    'port'          => getenv("LIVE_MAILBOX_PORT"),
+                    'encryption'    => getenv("LIVE_MAILBOX_ENCRYPTION"),
+                    'validate_cert' => getenv("LIVE_MAILBOX_VALIDATE_CERT"),
+                    'username'      => getenv("LIVE_MAILBOX_USERNAME"),
+                    'password'      => getenv("LIVE_MAILBOX_PASSWORD"),
+                    'protocol'      => 'imap', //might also use imap, [pop3 or nntp (untested)]
+                ],
+            ],
+        ]);
+        return self::$manager;
+    }
+
+    /**
+     * Get a fixture message
+     * @param string $template
+     *
+     * @return Message
+     * @throws ReflectionException
+     * @throws AuthFailedException
+     * @throws ConnectionFailedException
+     * @throws ImapBadRequestException
+     * @throws ImapServerErrorException
+     * @throws InvalidMessageDateException
+     * @throws MaskNotFoundException
+     * @throws MessageContentFetchingException
+     * @throws ResponseException
+     * @throws RuntimeException
+     */
+    final public function getFixture(string $template, Config $config = null) : Message {
+        $filename = implode(DIRECTORY_SEPARATOR, [__DIR__, "..",  "messages", $template]);
+        $message = Message::fromFile($filename, $config);
+        self::assertInstanceOf(Message::class, $message);
+
+        return $message;
+    }
+}