Added ability to extract text and html from multipart messages

Webador · Nov 16, 2023 · 2df9632 · 2df9632
1 parent bbeb128
commit 2df9632
Show file tree

Hide file tree

Showing 2 changed files with 215 additions and 2 deletions.
diff --git a/src/Service/AbstractMailService.php b/src/Service/AbstractMailService.php
@@ -46,11 +46,21 @@
 use Laminas\Mime\Message as MimeMessage;
 use Laminas\Mime\Mime;
 
+use function in_array;
+
 /**
  * Class AbstractMailService
  */
 abstract class AbstractMailService implements MailServiceInterface
 {
+    private const MULTIPART_TYPES = [
+        Mime::MULTIPART_ALTERNATIVE,
+        Mime::MULTIPART_MIXED,
+        Mime::MULTIPART_RELATED,
+        Mime::MULTIPART_RELATIVE,
+        Mime::MULTIPART_REPORT,
+    ];
+
     /**
      * @var HttpClient
      */
@@ -74,11 +84,23 @@ protected function extractText(Message $message): ?string
             return null;
         }
 
-        foreach ($body->getParts() as $part) {
+        return $this->extractTextFromMimeMessage($body);
+    }
+
+    private function extractTextFromMimeMessage(MimeMessage $message): ?string
+    {
+        foreach ($message->getParts() as $part) {
             if ($part->type === 'text/plain' && $part->disposition !== Mime::DISPOSITION_ATTACHMENT) {
                 return $part->getContent();
             }
         }
+        foreach ($message->getParts() as $part) {
+            if (in_array($part->type, self::MULTIPART_TYPES)) {
+                return $this->extractTextFromMimeMessage(
+                    MimeMessage::createFromMessage($part->getContent(), $part->boundary)
+                );
+            }
+        }
 
         return null;
     }
@@ -98,11 +120,23 @@ protected function extractHtml(Message $message): ?string
             return null;
         }
 
-        foreach ($body->getParts() as $part) {
+        return $this->extractHtmlFromMimeMessage($body);
+    }
+
+    private function extractHtmlFromMimeMessage(MimeMessage $message): ?string
+    {
+        foreach ($message->getParts() as $part) {
             if ($part->type === 'text/html' && $part->disposition !== Mime::DISPOSITION_ATTACHMENT) {
                 return $part->getContent();
             }
         }
+        foreach ($message->getParts() as $part) {
+            if (in_array($part->type, self::MULTIPART_TYPES)) {
+                return $this->extractHtmlFromMimeMessage(
+                    MimeMessage::createFromMessage($part->getContent(), $part->boundary)
+                );
+            }
+        }
 
         return null;
     }

