AS1024/itflow
1
0
Fork 0
mirror of https://github.com/itflow-org/itflow synced 2026-03-16 18:54:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
johnnyq
2024-06-12 15:39:52 -04:00
parent d64a7ce31e
commit 779527cf6a
218 changed files with 14781 additions and 2722 deletions
Download Patch File Download Diff File Expand all files Collapse all files

318
plugins/php-imap/tests/live/ClientTest.php Normal file
View File

@@ -0,0 +1,318 @@
<?php
/*
* File: ClientTest.php
* Category: -
* Author: M.Goldenbaum
* Created: 04.03.23 03:52
* Updated: -
*
* Description:
* -
*/
namespace Tests\live;
use Webklex\PHPIMAP\Client;
use Webklex\PHPIMAP\Connection\Protocols\ProtocolInterface;
use Webklex\PHPIMAP\EncodingAliases;
use Webklex\PHPIMAP\Exceptions\AuthFailedException;
use Webklex\PHPIMAP\Exceptions\ConnectionFailedException;
use Webklex\PHPIMAP\Exceptions\FolderFetchingException;
use Webklex\PHPIMAP\Exceptions\ImapBadRequestException;
use Webklex\PHPIMAP\Exceptions\ImapServerErrorException;
use Webklex\PHPIMAP\Exceptions\MaskNotFoundException;
use Webklex\PHPIMAP\Exceptions\ResponseException;
use Webklex\PHPIMAP\Exceptions\RuntimeException;
use Webklex\PHPIMAP\Folder;
use Webklex\PHPIMAP\Support\Masks\AttachmentMask;
use Webklex\PHPIMAP\Support\Masks\MessageMask;
/**
* Class ClientTest
*
* @package Tests
*/
class ClientTest extends LiveMailboxTestCase {
/**
* Test if the connection is working
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws ResponseException
* @throws RuntimeException
* @throws MaskNotFoundException
*/
public function testConnect(): void {
self::assertNotNull($this->getClient()->connect());
}
/**
* Test if the connection is working
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws MaskNotFoundException
* @throws ResponseException
* @throws RuntimeException
*/
public function testIsConnected(): void {
$client = $this->getClient()->connect();
self::assertTrue($client->isConnected());
}
/**
* Test if the connection state can be determined
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws MaskNotFoundException
* @throws ResponseException
* @throws RuntimeException
*/
public function testDisconnect(): void {
$client = $this->getClient()->connect();
self::assertFalse($client->disconnect()->isConnected());
}
/**
* Test to get the default inbox folder
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws MaskNotFoundException
* @throws ResponseException
* @throws RuntimeException
* @throws FolderFetchingException
*/
public function testGetFolder(): void {
$client = $this->getClient()->connect();
$folder = $client->getFolder('INBOX');
self::assertInstanceOf(Folder::class, $folder);
}
/**
* Test to get the default inbox folder by name
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws FolderFetchingException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws MaskNotFoundException
* @throws ResponseException
* @throws RuntimeException
*/
public function testGetFolderByName(): void {
$client = $this->getClient()->connect();
$folder = $client->getFolderByName('INBOX');
self::assertInstanceOf(Folder::class, $folder);
}
/**
* Test to get the default inbox folder by path
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws FolderFetchingException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws MaskNotFoundException
* @throws ResponseException
* @throws RuntimeException
*/
public function testGetFolderByPath(): void {
$client = $this->getClient()->connect();
$folder = $client->getFolderByPath('INBOX');
self::assertInstanceOf(Folder::class, $folder);
}
/**
* Test to get all folders
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws FolderFetchingException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws MaskNotFoundException
* @throws ResponseException
* @throws RuntimeException
*/
public function testGetFolders(): void {
$client = $this->getClient()->connect();
$folders = $client->getFolders(false);
self::assertTrue($folders->count() > 0);
}
public function testGetFoldersWithStatus(): void {
$client = $this->getClient()->connect();
$folders = $client->getFoldersWithStatus(false);
self::assertTrue($folders->count() > 0);
}
public function testOpenFolder(): void {
$client = $this->getClient()->connect();
$status = $client->openFolder("INBOX");
self::assertTrue(isset($status["flags"]) && count($status["flags"]) > 0);
self::assertTrue(($status["uidnext"] ?? 0) > 0);
self::assertTrue(($status["uidvalidity"] ?? 0) > 0);
self::assertTrue(($status["recent"] ?? -1) >= 0);
self::assertTrue(($status["exists"] ?? -1) >= 0);
}
public function testCreateFolder(): void {
$client = $this->getClient()->connect();
$delimiter = $this->getManager()->getConfig()->get("options.delimiter");
$folder_path = implode($delimiter, ['INBOX', $this->getSpecialChars()]);
$folder = $client->getFolder($folder_path);
$this->deleteFolder($folder);
$folder = $client->createFolder($folder_path, false);
self::assertInstanceOf(Folder::class, $folder);
$folder = $this->getFolder($folder_path);
self::assertInstanceOf(Folder::class, $folder);
$this->assertEquals($this->getSpecialChars(), $folder->name);
$this->assertEquals($folder_path, $folder->full_name);
$folder_path = implode($delimiter, ['INBOX', EncodingAliases::convert($this->getSpecialChars(), "utf-8", "utf7-imap")]);
$this->assertEquals($folder_path, $folder->path);
// Clean up
if ($this->deleteFolder($folder) === false) {
$this->fail("Could not delete folder: " . $folder->path);
}
}
public function testCheckFolder(): void {
$client = $this->getClient()->connect();
$status = $client->checkFolder("INBOX");
self::assertTrue(isset($status["flags"]) && count($status["flags"]) > 0);
self::assertTrue(($status["uidnext"] ?? 0) > 0);
self::assertTrue(($status["uidvalidity"] ?? 0) > 0);
self::assertTrue(($status["recent"] ?? -1) >= 0);
self::assertTrue(($status["exists"] ?? -1) >= 0);
}
public function testGetFolderPath(): void {
$client = $this->getClient()->connect();
self::assertIsArray($client->openFolder("INBOX"));
self::assertEquals("INBOX", $client->getFolderPath());
}
public function testId(): void {
$client = $this->getClient()->connect();
$info = $client->Id();
self::assertIsArray($info);
$valid = false;
foreach ($info as $value) {
if (str_starts_with($value, "OK")) {
$valid = true;
break;
}
}
self::assertTrue($valid);
}
public function testGetQuotaRoot(): void {
if (!getenv("LIVE_MAILBOX_QUOTA_SUPPORT")) {
$this->markTestSkipped("Quota support is not enabled");
}
$client = $this->getClient()->connect();
$quota = $client->getQuotaRoot("INBOX");
self::assertIsArray($quota);
self::assertTrue(count($quota) > 1);
self::assertIsArray($quota[0]);
self::assertEquals("INBOX", $quota[0][1]);
self::assertIsArray($quota[1]);
self::assertIsArray($quota[1][2]);
self::assertTrue($quota[1][2][2] > 0);
}
public function testSetTimeout(): void {
$client = $this->getClient()->connect();
self::assertInstanceOf(ProtocolInterface::class, $client->setTimeout(57));
self::assertEquals(57, $client->getTimeout());
}
public function testExpunge(): void {
$client = $this->getClient()->connect();
$client->openFolder("INBOX");
$status = $client->expunge();
self::assertIsArray($status);
self::assertIsArray($status[0]);
self::assertEquals("OK", $status[0][0]);
}
public function testGetDefaultMessageMask(): void {
$client = $this->getClient();
self::assertEquals(MessageMask::class, $client->getDefaultMessageMask());
}
public function testGetDefaultEvents(): void {
$client = $this->getClient();
self::assertIsArray($client->getDefaultEvents("message"));
}
public function testSetDefaultMessageMask(): void {
$client = $this->getClient();
self::assertInstanceOf(Client::class, $client->setDefaultMessageMask(AttachmentMask::class));
self::assertEquals(AttachmentMask::class, $client->getDefaultMessageMask());
$client->setDefaultMessageMask(MessageMask::class);
}
public function testGetDefaultAttachmentMask(): void {
$client = $this->getClient();
self::assertEquals(AttachmentMask::class, $client->getDefaultAttachmentMask());
}
public function testSetDefaultAttachmentMask(): void {
$client = $this->getClient();
self::assertInstanceOf(Client::class, $client->setDefaultAttachmentMask(MessageMask::class));
self::assertEquals(MessageMask::class, $client->getDefaultAttachmentMask());
$client->setDefaultAttachmentMask(AttachmentMask::class);
}
}

