Add ability to fetch message size

Author: stevebauman

src/FileMessage.php

@@ -24,6 +24,14 @@ public function uid(): int
         throw new BadMethodCallException('FileMessage does not support a UID');
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    public function size(): ?int
+    {
+        return strlen($this->contents);
+    }
+
     /**
      * {@inheritDoc}
      */

src/Message.php

@@ -22,6 +22,7 @@ public function __construct(
         protected array $flags,
         protected string $head,
         protected string $body,
+        protected ?int $size = null,
     ) {}
 
     /**
@@ -30,7 +31,7 @@ public function __construct(
     public function __sleep(): array
     {
         // We don't want to serialize the parsed message.
-        return ['folder', 'uid', 'flags', 'headers', 'contents'];
+        return ['folder', 'uid', 'flags', 'headers', 'contents', 'size'];
     }
 
     /**
@@ -49,6 +50,14 @@ public function uid(): int
         return $this->uid;
     }
 
+    /**
+     * Get the message's size in bytes (RFC822.SIZE).
+     */
+    public function size(): ?int
+    {
+        return $this->size;
+    }
+
     /**
      * Get the message's flags.
      */
@@ -203,6 +212,7 @@ public function toArray(): array
             'flags' => $this->flags,
             'head' => $this->head,
             'body' => $this->body,
+            'size' => $this->size,
         ];
     }
 

src/MessageInterface.php

@@ -15,6 +15,11 @@ interface MessageInterface extends FlaggableInterface, Stringable
      */
     public function uid(): int;
 
+    /**
+     * Get the message's size in bytes (RFC822.SIZE).
+     */
+    public function size(): ?int;
+
     /**
      * Get the message date and time.
      */

src/MessageQuery.php

@@ -239,6 +239,7 @@ protected function populate(Collection $uids): MessageCollection
                     $response['flags'] ?? [],
                     $response['headers'] ?? '',
                     $response['contents'] ?? '',
+                    $response['size'] ?? null,
                 )
             );
         }
@@ -264,6 +265,10 @@ protected function fetch(Collection $messages): array
             $fetch[] = 'FLAGS';
         }
 
+        if ($this->fetchSize) {
+            $fetch[] = 'RFC822.SIZE';
+        }
+
         if ($this->fetchBody) {
             $fetch[] = $this->fetchAsUnread
                 ? 'BODY.PEEK[TEXT]'
@@ -279,6 +284,7 @@ protected function fetch(Collection $messages): array
         if (empty($fetch)) {
             return $uids->mapWithKeys(fn (string|int $uid) => [
                 $uid => [
+                    'size' => null,
                     'flags' => [],
                     'headers' => '',
                     'contents' => '',
@@ -299,8 +305,11 @@ protected function fetch(Collection $messages): array
 
             $uid = $data->lookup('UID')->value;
 
+            $size = $data->lookup('RFC822.SIZE')?->value;
+
             return [
                 $uid => [
+                    'size' => $size !== null ? (int) $size : null,
                     'flags' => $data->lookup('FLAGS')?->values() ?? [],
                     'headers' => $data->lookup('[HEADER]')->value ?? '',
                     'contents' => $data->lookup('[TEXT]')->value ?? '',
@@ -356,9 +365,9 @@ protected function id(int $id, ImapFetchIdentifier $identifier = ImapFetchIdenti
     /**
      * Make a new message from given raw components.
      */
-    protected function newMessage(int $uid, array $flags, string $headers, string $contents): Message
+    protected function newMessage(int $uid, array $flags, string $headers, string $contents, ?int $size = null): Message
     {
-        return new Message($this->folder, $uid, $flags, $headers, $contents);
+        return new Message($this->folder, $uid, $flags, $headers, $contents, $size);
     }
 
     /**

src/MessageQueryInterface.php

@@ -61,6 +61,11 @@ public function isFetchingFlags(): bool;
      */
     public function isFetchingHeaders(): bool;
 
+    /**
+     * Determine if the size of messages is being fetched.
+     */
+    public function isFetchingSize(): bool;
+
     /**
      * Fetch the flags of messages.
      */
@@ -76,6 +81,11 @@ public function withBody(): MessageQueryInterface;
      */
     public function withHeaders(): MessageQueryInterface;
 
+    /**
+     * Fetch the size of messages.
+     */
+    public function withSize(): MessageQueryInterface;
+
     /**
      * Don't fetch the body of messages.
      */
@@ -91,6 +101,11 @@ public function withoutHeaders(): MessageQueryInterface;
      */
     public function withoutFlags(): MessageQueryInterface;
 
+    /**
+     * Don't fetch the size of messages.
+     */
+    public function withoutSize(): MessageQueryInterface;
+
     /**
      * Set the fetch order.
      */

src/QueriesMessages.php

@@ -40,6 +40,11 @@ trait QueriesMessages
      */
     protected bool $fetchHeaders = false;
 
+    /**
+     * Whether to fetch the message size.
+     */
+    protected bool $fetchSize = false;
+
     /**
      * The fetch order.
      *
@@ -165,6 +170,14 @@ public function isFetchingHeaders(): bool
         return $this->fetchHeaders;
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    public function isFetchingSize(): bool
+    {
+        return $this->fetchSize;
+    }
+
     /**
      * {@inheritDoc}
      */
@@ -189,6 +202,14 @@ public function withHeaders(): MessageQueryInterface
         return $this->setFetchHeaders(true);
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    public function withSize(): MessageQueryInterface
+    {
+        return $this->setFetchSize(true);
+    }
+
     /**
      * {@inheritDoc}
      */
@@ -213,6 +234,14 @@ public function withoutFlags(): MessageQueryInterface
         return $this->setFetchFlags(false);
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    public function withoutSize(): MessageQueryInterface
+    {
+        return $this->setFetchSize(false);
+    }
+
     /**
      * Set whether to fetch the flags.
      */
@@ -243,6 +272,16 @@ protected function setFetchHeaders(bool $fetchHeaders): MessageQueryInterface
         return $this;
     }
 
+    /**
+     * Set whether to fetch the size.
+     */
+    protected function setFetchSize(bool $fetchSize): MessageQueryInterface
+    {
+        $this->fetchSize = $fetchSize;
+
+        return $this;
+    }
+
     /** {@inheritDoc} */
     public function setFetchOrder(string $fetchOrder): MessageQueryInterface
     {

src/Testing/FakeMessage.php

@@ -19,6 +19,7 @@ public function __construct(
         protected int $uid,
         protected array $flags = [],
         protected string $contents = '',
+        protected ?int $size = null,
     ) {}
 
     /**
@@ -29,6 +30,14 @@ public function uid(): int
         return $this->uid;
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    public function size(): ?int
+    {
+        return $this->size;
+    }
+
     /**
      * {@inheritDoc}
      */