Add ability to determine if a message is the same as another

Author: stevebauman

src/FileMessage.php

@@ -31,6 +31,15 @@ public function __toString(): string
         return $this->contents;
     }
 
+    /**
+     * Determine if this message is equal to another.
+     */
+    public function is(MessageInterface $message): bool
+    {
+        return $message instanceof self
+            && $this->contents === $message->contents;
+    }
+
     /**
      * Determine if the message is empty.
      */

src/Message.php

@@ -90,6 +90,16 @@ public function hasBody(): bool
         return ! empty($this->body);
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    public function is(MessageInterface $message): bool
+    {
+        return $message instanceof self
+            && $this->uid === $message->uid
+            && $this->folder->is($message->folder);
+    }
+
     /**
      * Determine if the message is marked as seen.
      */

src/MessageInterface.php

@@ -119,6 +119,11 @@ public function header(string $name, int $offset = 0): ?IHeader;
      */
     public function parse(): MailMimeMessage;
 
+    /**
+     * Determine if the message is the same as another message.
+     */
+    public function is(MessageInterface $message): bool;
+
     /**
      * Get the string representation of the message.
      */

src/Testing/FakeMessage.php

@@ -26,6 +26,17 @@ public function uid(): int
         return $this->uid;
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    public function is(MessageInterface $message): bool
+    {
+        return $message instanceof self
+            && $this->uid === $message->uid
+            && $this->flags === $message->flags
+            && $this->contents === $message->contents;
+    }
+
     /**
      * {@inheritDoc}
      */