447
plugins/php-imap/tests/live/FolderTest.php Normal file
View File

@@ -0,0 +1,447 @@
<?php
/*
* File: FolderTest.php
* Category: -
* Author: M.Goldenbaum
* Created: 04.03.23 03:52
* Updated: -
*
* Description:
* -
*/
namespace Tests\live;
use Webklex\PHPIMAP\Client;
use Webklex\PHPIMAP\Exceptions\AuthFailedException;
use Webklex\PHPIMAP\Exceptions\ConnectionFailedException;
use Webklex\PHPIMAP\Exceptions\EventNotFoundException;
use Webklex\PHPIMAP\Exceptions\FolderFetchingException;
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\MessageFlagException;
use Webklex\PHPIMAP\Exceptions\MessageHeaderFetchingException;
use Webklex\PHPIMAP\Exceptions\MessageNotFoundException;
use Webklex\PHPIMAP\Exceptions\ResponseException;
use Webklex\PHPIMAP\Exceptions\RuntimeException;
use Webklex\PHPIMAP\Folder;
use Webklex\PHPIMAP\Message;
use Webklex\PHPIMAP\Query\WhereQuery;
use Webklex\PHPIMAP\Support\FolderCollection;
/**
* Class FolderTest
*
* @package Tests
*/
class FolderTest extends LiveMailboxTestCase {
/**
* Try to create a new query instance
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws FolderFetchingException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws MaskNotFoundException
* @throws ResponseException
* @throws RuntimeException
*/
public function testQuery(): void {
$folder = $this->getFolder('INBOX');
self::assertInstanceOf(Folder::class, $folder);
self::assertInstanceOf(WhereQuery::class, $folder->query());
self::assertInstanceOf(WhereQuery::class, $folder->search());
self::assertInstanceOf(WhereQuery::class, $folder->messages());
}
/**
* Test Folder::hasChildren()
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws FolderFetchingException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws MaskNotFoundException
* @throws ResponseException
* @throws RuntimeException
* @throws EventNotFoundException
*/
public function testHasChildren(): void {
$folder = $this->getFolder('INBOX');
self::assertInstanceOf(Folder::class, $folder);
$delimiter = $this->getManager()->getConfig()->get("options.delimiter");
$child_path = implode($delimiter, ['INBOX', 'test']);
if ($folder->getClient()->getFolder($child_path) === null) {
$folder->getClient()->createFolder($child_path, false);
$folder = $this->getFolder('INBOX');
}
self::assertTrue($folder->hasChildren());
}
/**
* Test Folder::setChildren()
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws EventNotFoundException
* @throws FolderFetchingException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws MaskNotFoundException
* @throws ResponseException
* @throws RuntimeException
*/
public function testSetChildren(): void {
$folder = $this->getFolder('INBOX');
self::assertInstanceOf(Folder::class, $folder);
$delimiter = $this->getManager()->getConfig()->get("options.delimiter");
$child_path = implode($delimiter, ['INBOX', 'test']);
if ($folder->getClient()->getFolder($child_path) === null) {
$folder->getClient()->createFolder($child_path, false);
$folder = $this->getFolder('INBOX');
}
self::assertTrue($folder->hasChildren());
$folder->setChildren(new FolderCollection());
self::assertTrue($folder->getChildren()->isEmpty());
}
/**
* Test Folder::getChildren()
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws EventNotFoundException
* @throws FolderFetchingException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws MaskNotFoundException
* @throws ResponseException
* @throws RuntimeException
*/
public function testGetChildren(): void {
$folder = $this->getFolder('INBOX');
self::assertInstanceOf(Folder::class, $folder);
$delimiter = $this->getManager()->getConfig()->get("options.delimiter");
$child_path = implode($delimiter, ['INBOX', 'test']);
if ($folder->getClient()->getFolder($child_path) === null) {
$folder->getClient()->createFolder($child_path, false);
}
$folder = $folder->getClient()->getFolders()->where('name', 'INBOX')->first();
self::assertInstanceOf(Folder::class, $folder);
self::assertTrue($folder->hasChildren());
self::assertFalse($folder->getChildren()->isEmpty());
}
/**
* Test Folder::move()
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws EventNotFoundException
* @throws FolderFetchingException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws MaskNotFoundException
* @throws ResponseException
* @throws RuntimeException
*/
public function testMove(): void {
$client = $this->getClient();
$delimiter = $this->getManager()->getConfig()->get("options.delimiter");
$folder_path = implode($delimiter, ['INBOX', 'test']);
$folder = $client->getFolder($folder_path);
if ($folder === null) {
$folder = $client->createFolder($folder_path, false);
}
$new_folder_path = implode($delimiter, ['INBOX', 'other']);
$new_folder = $client->getFolder($new_folder_path);
$new_folder?->delete(false);
$status = $folder->move($new_folder_path, false);
self::assertIsArray($status);
self::assertTrue(str_starts_with($status[0], 'OK'));
$new_folder = $client->getFolder($new_folder_path);
self::assertEquals($new_folder_path, $new_folder->path);
self::assertEquals('other', $new_folder->name);
if ($this->deleteFolder($new_folder) === false) {
$this->fail("Could not delete folder: " . $new_folder->path);
}
}
/**
* Test Folder::delete()
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws EventNotFoundException
* @throws FolderFetchingException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws MaskNotFoundException
* @throws ResponseException
* @throws RuntimeException
*/
public function testDelete(): void {
$client = $this->getClient();
$delimiter = $this->getManager()->getConfig()->get("options.delimiter");
$folder_path = implode($delimiter, ['INBOX', 'test']);
$folder = $client->getFolder($folder_path);
if ($folder === null) {
$folder = $client->createFolder($folder_path, false);
}
self::assertInstanceOf(Folder::class, $folder);
if ($this->deleteFolder($folder) === false) {
$this->fail("Could not delete folder: " . $folder->path);
}
}
/**
* Test Folder::overview()
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws EventNotFoundException
* @throws FolderFetchingException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws MaskNotFoundException
* @throws ResponseException
* @throws RuntimeException
* @throws InvalidMessageDateException
* @throws MessageContentFetchingException
* @throws MessageFlagException
* @throws MessageHeaderFetchingException
* @throws MessageNotFoundException
*/
public function testOverview(): void {
$folder = $this->getFolder('INBOX');
self::assertInstanceOf(Folder::class, $folder);
$folder->select();
// Test empty overview
$overview = $folder->overview();
self::assertIsArray($overview);
self::assertCount(0, $overview);
$message = $this->appendMessageTemplate($folder, "plain.eml");
$overview = $folder->overview();
self::assertIsArray($overview);
self::assertCount(1, $overview);
self::assertEquals($message->from->first()->full, end($overview)["from"]->toString());
self::assertTrue($message->delete());
}
/**
* Test Folder::appendMessage()
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws EventNotFoundException
* @throws FolderFetchingException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws InvalidMessageDateException
* @throws MaskNotFoundException
* @throws MessageContentFetchingException
* @throws MessageFlagException
* @throws MessageHeaderFetchingException
* @throws MessageNotFoundException
* @throws ResponseException
* @throws RuntimeException
*/
public function testAppendMessage(): void {
$folder = $this->getFolder('INBOX');
self::assertInstanceOf(Folder::class, $folder);
$message = $this->appendMessageTemplate($folder, "plain.eml");
self::assertInstanceOf(Message::class, $message);
self::assertEquals("Example", $message->subject);
self::assertEquals("to@someone-else.com", $message->to);
self::assertEquals("from@someone.com", $message->from);
// Clean up
$this->assertTrue($message->delete(true));
}
/**
* Test Folder::subscribe()
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws FolderFetchingException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws MaskNotFoundException
* @throws ResponseException
* @throws RuntimeException
*/
public function testSubscribe(): void {
$folder = $this->getFolder('INBOX');
self::assertInstanceOf(Folder::class, $folder);
$status = $folder->subscribe();
self::assertIsArray($status);
self::assertTrue(str_starts_with($status[0], 'OK'));
// Clean up
$folder->unsubscribe();
}
/**
* Test Folder::unsubscribe()
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws FolderFetchingException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws MaskNotFoundException
* @throws ResponseException
* @throws RuntimeException
*/
public function testUnsubscribe(): void {
$folder = $this->getFolder('INBOX');
self::assertInstanceOf(Folder::class, $folder);
$folder->subscribe();
$status = $folder->subscribe();
self::assertIsArray($status);
self::assertTrue(str_starts_with($status[0], 'OK'));
}
/**
* Test Folder::status()
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws FolderFetchingException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws MaskNotFoundException
* @throws ResponseException
* @throws RuntimeException
*/
public function testStatus(): void {
$folder = $this->getFolder('INBOX');
self::assertInstanceOf(Folder::class, $folder);
$status = $folder->status();
self::assertEquals(0, $status['messages']);
self::assertEquals(0, $status['recent']);
self::assertEquals(0, $status['unseen']);
self::assertGreaterThan(0, $status['uidnext']);
self::assertGreaterThan(0, $status['uidvalidity']);
}
/**
* Test Folder::examine()
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws FolderFetchingException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws MaskNotFoundException
* @throws ResponseException
* @throws RuntimeException
*/
public function testExamine(): void {
$folder = $this->getFolder('INBOX');
self::assertInstanceOf(Folder::class, $folder);
$status = $folder->examine();
self::assertTrue(isset($status["flags"]) && count($status["flags"]) > 0);
self::assertTrue(($status["uidnext"] ?? 0) > 0);
self::assertTrue(($status["uidvalidity"] ?? 0) > 0);
self::assertTrue(($status["recent"] ?? -1) >= 0);
self::assertTrue(($status["exists"] ?? -1) >= 0);
}
/**
* Test Folder::getClient()
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws FolderFetchingException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws MaskNotFoundException
* @throws ResponseException
* @throws RuntimeException
*/
public function testGetClient(): void {
$folder = $this->getFolder('INBOX');
self::assertInstanceOf(Folder::class, $folder);
self::assertInstanceOf(Client::class, $folder->getClient());
}
/**
* Test Folder::setDelimiter()
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws FolderFetchingException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws MaskNotFoundException
* @throws ResponseException
* @throws RuntimeException
*/
public function testSetDelimiter(): void {
$folder = $this->getFolder('INBOX');
self::assertInstanceOf(Folder::class, $folder);
$folder->setDelimiter("/");
self::assertEquals("/", $folder->delimiter);
$folder->setDelimiter(".");
self::assertEquals(".", $folder->delimiter);
$default_delimiter = $this->getManager()->getConfig()->get("options.delimiter", "/");
$folder->setDelimiter(null);
self::assertEquals($default_delimiter, $folder->delimiter);
}
}