diff --git a/tests/SlmMailTest/Service/AbstractMailServiceTest.php b/tests/SlmMailTest/Service/AbstractMailServiceTest.php
@@ -0,0 +1,179 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SlmMailTest\Service;
+
+use Laminas\Mail\Message;
+use Laminas\Mime\Message as MimeMessage;
+use Laminas\Mime\Mime;
+use Laminas\Mime\Part;
+use SlmMail\Service\AbstractMailService;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @covers \SlmMail\Service\AbstractMailService
+ */
+final class AbstractMailServiceTest extends TestCase
+{
+    private AbstractMailService $service;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->service = new class () extends AbstractMailService {
+            public ?string $text = null;
+            public ?string $html = null;
+            public array $attachments = [];
+
+            public function send(Message $message)
+            {
+                $this->text = $this->extractText($message);
+                $this->html = $this->extractHtml($message);
+                $this->attachments = $this->extractAttachments($message);
+            }
+        };
+    }
+
+    public function testExtractTextFromStringBodyReturnsString(): void
+    {
+        $expected = 'Foo';
+        $message = new Message();
+        $message->setBody($expected);
+
+        $this->service->send($message);
+        self::assertSame($expected, $this->service->text);
+    }
+
+    public function testExtractTextFromEmptyBodyReturnsNull(): void
+    {
+        $message = new Message();
+
+        $this->service->send($message);
+        self::assertNull($this->service->text);
+    }
+
+    public function testExtractTextFromTwoPartMessageReturnsString(): void
+    {
+        $expected = 'Foo';
+        $message = new Message();
+        $body = new MimeMessage();
+        $body->addPart(new Part(''));
+        $body->addPart(
+            (new Part($expected))
+                ->setType(Mime::TYPE_TEXT)
+        );
+        $message->setBody($body);
+
+        $this->service->send($message);
+        self::assertSame($expected, $this->service->text);
+    }
+
+    public function testExtractTextFromTextAttachmentReturnsNull(): void
+    {
+        $message = new Message();
+        $body = new MimeMessage();
+        $body->addPart(
+            (new Part('Foo'))
+                ->setType(Mime::TYPE_TEXT)
+                ->setDisposition(Mime::DISPOSITION_ATTACHMENT)
+        );
+        $message->setBody($body);
+
+        $this->service->send($message);
+        self::assertNull($this->service->text);
+    }
+
+    public function testExtractTextFromMultipartMessageReturnsString(): void
+    {
+        $expected = 'Foo';
+        $message = new Message();
+        $body = new MimeMessage();
+        $contentPart = new MimeMessage();
+        $contentPart->addPart(new Part());
+        $contentPart->addPart(
+            (new Part($expected))
+                ->setType(Mime::TYPE_TEXT)
+        );
+        $body->addPart(
+            (new Part($contentPart->generateMessage()))
+                ->setType(Mime::MULTIPART_ALTERNATIVE)
+                ->setBoundary($contentPart->getMime()->boundary())
+        );
+        $message->setBody($body);
+
+        $this->service->send($message);
+        self::assertSame($expected, trim($this->service->text));
+    }
+
+    public function testExtractHtmlFromStringBodyReturnsNull(): void
+    {
+        $message = new Message();
+        $message->setBody('Foo');
+
+        $this->service->send($message);
+        self::assertNull($this->service->html);
+    }
+
+    public function testExtractHtmlFromEmptyBodyReturnsNull(): void
+    {
+        $message = new Message();
+
+        $this->service->send($message);
+        self::assertNull($this->service->html);
+    }
+
+    public function testExtractHtmlFromTwoPartMessageReturnsString(): void
+    {
+        $expected = 'Foo';
+        $message = new Message();
+        $body = new MimeMessage();
+        $body->addPart(new Part(''));
+        $body->addPart(
+            (new Part($expected))
+                ->setType(Mime::TYPE_HTML)
+        );
+        $message->setBody($body);
+
+        $this->service->send($message);
+        self::assertSame($expected, $this->service->html);
+    }
+
+    public function testExtractHtmlFromHtmlAttachmentReturnsNull(): void
+    {
+        $message = new Message();
+        $body = new MimeMessage();
+        $body->addPart(
+            (new Part('Foo'))
+                ->setType(Mime::TYPE_HTML)
+                ->setDisposition(Mime::DISPOSITION_ATTACHMENT)
+        );
+        $message->setBody($body);
+
+        $this->service->send($message);
+        self::assertNull($this->service->html);
+    }
+
+    public function testExtractHtmlFromMultipartMessageReturnsString(): void
+    {
+        $expected = 'Foo';
+        $message = new Message();
+        $body = new MimeMessage();
+        $contentPart = new MimeMessage();
+        $contentPart->addPart(new Part());
+        $contentPart->addPart(
+            (new Part($expected))
+                ->setType(Mime::TYPE_HTML)
+        );
+        $body->addPart(
+            (new Part($contentPart->generateMessage()))
+                ->setType(Mime::MULTIPART_ALTERNATIVE)
+                ->setBoundary($contentPart->getMime()->boundary())
+        );
+        $message->setBody($body);
+
+        $this->service->send($message);
+        self::assertSame($expected, trim($this->service->html));
+    }
+}