Ignore possible untagged lines after IDLE and DONE commands #445 (thanks @gazben)

Author: Webklex

CHANGELOG.md

@@ -11,7 +11,8 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip
 - Fix bug when multipart message getHTMLBody() method returns null #455 (thanks @michalkortas)
 - Fix: Improve return type hints and return docblocks for query classes #470 (thanks @olliescase)
 - Fix - Query - Chunked - Resolved infinite loop when start chunk > 1 #477 (thanks @NeekTheNook)
-- Attachment with symbols in filename #436
+- Attachment with symbols in filename #436 (thanks @nuernbergerA)
+- Ignore possible untagged lines after IDLE and DONE commands #445 (thanks @gazben)
 
 ### Added
 - IMAP STATUS command support added `Folder::status()` #424 (thanks @InterLinked1)

src/Connection/Protocols/ImapProtocol.php

@@ -160,6 +160,25 @@ protected function assumedNextLine(Response $response, string $start): bool {
  return str_starts_with($this->nextLine($response), $start);
  }
 
+ /**
+ * Get the next line and check if it starts with a given string
+ * The server can send untagged status updates starting with '*' if we are not looking for a status update,
+ * the untagged lines will be ignored.
+ *
+ * @param Response $response
+ * @param string $start
+ *
+ * @return bool
+ * @throws RuntimeException
+ */
+ protected function assumedNextLineIgnoreUntagged(Response $response, string $start): bool {
+ do {
+ $line = $this->nextLine($response);
+ } while (!(str_starts_with($start, '*')) && $this->isUntaggedLine($line));
+
+ return str_starts_with($line, $start);
+ }
+
  /**
  * Get the next line and split the tag
  * @param string|null $tag reference tag
@@ -176,6 +195,25 @@ protected function nextTaggedLine(Response $response, ?string &$tag): string {
  return $line ?? '';
  }
 
+ /**
+ * Get the next line and split the tag
+ * The server can send untagged status updates starting with '*', the untagged lines will be ignored.
+ *
+ * @param string|null $tag reference tag
+ *
+ * @return string next line
+ * @throws RuntimeException
+ */
+ protected function nextTaggedLineIgnoreUntagged(Response $response, &$tag): string {
+ do {
+ $line = $this->nextLine($response);
+ } while ($this->isUntaggedLine($line));
+
+ list($tag, $line) = explode(' ', $line, 2);
+
+ return $line;
+ }
+
  /**
  * Get the next line and check if it contains a given string and split the tag
  * @param Response $response
@@ -189,6 +227,32 @@ protected function assumedNextTaggedLine(Response $response, string $start, &$ta
  return str_contains($this->nextTaggedLine($response, $tag), $start);
  }
 
+ /**
+ * Get the next line and check if it contains a given string and split the tag
+ * @param string $start
+ * @param $tag
+ *
+ * @return bool
+ * @throws RuntimeException
+ */
+ protected function assumedNextTaggedLineIgnoreUntagged(Response $response, string $start, &$tag): bool {
+ $line = $this->nextTaggedLineIgnoreUntagged($response, $tag);
+ return strpos($line, $start) !== false;
+ }
+
+ /**
+ * RFC3501 - 2.2.2
+ * Data transmitted by the server to the client and status responses
+ * that do not indicate command completion are prefixed with the token
+ * "*", and are called untagged responses.
+ *
+ * @param string $line
+ * @return bool
+ */
+ protected function isUntaggedLine(string $line) : bool {
+ return str_starts_with($line, '* ');
+ }
+
  /**
  * Split a given line in values. A value is literal of any form or a list
  * @param Response $response
@@ -703,10 +767,12 @@ public function folderStatus(string $folder = 'INBOX', $arguments = ['MESSAGES',
  * @throws RuntimeException
  */
  public function fetch(array|string $items, array|int $from, mixed $to = null, int|string $uid = IMAP::ST_UID): Response {
- if (is_array($from)) {
+ if (is_array($from) && count($from) > 1) {
  $set = implode(',', $from);
+ } elseif (is_array($from) && count($from) === 1) {
+ $set = $from[0] . ':' . $from[0];
  } elseif ($to === null) {
- $set = $from;
+ $set = $from . ':' . $from;
  } elseif ($to == INF) {
  $set = $from . ':*';
  } else {
@@ -1266,7 +1332,7 @@ public function getQuotaRoot(string $quota_root = 'INBOX'): Response {
  */
  public function idle(): void {
  $response = $this->sendRequest("IDLE");
- if (!$this->assumedNextLine($response, '+ ')) {
+ if (!$this->assumedNextLineIgnoreUntagged($response, '+ ')) {
  throw new RuntimeException('idle failed');
  }
  }
@@ -1278,7 +1344,7 @@ public function idle(): void {
  public function done(): bool {
  $response = new Response($this->noun, $this->debug);
  $this->write($response, "DONE");
- if (!$this->assumedNextTaggedLine($response, 'OK', $tags)) {
+ if (!$this->assumedNextTaggedLineIgnoreUntagged($response, 'OK', $tags)) {
  throw new RuntimeException('done failed');
  }
  return true;

src/Folder.php

@@ -121,22 +121,6 @@ class Folder {
  /** @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
@@ -251,8 +235,8 @@ public function getChildren(): FolderCollection {
  */
  protected function decodeName($name): string|array|bool|null {
  $parts = [];
- foreach(explode($this->delimiter, $name) as $item) {
- $parts[] = EncodingAliases::convert($item, "UTF7-IMAP");
+ foreach (explode($this->delimiter, $name) as $item) {
+ $parts[] = EncodingAliases::convert($item, "UTF7-IMAP", "UTF-8");
  }
 
  return implode($this->delimiter, $parts);
@@ -280,14 +264,6 @@ protected function parseAttributes($attributes): void {
  $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);
  }
 
  /**
@@ -308,7 +284,7 @@ protected function parseAttributes($attributes): void {
  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();
+ if ($expunge) $this->client->expunge();
 
  $folder = $this->client->getFolder($new_name);
  $event = $this->getEvent("folder", "moved");
@@ -334,7 +310,7 @@ public function move(string $new_name, bool $expunge = true): array {
  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);
+ $uid = ClientManager::get('options.sequence', IMAP::ST_MSGN);
  $response = $this->client->getConnection()->overview($sequence, $uid);
  return $response->validatedData();
  }
@@ -360,7 +336,7 @@ public function appendMessage(string $message, array $options = null, Carbon|str
  * date string that conforms to the rfc2060 specifications for a date_time value or be a Carbon object.
  */
 
- if($internal_date instanceof Carbon){
+ if ($internal_date instanceof Carbon) {
  $internal_date = $internal_date->format('d-M-Y H:i:s O');
  }
 
@@ -401,11 +377,11 @@ public function rename(string $new_name, bool $expunge = true): array {
  */
  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 ($this->client->getActiveFolder() == $this->path){
+ $this->client->setActiveFolder(null);
  }
 
- if($expunge) $this->client->expunge();
+ if ($expunge) $this->client->expunge();
 
  $event = $this->getEvent("folder", "deleted");
  $event::dispatch($this);
@@ -461,7 +437,7 @@ public function unsubscribe(): array {
  public function idle(callable $callback, int $timeout = 300): void {
  $this->client->setTimeout($timeout);
 
- if(!in_array("IDLE", $this->client->getConnection()->getCapabilities()->validatedData())){
+ if (!in_array("IDLE", $this->client->getConnection()->getCapabilities()->validatedData())) {
  throw new Exceptions\NotSupportedCapabilityException("IMAP server does not support IDLE");
  }
 
@@ -474,15 +450,24 @@ public function idle(callable $callback, int $timeout = 300): void {
 
  $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());
+ while (true) {
+ try {
+ // This polymorphic call is fine - Protocol::idle() will throw an exception beforehand
+ $line = $idle_client->getConnection()->nextLine(Response::empty());
+ } catch (Exceptions\RuntimeException $e) {
+ if(strpos($e->getMessage(), "empty response") >= 0 && $idle_client->getConnection()->connected()) {
+ continue;
+ }
+ if(!str_contains($e->getMessage(), "connection closed")) {
+ throw $e;
+ }
+ }
 
- if(($pos = strpos($line, "EXISTS")) !== false){
+ 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())){
+ 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...
@@ -516,7 +501,7 @@ public function idle(callable $callback, int $timeout = 300): void {
  }
 
  /**
- * Get folder status information from the EXAMINE command
+ * Get folder status information
  *
  * @return array
  * @throws ConnectionFailedException
@@ -526,39 +511,20 @@ public function idle(callable $callback, int $timeout = 300): void {
  * @throws AuthFailedException
  * @throws ResponseException
  */
- public function status(): array {
- return $this->client->getConnection()->folderStatus($this->path)->validatedData();
+ public function getStatus(): array {
+ return $this->examine();
  }
 
  /**
- * 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();
+ $this->status = $this->getStatus();
  return $this;
  }
 
@@ -606,8 +572,8 @@ public function getClient(): Client {
  * @param $delimiter
  */
  public function setDelimiter($delimiter): void {
- if(in_array($delimiter, [null, '', ' ', false]) === true){
- $delimiter = $this->client->getConfig()->get('options.delimiter', '/');
+ if (in_array($delimiter, [null, '', ' ', false]) === true) {
+ $delimiter = ClientManager::get('options.delimiter', '/');
  }
 
  $this->delimiter = $delimiter;

src/Message.php

@@ -556,7 +556,7 @@ public function getHTMLBody(): string {
  */
  private function parseHeader(): void {
  $sequence_id = $this->getSequenceId();
- $headers = $this->client->getConnection()->headers([$sequence_id], "RFC822", $this->sequence)->validatedData();
+ $headers = $this->client->getConnection()->headers([$sequence_id], "RFC822", $this->sequence)->setCanBeEmpty(true)->validatedData();
  if (!isset($headers[$sequence_id])) {
  throw new MessageHeaderFetchingException("no headers found", 0);
  }
@@ -609,7 +609,7 @@ private function parseFlags(): void {
 
  $sequence_id = $this->getSequenceId();
  try {
- $flags = $this->client->getConnection()->flags([$sequence_id], $this->sequence)->validatedData();
+ $flags = $this->client->getConnection()->flags([$sequence_id], $this->sequence)->setCanBeEmpty(true)->validatedData();
  } catch (Exceptions\RuntimeException $e) {
  throw new MessageFlagException("flag could not be fetched", 0, $e);
  }