475
plugins/php-imap/tests/live/LegacyTest.php Normal file
View File

@@ -0,0 +1,475 @@
<?php
/*
* File: LegacyTest.php
* Category: Test
* Author: M.Goldenbaum
* Created: 23.06.23 18:25
* Updated: -
*
* Description:
* -
*/
namespace Tests\live;
use Carbon\Carbon;
use PHPUnit\Framework\TestCase;
use Webklex\PHPIMAP\Client;
use Webklex\PHPIMAP\ClientManager;
use Webklex\PHPIMAP\Exceptions\AuthFailedException;
use Webklex\PHPIMAP\Exceptions\ConnectionFailedException;
use Webklex\PHPIMAP\Exceptions\EventNotFoundException;
use Webklex\PHPIMAP\Exceptions\FolderFetchingException;
use Webklex\PHPIMAP\Exceptions\GetMessagesFailedException;
use Webklex\PHPIMAP\Exceptions\ImapBadRequestException;
use Webklex\PHPIMAP\Exceptions\ImapServerErrorException;
use Webklex\PHPIMAP\Exceptions\InvalidMessageDateException;
use Webklex\PHPIMAP\Exceptions\InvalidWhereQueryCriteriaException;
use Webklex\PHPIMAP\Exceptions\MaskNotFoundException;
use Webklex\PHPIMAP\Exceptions\MessageContentFetchingException;
use Webklex\PHPIMAP\Exceptions\MessageFlagException;
use Webklex\PHPIMAP\Exceptions\MessageHeaderFetchingException;
use Webklex\PHPIMAP\Exceptions\MessageSearchValidationException;
use Webklex\PHPIMAP\Exceptions\ResponseException;
use Webklex\PHPIMAP\Exceptions\RuntimeException;
use Webklex\PHPIMAP\Folder;
use Webklex\PHPIMAP\Message;
use Webklex\PHPIMAP\Query\WhereQuery;
/**
* Class LegacyTest
*
* @package Tests
*/
class LegacyTest extends TestCase {
/**
* Client
*/
protected static Client $client;
/**
* Create a new LegacyTest instance.
* @param string|null $name
* @param array $data
* @param int|string $dataName
*/
public function __construct(?string $name = null, array $data = [], int|string $dataName = '') {
if (!getenv("LIVE_MAILBOX") ?? false) {
$this->markTestSkipped("This test requires a live mailbox. Please set the LIVE_MAILBOX environment variable to run this test.");
}
parent::__construct($name, $data, $dataName);
$manager = new ClientManager([
'options' => [
"debug" => $_ENV["LIVE_MAILBOX_DEBUG"] ?? false,
],
'accounts' => [
'legacy' => [
'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' => 'legacy-imap',
],
],
]);
self::$client = $manager->account('legacy');
self::$client->connect();
self::assertInstanceOf(Client::class, self::$client->connect());
}
/**
* @throws RuntimeException
* @throws MessageFlagException
* @throws MessageContentFetchingException
* @throws ResponseException
* @throws ImapServerErrorException
* @throws MaskNotFoundException
* @throws EventNotFoundException
* @throws FolderFetchingException
* @throws ImapBadRequestException
* @throws ConnectionFailedException
* @throws InvalidMessageDateException
* @throws AuthFailedException
* @throws MessageHeaderFetchingException
*/
public function testSizes(): void {
$delimiter = self::$client->getConfig()->get("options.delimiter");
$child_path = implode($delimiter, ['INBOX', 'test']);
if (self::$client->getFolder($child_path) === null) {
self::$client->createFolder($child_path, false);
}
$folder = $this->getFolder($child_path);
self::assertInstanceOf(Folder::class, $folder);
$message = $this->appendMessageTemplate($folder, "plain.eml");
self::assertInstanceOf(Message::class, $message);
self::assertEquals(214, $message->size);
self::assertEquals(214, self::$client->getConnection()->sizes($message->uid)->array()[$message->uid]);
}
/**
* Try to create a new query instance
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws FolderFetchingException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws MaskNotFoundException
* @throws ResponseException
* @throws RuntimeException
*/
public function testQuery(): void {
$folder = $this->getFolder('INBOX');
self::assertInstanceOf(Folder::class, $folder);
self::assertInstanceOf(WhereQuery::class, $folder->query());
self::assertInstanceOf(WhereQuery::class, $folder->search());
self::assertInstanceOf(WhereQuery::class, $folder->messages());
}
/**
* Get a folder
* @param string $folder_path
*
* @return Folder
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws MaskNotFoundException
* @throws ResponseException
* @throws RuntimeException
* @throws FolderFetchingException
*/
final protected function getFolder(string $folder_path = "INDEX"): Folder {
$folder = self::$client->getFolderByPath($folder_path);
self::assertInstanceOf(Folder::class, $folder);
return $folder;
}
/**
* Append a message to a folder
* @param Folder $folder
* @param string $message
*
* @return Message
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws EventNotFoundException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws InvalidMessageDateException
* @throws MessageContentFetchingException
* @throws MessageFlagException
* @throws MessageHeaderFetchingException
* @throws ResponseException
* @throws RuntimeException
*/
final protected function appendMessage(Folder $folder, string $message): Message {
$status = $folder->select();
if (!isset($status['uidnext'])) {
$this->fail("No UIDNEXT returned");
}
$response = $folder->appendMessage($message);
$valid_response = false;
foreach ($response as $line) {
if (str_starts_with($line, 'OK')) {
$valid_response = true;
break;
}
}
if (!$valid_response) {
$this->fail("Failed to append message: ".implode("\n", $response));
}
$message = $folder->messages()->getMessageByUid($status['uidnext']);
self::assertInstanceOf(Message::class, $message);
return $message;
}
/**
* Append a message template to a folder
* @param Folder $folder
* @param string $template
*
* @return Message
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws EventNotFoundException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws InvalidMessageDateException
* @throws MessageContentFetchingException
* @throws MessageFlagException
* @throws MessageHeaderFetchingException
* @throws ResponseException
* @throws RuntimeException
*/
final protected function appendMessageTemplate(Folder $folder, string $template): Message {
$content = file_get_contents(implode(DIRECTORY_SEPARATOR, [__DIR__, "..", "messages", $template]));
return $this->appendMessage($folder, $content);
}
/**
* Delete a folder if it is given
* @param Folder|null $folder
*
* @return bool
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws EventNotFoundException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws ResponseException
* @throws RuntimeException
*/
final protected function deleteFolder(Folder $folder = null): bool {
$response = $folder?->delete(false);
if (is_array($response)) {
$valid_response = false;
foreach ($response as $line) {
if (str_starts_with($line, 'OK')) {
$valid_response = true;
break;
}
}
if (!$valid_response) {
$this->fail("Failed to delete mailbox: ".implode("\n", $response));
}
return $valid_response;
}
return false;
}
/**
* Try to create a new query instance with a where clause
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws EventNotFoundException
* @throws FolderFetchingException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws InvalidMessageDateException
* @throws MaskNotFoundException
* @throws MessageContentFetchingException
* @throws MessageFlagException
* @throws MessageHeaderFetchingException
* @throws ResponseException
* @throws RuntimeException
* @throws GetMessagesFailedException
* @throws InvalidWhereQueryCriteriaException
* @throws MessageSearchValidationException
*/
public function testQueryWhere(): void {
$delimiter = self::$client->getConfig()->get("options.delimiter");
$folder_path = implode($delimiter, ['INBOX', 'search']);
$folder = self::$client->getFolder($folder_path);
if ($folder !== null) {
self::assertTrue($this->deleteFolder($folder));
}
$folder = self::$client->createFolder($folder_path, false);
$messages = [
$this->appendMessageTemplate($folder, '1366671050@github.com.eml'),
$this->appendMessageTemplate($folder, 'attachment_encoded_filename.eml'),
$this->appendMessageTemplate($folder, 'attachment_long_filename.eml'),
$this->appendMessageTemplate($folder, 'attachment_no_disposition.eml'),
$this->appendMessageTemplate($folder, 'bcc.eml'),
$this->appendMessageTemplate($folder, 'boolean_decoded_content.eml'),
$this->appendMessageTemplate($folder, 'email_address.eml'),
$this->appendMessageTemplate($folder, 'embedded_email.eml'),
$this->appendMessageTemplate($folder, 'embedded_email_without_content_disposition.eml'),
$this->appendMessageTemplate($folder, 'embedded_email_without_content_disposition-embedded.eml'),
$this->appendMessageTemplate($folder, 'example_attachment.eml'),
$this->appendMessageTemplate($folder, 'example_bounce.eml'),
$this->appendMessageTemplate($folder, 'four_nested_emails.eml'),
$this->appendMessageTemplate($folder, 'gbk_charset.eml'),
$this->appendMessageTemplate($folder, 'html_only.eml'),
$this->appendMessageTemplate($folder, 'imap_mime_header_decode_returns_false.eml'),
$this->appendMessageTemplate($folder, 'inline_attachment.eml'),
$this->appendMessageTemplate($folder, 'issue-275.eml'),
$this->appendMessageTemplate($folder, 'issue-275-2.eml'),
$this->appendMessageTemplate($folder, 'issue-348.eml'),
$this->appendMessageTemplate($folder, 'ks_c_5601-1987_headers.eml'),
$this->appendMessageTemplate($folder, 'mail_that_is_attachment.eml'),
$this->appendMessageTemplate($folder, 'missing_date.eml'),
$this->appendMessageTemplate($folder, 'missing_from.eml'),
$this->appendMessageTemplate($folder, 'mixed_filename.eml'),
$this->appendMessageTemplate($folder, 'multipart_without_body.eml'),
$this->appendMessageTemplate($folder, 'multiple_html_parts_and_attachments.eml'),
$this->appendMessageTemplate($folder, 'multiple_nested_attachments.eml'),
$this->appendMessageTemplate($folder, 'nestes_embedded_with_attachment.eml'),
$this->appendMessageTemplate($folder, 'null_content_charset.eml'),
$this->appendMessageTemplate($folder, 'pec.eml'),
$this->appendMessageTemplate($folder, 'plain.eml'),
$this->appendMessageTemplate($folder, 'plain_only.eml'),
$this->appendMessageTemplate($folder, 'plain_text_attachment.eml'),
$this->appendMessageTemplate($folder, 'references.eml'),
$this->appendMessageTemplate($folder, 'simple_multipart.eml'),
$this->appendMessageTemplate($folder, 'structured_with_attachment.eml'),
$this->appendMessageTemplate($folder, 'thread_my_topic.eml'),
$this->appendMessageTemplate($folder, 'thread_re_my_topic.eml'),
$this->appendMessageTemplate($folder, 'thread_unrelated.eml'),
$this->appendMessageTemplate($folder, 'undefined_charset_header.eml'),
$this->appendMessageTemplate($folder, 'undisclosed_recipients_minus.eml'),
$this->appendMessageTemplate($folder, 'undisclosed_recipients_space.eml'),
$this->appendMessageTemplate($folder, 'unknown_encoding.eml'),
$this->appendMessageTemplate($folder, 'without_charset_plain_only.eml'),
$this->appendMessageTemplate($folder, 'without_charset_simple_multipart.eml'),
];
$folder->getClient()->expunge();
$query = $folder->query()->all();
self::assertEquals(count($messages), $query->count());
$query = $folder->query()->whereSubject("test");
self::assertEquals(11, $query->count());
$query = $folder->query()->whereOn(Carbon::now());
self::assertEquals(count($messages), $query->count());
self::assertTrue($this->deleteFolder($folder));
}
/**
* Test query where criteria
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws FolderFetchingException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws InvalidWhereQueryCriteriaException
* @throws MaskNotFoundException
* @throws ResponseException
* @throws RuntimeException
*/
public function testQueryWhereCriteria(): void {
self::$client->reconnect();
$folder = $this->getFolder('INBOX');
self::assertInstanceOf(Folder::class, $folder);
$this->assertWhereSearchCriteria($folder, 'SUBJECT', 'Test');
$this->assertWhereSearchCriteria($folder, 'BODY', 'Test');
$this->assertWhereSearchCriteria($folder, 'TEXT', 'Test');
$this->assertWhereSearchCriteria($folder, 'KEYWORD', 'Test');
$this->assertWhereSearchCriteria($folder, 'UNKEYWORD', 'Test');
$this->assertWhereSearchCriteria($folder, 'FLAGGED', 'Seen');
$this->assertWhereSearchCriteria($folder, 'UNFLAGGED', 'Seen');
$this->assertHeaderSearchCriteria($folder, 'Message-ID', 'Seen');
$this->assertHeaderSearchCriteria($folder, 'In-Reply-To', 'Seen');
$this->assertWhereSearchCriteria($folder, 'BCC', 'test@example.com');
$this->assertWhereSearchCriteria($folder, 'CC', 'test@example.com');
$this->assertWhereSearchCriteria($folder, 'FROM', 'test@example.com');
$this->assertWhereSearchCriteria($folder, 'TO', 'test@example.com');
$this->assertWhereSearchCriteria($folder, 'UID', '1');
$this->assertWhereSearchCriteria($folder, 'UID', '1,2');
$this->assertWhereSearchCriteria($folder, 'ALL');
$this->assertWhereSearchCriteria($folder, 'NEW');
$this->assertWhereSearchCriteria($folder, 'OLD');
$this->assertWhereSearchCriteria($folder, 'SEEN');
$this->assertWhereSearchCriteria($folder, 'UNSEEN');
$this->assertWhereSearchCriteria($folder, 'RECENT');
$this->assertWhereSearchCriteria($folder, 'ANSWERED');
$this->assertWhereSearchCriteria($folder, 'UNANSWERED');
$this->assertWhereSearchCriteria($folder, 'DELETED');
$this->assertWhereSearchCriteria($folder, 'UNDELETED');
$this->assertHeaderSearchCriteria($folder, 'Content-Language','en_US');
$this->assertWhereSearchCriteria($folder, 'CUSTOM X-Spam-Flag NO');
$this->assertWhereSearchCriteria($folder, 'CUSTOM X-Spam-Flag YES');
$this->assertWhereSearchCriteria($folder, 'NOT');
$this->assertWhereSearchCriteria($folder, 'OR');
$this->assertWhereSearchCriteria($folder, 'AND');
$this->assertWhereSearchCriteria($folder, 'BEFORE', '01-Jan-2020', true);
$this->assertWhereSearchCriteria($folder, 'BEFORE', Carbon::now()->subDays(1), true);
$this->assertWhereSearchCriteria($folder, 'ON', '01-Jan-2020', true);
$this->assertWhereSearchCriteria($folder, 'ON', Carbon::now()->subDays(1), true);
$this->assertWhereSearchCriteria($folder, 'SINCE', '01-Jan-2020', true);
$this->assertWhereSearchCriteria($folder, 'SINCE', Carbon::now()->subDays(1), true);
}
/**
* Assert where search criteria
* @param Folder $folder
* @param string $criteria
* @param string|Carbon|null $value
* @param bool $date
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws InvalidWhereQueryCriteriaException
* @throws ResponseException
* @throws RuntimeException
*/
protected function assertWhereSearchCriteria(Folder $folder, string $criteria, Carbon|string $value = null, bool $date = false): void {
$query = $folder->query()->where($criteria, $value);
self::assertInstanceOf(WhereQuery::class, $query);
$item = $query->getQuery()->first();
$criteria = str_replace("CUSTOM ", "", $criteria);
$expected = $value === null ? [$criteria] : [$criteria, $value];
if ($date === true && $value instanceof Carbon) {
$date_format = $folder->getClient()->getConfig()->get('date_format', 'd M y');
$expected[1] = $value->format($date_format);
}
self::assertIsArray($item);
self::assertIsString($item[0]);
if($value !== null) {
self::assertCount(2, $item);
self::assertIsString($item[1]);
}else{
self::assertCount(1, $item);
}
self::assertSame($expected, $item);
}
/**
* Assert header search criteria
* @param Folder $folder
* @param string $criteria
* @param mixed|null $value
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws InvalidWhereQueryCriteriaException
* @throws ResponseException
* @throws RuntimeException
*/
protected function assertHeaderSearchCriteria(Folder $folder, string $criteria, mixed $value = null): void {
$query = $folder->query()->whereHeader($criteria, $value);
self::assertInstanceOf(WhereQuery::class, $query);
$item = $query->getQuery()->first();
self::assertIsArray($item);
self::assertIsString($item[0]);
self::assertCount(1, $item);
self::assertSame(['HEADER '.$criteria.' '.$value], $item);
}
}

