Files
itflow/plugins/vendor/directorytree/imapengine/src/Poll.php
johnnyq 2204bd52f4 Rewrite email parser using ImapEngine, harden processing loop
Replace webklex/php-imap with directorytree/imapengine in the ticket
email parser. ImapEngine is pure PHP over sockets.

Parser improvements:
- Wrap per-message processing in try/catch so one malformed email
  can't abort the run; failures are flagged and logged with UID
- Query unseen + unflagged so previously-failed (flagged) messages
  are no longer re-processed on every cron run
- Skip vacation/auto-responder emails (RFC 3834) to prevent mail
  loops with the ticket auto-reply
- Cap messages per run (50) and attachment size (15MB); inline
  images over 2MB are stored as attachments instead of base64-embedded
  in ticket details
- Atomic lock file creation
- preg_quote() the ticket prefix in subject matching
- Dedupe CC watchers and exclude the sender
- Map webklex 'tls' encryption setting to STARTTLS for compatibility

NDR/DSN parsing now walks MIME parts via the underlying
zbateson parser instead of relying on attachment extraction.
2026-06-12 16:56:39 -04:00

136 lines
3.1 KiB
PHP

<?php
namespace DirectoryTree\ImapEngine;
use Closure;
use DirectoryTree\ImapEngine\Exceptions\Exception;
use DirectoryTree\ImapEngine\Exceptions\ImapConnectionClosedException;
class Poll
{
/**
* The last seen message UID.
*/
protected ?int $lastSeenUid = null;
/**
* Constructor.
*/
public function __construct(
protected Mailbox $mailbox,
protected string $folder,
protected Closure|int $frequency,
) {}
/**
* Destructor.
*/
public function __destruct()
{
$this->disconnect();
}
/**
* Poll for new messages at a given frequency.
*/
public function start(callable $callback, callable $query): void
{
$this->connect();
while ($frequency = $this->getNextFrequency()) {
try {
$this->check($callback, $query);
} catch (ImapConnectionClosedException) {
$this->reconnect();
}
sleep($frequency);
}
}
/**
* Check for new messages since the last seen UID.
*/
protected function check(callable $callback, callable $query): void
{
$folder = $this->folder();
// If we don't have a last seen UID, we will fetch
// the last one in the folder as a starting point.
if (! $this->lastSeenUid) {
$this->lastSeenUid = $folder->messages()
->first()
?->uid() ?? 0;
return;
}
$query($folder->messages())
->uid($this->lastSeenUid + 1, INF)
->each(function (MessageInterface $message) use ($callback) {
// Avoid processing the same message twice on subsequent polls.
// Some IMAP servers will always return the last seen UID in
// the search results regardless of given UID search range.
if ($this->lastSeenUid === $message->uid()) {
return;
}
$callback($message);
$this->lastSeenUid = $message->uid();
});
}
/**
* Get the folder to poll.
*/
protected function folder(): FolderInterface
{
return $this->mailbox->folders()->findOrFail($this->folder);
}
/**
* Reconnect the client and restart the poll session.
*/
protected function reconnect(): void
{
$this->mailbox->disconnect();
$this->connect();
}
/**
* Connect the client and select the folder to poll.
*/
protected function connect(): void
{
$this->mailbox->connect();
$this->mailbox->select($this->folder(), true);
}
/**
* Disconnect the client.
*/
protected function disconnect(): void
{
try {
$this->mailbox->disconnect();
} catch (Exception) {
// Do nothing.
}
}
/**
* Get the next frequency in seconds.
*/
protected function getNextFrequency(): int|false
{
if (is_numeric($seconds = value($this->frequency))) {
return abs((int) $seconds);
}
return false;
}
}