mirror of
https://github.com/itflow-org/itflow
synced 2026-03-17 03:04:50 +00:00
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
This commit is contained in:
johnnyq
615
plugins/php-imap/src/Folder.php
Executable file
615
plugins/php-imap/src/Folder.php
Executable file
@@ -0,0 +1,615 @@
|
||||
<?php
|
||||
/*
|
||||
* File: Folder.php
|
||||
* Category: -
|
||||
* Author: M. Goldenbaum
|
||||
* Created: 19.01.17 22:21
|
||||
* Updated: -
|
||||
*
|
||||
* Description:
|
||||
* -
|
||||
*/
|
||||
|
||||
namespace Webklex\PHPIMAP;
|
||||
|
||||
use Carbon\Carbon;
|
||||
use Webklex\PHPIMAP\Connection\Protocols\Response;
|
||||
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\MessageNotFoundException;
|
||||
use Webklex\PHPIMAP\Exceptions\NotSupportedCapabilityException;
|
||||
use Webklex\PHPIMAP\Exceptions\ResponseException;
|
||||
use Webklex\PHPIMAP\Exceptions\RuntimeException;
|
||||
use Webklex\PHPIMAP\Query\WhereQuery;
|
||||
use Webklex\PHPIMAP\Support\FolderCollection;
|
||||
use Webklex\PHPIMAP\Traits\HasEvents;
|
||||
|
||||
/**
|
||||
* Class Folder
|
||||
*
|
||||
* @package Webklex\PHPIMAP
|
||||
*/
|
||||
class Folder {
|
||||
use HasEvents;
|
||||
|
||||
/**
|
||||
* Client instance
|
||||
*
|
||||
* @var Client
|
||||
*/
|
||||
protected Client $client;
|
||||
|
||||
/**
|
||||
* Folder full path
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
public string $path;
|
||||
|
||||
/**
|
||||
* Folder name
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
public string $name;
|
||||
|
||||
/**
|
||||
* Folder full name
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
public string $full_name;
|
||||
|
||||
/**
|
||||
* Children folders
|
||||
*
|
||||
* @var FolderCollection
|
||||
*/
|
||||
public FolderCollection $children;
|
||||
|
||||
/**
|
||||
* Delimiter for folder
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
public string $delimiter;
|
||||
|
||||
/**
|
||||
* Indicates if folder can't contain any "children".
|
||||
* CreateFolder won't work on this folder.
|
||||
*
|
||||
* @var boolean
|
||||
*/
|
||||
public bool $no_inferiors;
|
||||
|
||||
/**
|
||||
* Indicates if folder is only container, not a mailbox - you can't open it.
|
||||
*
|
||||
* @var boolean
|
||||
*/
|
||||
public bool $no_select;
|
||||
|
||||
/**
|
||||
* Indicates if folder is marked. This means that it may contain new messages since the last time it was checked.
|
||||
* Not provided by all IMAP servers.
|
||||
*
|
||||
* @var boolean
|
||||
*/
|
||||
public bool $marked;
|
||||
|
||||
/**
|
||||
* Indicates if folder contains any "children".
|
||||
* Not provided by all IMAP servers.
|
||||
*
|
||||
* @var boolean
|
||||
*/
|
||||
public bool $has_children;
|
||||
|
||||
/**
|
||||
* Indicates if folder refers to others.
|
||||
* Not provided by all IMAP servers.
|
||||
*
|
||||
* @var boolean
|
||||
*/
|
||||
public bool $referral;
|
||||
|
||||
/** @var array */
|
||||
public array $status;
|
||||
|
||||
/** @var array */
|
||||
public array $attributes = [];
|
||||
|
||||
|
||||
const SPECIAL_ATTRIBUTES = [
|
||||
'haschildren' => ['\haschildren'],
|
||||
'hasnochildren' => ['\hasnochildren'],
|
||||
'template' => ['\template', '\templates'],
|
||||
'inbox' => ['\inbox'],
|
||||
'sent' => ['\sent'],
|
||||
'drafts' => ['\draft', '\drafts'],
|
||||
'archive' => ['\archive', '\archives'],
|
||||
'trash' => ['\trash'],
|
||||
'junk' => ['\junk', '\spam'],
|
||||
];
|
||||
|
||||
/**
|
||||
* Folder constructor.
|
||||
* @param Client $client
|
||||
* @param string $folder_name
|
||||
* @param string $delimiter
|
||||
* @param string[] $attributes
|
||||
*/
|
||||
public function __construct(Client $client, string $folder_name, string $delimiter, array $attributes) {
|
||||
$this->client = $client;
|
||||
|
||||
$this->events["message"] = $client->getDefaultEvents("message");
|
||||
$this->events["folder"] = $client->getDefaultEvents("folder");
|
||||
|
||||
$this->setDelimiter($delimiter);
|
||||
$this->path = $folder_name;
|
||||
$this->full_name = $this->decodeName($folder_name);
|
||||
$this->name = $this->getSimpleName($this->delimiter, $this->full_name);
|
||||
$this->children = new FolderCollection();
|
||||
$this->has_children = false;
|
||||
|
||||
$this->parseAttributes($attributes);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a new search query instance
|
||||
* @param string[] $extensions
|
||||
*
|
||||
* @return WhereQuery
|
||||
* @throws ImapBadRequestException
|
||||
* @throws ImapServerErrorException
|
||||
* @throws RuntimeException
|
||||
* @throws AuthFailedException
|
||||
* @throws ConnectionFailedException
|
||||
* @throws ResponseException
|
||||
*/
|
||||
public function query(array $extensions = []): WhereQuery {
|
||||
$this->getClient()->checkConnection();
|
||||
$this->getClient()->openFolder($this->path);
|
||||
$extensions = count($extensions) > 0 ? $extensions : $this->getClient()->extensions;
|
||||
|
||||
return new WhereQuery($this->getClient(), $extensions);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a new search query instance
|
||||
* @param string[] $extensions
|
||||
*
|
||||
* @return WhereQuery
|
||||
* @throws ImapBadRequestException
|
||||
* @throws ImapServerErrorException
|
||||
* @throws RuntimeException
|
||||
* @throws AuthFailedException
|
||||
* @throws ConnectionFailedException
|
||||
* @throws ResponseException
|
||||
*/
|
||||
public function search(array $extensions = []): WhereQuery {
|
||||
return $this->query($extensions);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a new search query instance
|
||||
* @param string[] $extensions
|
||||
*
|
||||
* @return WhereQuery
|
||||
* @throws ImapBadRequestException
|
||||
* @throws ImapServerErrorException
|
||||
* @throws RuntimeException
|
||||
* @throws AuthFailedException
|
||||
* @throws ConnectionFailedException
|
||||
* @throws ResponseException
|
||||
*/
|
||||
public function messages(array $extensions = []): WhereQuery {
|
||||
return $this->query($extensions);
|
||||
}
|
||||
|
||||
/**
|
||||
* Determine if folder has children.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function hasChildren(): bool {
|
||||
return $this->has_children;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set children.
|
||||
* @param FolderCollection $children
|
||||
*
|
||||
* @return Folder
|
||||
*/
|
||||
public function setChildren(FolderCollection $children): Folder {
|
||||
$this->children = $children;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get children.
|
||||
*
|
||||
* @return FolderCollection
|
||||
*/
|
||||
public function getChildren(): FolderCollection {
|
||||
return $this->children;
|
||||
}
|
||||
|
||||
/**
|
||||
* Decode name.
|
||||
* It converts UTF7-IMAP encoding to UTF-8.
|
||||
* @param $name
|
||||
*
|
||||
* @return string|array|bool|string[]|null
|
||||
*/
|
||||
protected function decodeName($name): string|array|bool|null {
|
||||
$parts = [];
|
||||
foreach(explode($this->delimiter, $name) as $item) {
|
||||
$parts[] = EncodingAliases::convert($item, "UTF7-IMAP");
|
||||
}
|
||||
|
||||
return implode($this->delimiter, $parts);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get simple name (without parent folders).
|
||||
* @param $delimiter
|
||||
* @param $full_name
|
||||
*
|
||||
* @return string|bool
|
||||
*/
|
||||
protected function getSimpleName($delimiter, $full_name): string|bool {
|
||||
$arr = explode($delimiter, $full_name);
|
||||
return end($arr);
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse attributes and set it to object properties.
|
||||
* @param $attributes
|
||||
*/
|
||||
protected function parseAttributes($attributes): void {
|
||||
$this->no_inferiors = in_array('\NoInferiors', $attributes);
|
||||
$this->no_select = in_array('\NoSelect', $attributes);
|
||||
$this->marked = in_array('\Marked', $attributes);
|
||||
$this->referral = in_array('\Referral', $attributes);
|
||||
$this->has_children = in_array('\HasChildren', $attributes);
|
||||
|
||||
array_map(function($el) {
|
||||
foreach(self::SPECIAL_ATTRIBUTES as $key => $attribute) {
|
||||
if(in_array(strtolower($el), $attribute)){
|
||||
$this->attributes[] = $key;
|
||||
}
|
||||
}
|
||||
}, $attributes);
|
||||
}
|
||||
|
||||
/**
|
||||
* Move or rename the current folder
|
||||
* @param string $new_name
|
||||
* @param boolean $expunge
|
||||
*
|
||||
* @return array
|
||||
* @throws ConnectionFailedException
|
||||
* @throws EventNotFoundException
|
||||
* @throws FolderFetchingException
|
||||
* @throws ImapBadRequestException
|
||||
* @throws ImapServerErrorException
|
||||
* @throws RuntimeException
|
||||
* @throws AuthFailedException
|
||||
* @throws ResponseException
|
||||
*/
|
||||
public function move(string $new_name, bool $expunge = true): array {
|
||||
$this->client->checkConnection();
|
||||
$status = $this->client->getConnection()->renameFolder($this->full_name, $new_name)->validatedData();
|
||||
if($expunge) $this->client->expunge();
|
||||
|
||||
$folder = $this->client->getFolder($new_name);
|
||||
$event = $this->getEvent("folder", "moved");
|
||||
$event::dispatch($this, $folder);
|
||||
|
||||
return $status;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a message overview
|
||||
* @param string|null $sequence uid sequence
|
||||
*
|
||||
* @return array
|
||||
* @throws ConnectionFailedException
|
||||
* @throws ImapBadRequestException
|
||||
* @throws ImapServerErrorException
|
||||
* @throws RuntimeException
|
||||
* @throws AuthFailedException
|
||||
* @throws InvalidMessageDateException
|
||||
* @throws MessageNotFoundException
|
||||
* @throws ResponseException
|
||||
*/
|
||||
public function overview(string $sequence = null): array {
|
||||
$this->client->openFolder($this->path);
|
||||
$sequence = $sequence === null ? "1:*" : $sequence;
|
||||
$uid = $this->client->getConfig()->get('options.sequence', IMAP::ST_MSGN);
|
||||
$response = $this->client->getConnection()->overview($sequence, $uid);
|
||||
return $response->validatedData();
|
||||
}
|
||||
|
||||
/**
|
||||
* Append a string message to the current mailbox
|
||||
* @param string $message
|
||||
* @param array|null $options
|
||||
* @param string|Carbon|null $internal_date
|
||||
*
|
||||
* @return array
|
||||
* @throws ConnectionFailedException
|
||||
* @throws ImapBadRequestException
|
||||
* @throws ImapServerErrorException
|
||||
* @throws RuntimeException
|
||||
* @throws AuthFailedException
|
||||
* @throws ResponseException
|
||||
*/
|
||||
public function appendMessage(string $message, array $options = null, Carbon|string $internal_date = null): array {
|
||||
/**
|
||||
* Check if $internal_date is parsed. If it is null it should not be set. Otherwise, the message can't be stored.
|
||||
* If this parameter is set, it will set the INTERNALDATE on the appended message. The parameter should be a
|
||||
* date string that conforms to the rfc2060 specifications for a date_time value or be a Carbon object.
|
||||
*/
|
||||
|
||||
if($internal_date instanceof Carbon){
|
||||
$internal_date = $internal_date->format('d-M-Y H:i:s O');
|
||||
}
|
||||
|
||||
return $this->client->getConnection()->appendMessage($this->path, $message, $options, $internal_date)->validatedData();
|
||||
}
|
||||
|
||||
/**
|
||||
* Rename the current folder
|
||||
* @param string $new_name
|
||||
* @param boolean $expunge
|
||||
*
|
||||
* @return array
|
||||
* @throws ConnectionFailedException
|
||||
* @throws EventNotFoundException
|
||||
* @throws FolderFetchingException
|
||||
* @throws RuntimeException
|
||||
* @throws ImapBadRequestException
|
||||
* @throws ImapServerErrorException
|
||||
* @throws AuthFailedException
|
||||
* @throws ResponseException
|
||||
*/
|
||||
public function rename(string $new_name, bool $expunge = true): array {
|
||||
return $this->move($new_name, $expunge);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete the current folder
|
||||
* @param boolean $expunge
|
||||
*
|
||||
* @return array
|
||||
* @throws ConnectionFailedException
|
||||
* @throws ImapBadRequestException
|
||||
* @throws ImapServerErrorException
|
||||
* @throws RuntimeException
|
||||
* @throws EventNotFoundException
|
||||
* @throws AuthFailedException
|
||||
* @throws ResponseException
|
||||
*/
|
||||
public function delete(bool $expunge = true): array {
|
||||
$status = $this->client->getConnection()->deleteFolder($this->path)->validatedData();
|
||||
if($this->client->getActiveFolder() == $this->path){
|
||||
$this->client->setActiveFolder();
|
||||
}
|
||||
|
||||
if($expunge) $this->client->expunge();
|
||||
|
||||
$event = $this->getEvent("folder", "deleted");
|
||||
$event::dispatch($this);
|
||||
|
||||
return $status;
|
||||
}
|
||||
|
||||
/**
|
||||
* Subscribe the current folder
|
||||
*
|
||||
* @return array
|
||||
* @throws ConnectionFailedException
|
||||
* @throws ImapBadRequestException
|
||||
* @throws ImapServerErrorException
|
||||
* @throws RuntimeException
|
||||
* @throws AuthFailedException
|
||||
* @throws ResponseException
|
||||
*/
|
||||
public function subscribe(): array {
|
||||
$this->client->openFolder($this->path);
|
||||
return $this->client->getConnection()->subscribeFolder($this->path)->validatedData();
|
||||
}
|
||||
|
||||
/**
|
||||
* Unsubscribe the current folder
|
||||
*
|
||||
* @return array
|
||||
* @throws ConnectionFailedException
|
||||
* @throws ImapBadRequestException
|
||||
* @throws ImapServerErrorException
|
||||
* @throws RuntimeException
|
||||
* @throws AuthFailedException
|
||||
* @throws ResponseException
|
||||
*/
|
||||
public function unsubscribe(): array {
|
||||
$this->client->openFolder($this->path);
|
||||
return $this->client->getConnection()->unsubscribeFolder($this->path)->validatedData();
|
||||
}
|
||||
|
||||
/**
|
||||
* Idle the current connection
|
||||
* @param callable $callback function(Message $message) gets called if a new message is received
|
||||
* @param integer $timeout max 1740 seconds - recommended by rfc2177 §3. Should not be lower than the servers "* OK Still here" message interval
|
||||
*
|
||||
* @throws ConnectionFailedException
|
||||
* @throws RuntimeException
|
||||
* @throws AuthFailedException
|
||||
* @throws NotSupportedCapabilityException
|
||||
* @throws ImapBadRequestException
|
||||
* @throws ImapServerErrorException
|
||||
* @throws ResponseException
|
||||
*/
|
||||
public function idle(callable $callback, int $timeout = 300): void {
|
||||
$this->client->setTimeout($timeout);
|
||||
|
||||
if(!in_array("IDLE", $this->client->getConnection()->getCapabilities()->validatedData())){
|
||||
throw new Exceptions\NotSupportedCapabilityException("IMAP server does not support IDLE");
|
||||
}
|
||||
|
||||
$idle_client = $this->client->clone();
|
||||
$idle_client->connect();
|
||||
$idle_client->openFolder($this->path, true);
|
||||
$idle_client->getConnection()->idle();
|
||||
|
||||
$last_action = Carbon::now()->addSeconds($timeout);
|
||||
|
||||
$sequence = $this->client->getConfig()->get('options.sequence', IMAP::ST_MSGN);
|
||||
|
||||
while(true) {
|
||||
// This polymorphic call is fine - Protocol::idle() will throw an exception beforehand
|
||||
$line = $idle_client->getConnection()->nextLine(Response::empty());
|
||||
|
||||
if(($pos = strpos($line, "EXISTS")) !== false){
|
||||
$msgn = (int)substr($line, 2, $pos - 2);
|
||||
|
||||
// Check if the stream is still alive or should be considered stale
|
||||
if(!$this->client->isConnected() || $last_action->isBefore(Carbon::now())){
|
||||
// Reset the connection before interacting with it. Otherwise, the resource might be stale which
|
||||
// would result in a stuck interaction. If you know of a way of detecting a stale resource, please
|
||||
// feel free to improve this logic. I tried a lot but nothing seem to work reliably...
|
||||
// Things that didn't work:
|
||||
// - Closing the resource with fclose()
|
||||
// - Verifying the resource with stream_get_meta_data()
|
||||
// - Bool validating the resource stream (e.g.: (bool)$stream)
|
||||
// - Sending a NOOP command
|
||||
// - Sending a null package
|
||||
// - Reading a null package
|
||||
// - Catching the fs warning
|
||||
|
||||
// This polymorphic call is fine - Protocol::idle() will throw an exception beforehand
|
||||
$this->client->getConnection()->reset();
|
||||
// Establish a new connection
|
||||
$this->client->connect();
|
||||
}
|
||||
$last_action = Carbon::now()->addSeconds($timeout);
|
||||
|
||||
// Always reopen the folder - otherwise the new message number isn't known to the current remote session
|
||||
$this->client->openFolder($this->path, true);
|
||||
|
||||
$message = $this->query()->getMessageByMsgn($msgn);
|
||||
$message->setSequence($sequence);
|
||||
$callback($message);
|
||||
|
||||
$event = $this->getEvent("message", "new");
|
||||
$event::dispatch($message);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get folder status information from the EXAMINE command
|
||||
*
|
||||
* @return array
|
||||
* @throws ConnectionFailedException
|
||||
* @throws ImapBadRequestException
|
||||
* @throws ImapServerErrorException
|
||||
* @throws RuntimeException
|
||||
* @throws AuthFailedException
|
||||
* @throws ResponseException
|
||||
*/
|
||||
public function status(): array {
|
||||
return $this->client->getConnection()->folderStatus($this->path)->validatedData();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get folder status information from the EXAMINE command
|
||||
*
|
||||
* @return array
|
||||
* @throws AuthFailedException
|
||||
* @throws ConnectionFailedException
|
||||
* @throws ImapBadRequestException
|
||||
* @throws ImapServerErrorException
|
||||
* @throws ResponseException
|
||||
* @throws RuntimeException
|
||||
*
|
||||
* @deprecated Use Folder::status() instead
|
||||
*/
|
||||
public function getStatus(): array {
|
||||
return $this->status();
|
||||
}
|
||||
|
||||
/**
|
||||
* Load folder status information from the EXAMINE command
|
||||
* @return Folder
|
||||
* @throws AuthFailedException
|
||||
* @throws ConnectionFailedException
|
||||
* @throws ImapBadRequestException
|
||||
* @throws ImapServerErrorException
|
||||
* @throws ResponseException
|
||||
* @throws RuntimeException
|
||||
*/
|
||||
public function loadStatus(): Folder {
|
||||
$this->status = $this->examine();
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Examine the current folder
|
||||
*
|
||||
* @return array
|
||||
* @throws ConnectionFailedException
|
||||
* @throws ImapBadRequestException
|
||||
* @throws ImapServerErrorException
|
||||
* @throws RuntimeException
|
||||
* @throws AuthFailedException
|
||||
* @throws ResponseException
|
||||
*/
|
||||
public function examine(): array {
|
||||
return $this->client->getConnection()->examineFolder($this->path)->validatedData();
|
||||
}
|
||||
|
||||
/**
|
||||
* Select the current folder
|
||||
*
|
||||
* @return array
|
||||
* @throws AuthFailedException
|
||||
* @throws ConnectionFailedException
|
||||
* @throws ImapBadRequestException
|
||||
* @throws ImapServerErrorException
|
||||
* @throws ResponseException
|
||||
* @throws RuntimeException
|
||||
*/
|
||||
public function select(): array {
|
||||
return $this->client->getConnection()->selectFolder($this->path)->validatedData();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the current Client instance
|
||||
*
|
||||
* @return Client
|
||||
*/
|
||||
public function getClient(): Client {
|
||||
return $this->client;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the delimiter
|
||||
* @param $delimiter
|
||||
*/
|
||||
public function setDelimiter($delimiter): void {
|
||||
if(in_array($delimiter, [null, '', ' ', false]) === true){
|
||||
$delimiter = $this->client->getConfig()->get('options.delimiter', '/');
|
||||
}
|
||||
|
||||
$this->delimiter = $delimiter;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user