220
plugins/php-imap/tests/live/LiveMailboxTestCase.php Normal file
View File

@@ -0,0 +1,220 @@
<?php
/*
* File: LiveMailboxTestCase.php
* Category: -
* Author: M.Goldenbaum
* Created: 04.03.23 03:43
* Updated: -
*
* Description:
* -
*/
namespace Tests\live;
use PHPUnit\Framework\TestCase;
use Webklex\PHPIMAP\Client;
use Webklex\PHPIMAP\ClientManager;
use Webklex\PHPIMAP\Exceptions\AuthFailedException;
use Webklex\PHPIMAP\Exceptions\ConnectionFailedException;
use Webklex\PHPIMAP\Exceptions\EventNotFoundException;
use Webklex\PHPIMAP\Exceptions\FolderFetchingException;
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\MessageFlagException;
use Webklex\PHPIMAP\Exceptions\MessageHeaderFetchingException;
use Webklex\PHPIMAP\Exceptions\ResponseException;
use Webklex\PHPIMAP\Exceptions\RuntimeException;
use Webklex\PHPIMAP\Folder;
use Webklex\PHPIMAP\Message;
/**
* Class LiveMailboxTestCase
*
* @package Tests
*/
abstract class LiveMailboxTestCase extends TestCase {
/**
* Special chars
*/
const SPECIAL_CHARS = 'A_\\|!"£$%&()=?àèìòùÀÈÌÒÙ<>-@#[]_ß_б_π_€_✔_你_يد_Z_';
/**
* Client manager
* @var ClientManager $manager
*/
protected static ClientManager $manager;
/**
* Get the client manager
*
* @return ClientManager
*/
final protected function getManager(): ClientManager {
if (!isset(self::$manager)) {
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 the client
*
* @return Client
* @throws MaskNotFoundException
*/
final protected function getClient(): Client {
if (!getenv("LIVE_MAILBOX") ?? false) {
$this->markTestSkipped("This test requires a live mailbox. Please set the LIVE_MAILBOX environment variable to run this test.");
}
return $this->getManager()->account('default');
}
/**
* Get special chars
*
* @return string
*/
final protected function getSpecialChars(): string {
return self::SPECIAL_CHARS;
}
/**
* Get a folder
* @param string $folder_path
*
* @return Folder
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws MaskNotFoundException
* @throws ResponseException
* @throws RuntimeException
* @throws FolderFetchingException
*/
final protected function getFolder(string $folder_path = "INDEX"): Folder {
$client = $this->getClient();
self::assertInstanceOf(Client::class, $client->connect());
$folder = $client->getFolderByPath($folder_path);
self::assertInstanceOf(Folder::class, $folder);
return $folder;
}
/**
* Append a message to a folder
* @param Folder $folder
* @param string $message
*
* @return Message
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws EventNotFoundException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws InvalidMessageDateException
* @throws MessageContentFetchingException
* @throws MessageFlagException
* @throws MessageHeaderFetchingException
* @throws ResponseException
* @throws RuntimeException
*/
final protected function appendMessage(Folder $folder, string $message): Message {
$status = $folder->select();
if (!isset($status['uidnext'])) {
$this->fail("No UIDNEXT returned");
}
$response = $folder->appendMessage($message);
$valid_response = false;
foreach ($response as $line) {
if (str_starts_with($line, 'OK')) {
$valid_response = true;
break;
}
}
if (!$valid_response) {
$this->fail("Failed to append message: ".implode("\n", $response));
}
$message = $folder->messages()->getMessageByUid($status['uidnext']);
self::assertInstanceOf(Message::class, $message);
return $message;
}
/**
* Append a message template to a folder
* @param Folder $folder
* @param string $template
*
* @return Message
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws EventNotFoundException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws InvalidMessageDateException
* @throws MessageContentFetchingException
* @throws MessageFlagException
* @throws MessageHeaderFetchingException
* @throws ResponseException
* @throws RuntimeException
*/
final protected function appendMessageTemplate(Folder $folder, string $template): Message {
$content = file_get_contents(implode(DIRECTORY_SEPARATOR, [__DIR__, "..", "messages", $template]));
return $this->appendMessage($folder, $content);
}
/**
* Delete a folder if it is given
* @param Folder|null $folder
*
* @return bool
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws EventNotFoundException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws ResponseException
* @throws RuntimeException
*/
final protected function deleteFolder(Folder $folder = null): bool {
$response = $folder?->delete(false);
if (is_array($response)) {
$valid_response = false;
foreach ($response as $line) {
if (str_starts_with($line, 'OK')) {
$valid_response = true;
break;
}
}
if (!$valid_response) {
$this->fail("Failed to delete mailbox: ".implode("\n", $response));
}
return $valid_response;
}
return false;
}
}

2410
plugins/php-imap/tests/live/MessageTest.php Normal file
View File

File diff suppressed because it is too large Load Diff

283
plugins/php-imap/tests/live/QueryTest.php Normal file
View File

@@ -0,0 +1,283 @@
<?php
/*
* File: QueryTest.php
* Category: -
* Author: M.Goldenbaum
* Created: 04.03.23 03:52
* Updated: -
*
* Description:
* -
*/
namespace Tests\live;
use Carbon\Carbon;
use Webklex\PHPIMAP\ClientManager;
use Webklex\PHPIMAP\Exceptions\AuthFailedException;
use Webklex\PHPIMAP\Exceptions\ConnectionFailedException;
use Webklex\PHPIMAP\Exceptions\EventNotFoundException;
use Webklex\PHPIMAP\Exceptions\FolderFetchingException;
use Webklex\PHPIMAP\Exceptions\GetMessagesFailedException;
use Webklex\PHPIMAP\Exceptions\ImapBadRequestException;
use Webklex\PHPIMAP\Exceptions\ImapServerErrorException;
use Webklex\PHPIMAP\Exceptions\InvalidMessageDateException;
use Webklex\PHPIMAP\Exceptions\InvalidWhereQueryCriteriaException;
use Webklex\PHPIMAP\Exceptions\MaskNotFoundException;
use Webklex\PHPIMAP\Exceptions\MessageContentFetchingException;
use Webklex\PHPIMAP\Exceptions\MessageFlagException;
use Webklex\PHPIMAP\Exceptions\MessageHeaderFetchingException;
use Webklex\PHPIMAP\Exceptions\MessageSearchValidationException;
use Webklex\PHPIMAP\Exceptions\ResponseException;
use Webklex\PHPIMAP\Exceptions\RuntimeException;
use Webklex\PHPIMAP\Folder;
use Webklex\PHPIMAP\Query\WhereQuery;
/**
* Class QueryTest
*
* @package Tests
*/
class QueryTest extends LiveMailboxTestCase {
/**
* Try to create a new query instance
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws FolderFetchingException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws MaskNotFoundException
* @throws ResponseException
* @throws RuntimeException
*/
public function testQuery(): void {
$folder = $this->getFolder('INBOX');
self::assertInstanceOf(Folder::class, $folder);
self::assertInstanceOf(WhereQuery::class, $folder->query());
self::assertInstanceOf(WhereQuery::class, $folder->search());
self::assertInstanceOf(WhereQuery::class, $folder->messages());
}
/**
* Try to create a new query instance with a where clause
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws EventNotFoundException
* @throws FolderFetchingException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws InvalidMessageDateException
* @throws MaskNotFoundException
* @throws MessageContentFetchingException
* @throws MessageFlagException
* @throws MessageHeaderFetchingException
* @throws ResponseException
* @throws RuntimeException
* @throws GetMessagesFailedException
* @throws InvalidWhereQueryCriteriaException
* @throws MessageSearchValidationException
*/
public function testQueryWhere(): void {
$client = $this->getClient();
$delimiter = $this->getManager()->getConfig()->get("options.delimiter");
$folder_path = implode($delimiter, ['INBOX', 'search']);
$folder = $client->getFolder($folder_path);
if ($folder !== null) {
self::assertTrue($this->deleteFolder($folder));
}
$folder = $client->createFolder($folder_path, false);
$messages = [
$this->appendMessageTemplate($folder, '1366671050@github.com.eml'),
$this->appendMessageTemplate($folder, 'attachment_encoded_filename.eml'),
$this->appendMessageTemplate($folder, 'attachment_long_filename.eml'),
$this->appendMessageTemplate($folder, 'attachment_no_disposition.eml'),
$this->appendMessageTemplate($folder, 'bcc.eml'),
$this->appendMessageTemplate($folder, 'boolean_decoded_content.eml'),
$this->appendMessageTemplate($folder, 'email_address.eml'),
$this->appendMessageTemplate($folder, 'embedded_email.eml'),
$this->appendMessageTemplate($folder, 'embedded_email_without_content_disposition.eml'),
$this->appendMessageTemplate($folder, 'embedded_email_without_content_disposition-embedded.eml'),
$this->appendMessageTemplate($folder, 'example_attachment.eml'),
$this->appendMessageTemplate($folder, 'example_bounce.eml'),
$this->appendMessageTemplate($folder, 'four_nested_emails.eml'),
$this->appendMessageTemplate($folder, 'gbk_charset.eml'),
$this->appendMessageTemplate($folder, 'html_only.eml'),
$this->appendMessageTemplate($folder, 'imap_mime_header_decode_returns_false.eml'),
$this->appendMessageTemplate($folder, 'inline_attachment.eml'),
$this->appendMessageTemplate($folder, 'issue-275.eml'),
$this->appendMessageTemplate($folder, 'issue-275-2.eml'),
$this->appendMessageTemplate($folder, 'issue-348.eml'),
$this->appendMessageTemplate($folder, 'ks_c_5601-1987_headers.eml'),
$this->appendMessageTemplate($folder, 'mail_that_is_attachment.eml'),
$this->appendMessageTemplate($folder, 'missing_date.eml'),
$this->appendMessageTemplate($folder, 'missing_from.eml'),
$this->appendMessageTemplate($folder, 'mixed_filename.eml'),
$this->appendMessageTemplate($folder, 'multipart_without_body.eml'),
$this->appendMessageTemplate($folder, 'multiple_html_parts_and_attachments.eml'),
$this->appendMessageTemplate($folder, 'multiple_nested_attachments.eml'),
$this->appendMessageTemplate($folder, 'nestes_embedded_with_attachment.eml'),
$this->appendMessageTemplate($folder, 'null_content_charset.eml'),
$this->appendMessageTemplate($folder, 'pec.eml'),
$this->appendMessageTemplate($folder, 'plain.eml'),
$this->appendMessageTemplate($folder, 'plain_only.eml'),
$this->appendMessageTemplate($folder, 'plain_text_attachment.eml'),
$this->appendMessageTemplate($folder, 'references.eml'),
$this->appendMessageTemplate($folder, 'simple_multipart.eml'),
$this->appendMessageTemplate($folder, 'structured_with_attachment.eml'),
$this->appendMessageTemplate($folder, 'thread_my_topic.eml'),
$this->appendMessageTemplate($folder, 'thread_re_my_topic.eml'),
$this->appendMessageTemplate($folder, 'thread_unrelated.eml'),
$this->appendMessageTemplate($folder, 'undefined_charset_header.eml'),
$this->appendMessageTemplate($folder, 'undisclosed_recipients_minus.eml'),
$this->appendMessageTemplate($folder, 'undisclosed_recipients_space.eml'),
$this->appendMessageTemplate($folder, 'unknown_encoding.eml'),
$this->appendMessageTemplate($folder, 'without_charset_plain_only.eml'),
$this->appendMessageTemplate($folder, 'without_charset_simple_multipart.eml'),
];
$folder->getClient()->expunge();
$query = $folder->query()->all();
self::assertEquals(count($messages), $query->count());
$query = $folder->query()->whereSubject("test");
self::assertEquals(11, $query->count());
$query = $folder->query()->whereOn(Carbon::now());
self::assertEquals(count($messages), $query->count());
self::assertTrue($this->deleteFolder($folder));
}
/**
* Test query where criteria
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws FolderFetchingException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws InvalidWhereQueryCriteriaException
* @throws MaskNotFoundException
* @throws ResponseException
* @throws RuntimeException
*/
public function testQueryWhereCriteria(): void {
$folder = $this->getFolder('INBOX');
self::assertInstanceOf(Folder::class, $folder);
$this->assertWhereSearchCriteria($folder, 'SUBJECT', 'Test');
$this->assertWhereSearchCriteria($folder, 'BODY', 'Test');
$this->assertWhereSearchCriteria($folder, 'TEXT', 'Test');
$this->assertWhereSearchCriteria($folder, 'KEYWORD', 'Test');
$this->assertWhereSearchCriteria($folder, 'UNKEYWORD', 'Test');
$this->assertWhereSearchCriteria($folder, 'FLAGGED', 'Seen');
$this->assertWhereSearchCriteria($folder, 'UNFLAGGED', 'Seen');
$this->assertHeaderSearchCriteria($folder, 'Message-ID', 'Seen');
$this->assertHeaderSearchCriteria($folder, 'In-Reply-To', 'Seen');
$this->assertWhereSearchCriteria($folder, 'BCC', 'test@example.com');
$this->assertWhereSearchCriteria($folder, 'CC', 'test@example.com');
$this->assertWhereSearchCriteria($folder, 'FROM', 'test@example.com');
$this->assertWhereSearchCriteria($folder, 'TO', 'test@example.com');
$this->assertWhereSearchCriteria($folder, 'UID', '1');
$this->assertWhereSearchCriteria($folder, 'UID', '1,2');
$this->assertWhereSearchCriteria($folder, 'ALL');
$this->assertWhereSearchCriteria($folder, 'NEW');
$this->assertWhereSearchCriteria($folder, 'OLD');
$this->assertWhereSearchCriteria($folder, 'SEEN');
$this->assertWhereSearchCriteria($folder, 'UNSEEN');
$this->assertWhereSearchCriteria($folder, 'RECENT');
$this->assertWhereSearchCriteria($folder, 'ANSWERED');
$this->assertWhereSearchCriteria($folder, 'UNANSWERED');
$this->assertWhereSearchCriteria($folder, 'DELETED');
$this->assertWhereSearchCriteria($folder, 'UNDELETED');
$this->assertHeaderSearchCriteria($folder, 'Content-Language','en_US');
$this->assertWhereSearchCriteria($folder, 'CUSTOM X-Spam-Flag NO');
$this->assertWhereSearchCriteria($folder, 'CUSTOM X-Spam-Flag YES');
$this->assertWhereSearchCriteria($folder, 'NOT');
$this->assertWhereSearchCriteria($folder, 'OR');
$this->assertWhereSearchCriteria($folder, 'AND');
$this->assertWhereSearchCriteria($folder, 'BEFORE', '01-Jan-2020', true);
$this->assertWhereSearchCriteria($folder, 'BEFORE', Carbon::now()->subDays(1), true);
$this->assertWhereSearchCriteria($folder, 'ON', '01-Jan-2020', true);
$this->assertWhereSearchCriteria($folder, 'ON', Carbon::now()->subDays(1), true);
$this->assertWhereSearchCriteria($folder, 'SINCE', '01-Jan-2020', true);
$this->assertWhereSearchCriteria($folder, 'SINCE', Carbon::now()->subDays(1), true);
}
/**
* Assert where search criteria
* @param Folder $folder
* @param string $criteria
* @param string|Carbon|null $value
* @param bool $date
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws InvalidWhereQueryCriteriaException
* @throws ResponseException
* @throws RuntimeException
*/
protected function assertWhereSearchCriteria(Folder $folder, string $criteria, Carbon|string $value = null, bool $date = false): void {
$query = $folder->query()->where($criteria, $value);
self::assertInstanceOf(WhereQuery::class, $query);
$item = $query->getQuery()->first();
$criteria = str_replace("CUSTOM ", "", $criteria);
$expected = $value === null ? [$criteria] : [$criteria, $value];
if ($date === true && $value instanceof Carbon) {
$date_format = $folder->getClient()->getConfig()->get('date_format', 'd M y');
$expected[1] = $value->format($date_format);
}
self::assertIsArray($item);
self::assertIsString($item[0]);
if($value !== null) {
self::assertCount(2, $item);
self::assertIsString($item[1]);
}else{
self::assertCount(1, $item);
}
self::assertSame($expected, $item);
}
/**
* Assert header search criteria
* @param Folder $folder
* @param string $criteria
* @param mixed|null $value
*
* @return void
* @throws AuthFailedException
* @throws ConnectionFailedException
* @throws ImapBadRequestException
* @throws ImapServerErrorException
* @throws InvalidWhereQueryCriteriaException
* @throws ResponseException
* @throws RuntimeException
*/
protected function assertHeaderSearchCriteria(Folder $folder, string $criteria, mixed $value = null): void {
$query = $folder->query()->whereHeader($criteria, $value);
self::assertInstanceOf(WhereQuery::class, $query);
$item = $query->getQuery()->first();
self::assertIsArray($item);
self::assertIsString($item[0]);
self::assertCount(1, $item);
self::assertSame(['HEADER '.$criteria.' '.$value], $item);
}
}