feat: support custom encoders in mime parts

KDederichs · KDederichs · commit 620d5615efe5 · 2024-05-17T17:15:10.000+02:00
diff --git a/src/Symfony/Component/Mime/Part/TextPart.php b/src/Symfony/Component/Mime/Part/TextPart.php
@@ -63,9 +63,6 @@ public function __construct($body, ?string $charset = 'utf-8', string $subtype =
         if (null === $encoding) {
             $this->encoding = $this->chooseEncoding();
         } else {
-            if ('quoted-printable' !== $encoding && 'base64' !== $encoding && '8bit' !== $encoding) {
-                throw new InvalidArgumentException(sprintf('The encoding must be one of "quoted-printable", "base64", or "8bit" ("%s" given).', $encoding));
-            }
             $this->encoding = $encoding;
         }
     }
@@ -199,6 +196,10 @@ public function asDebugString(): string
 
     private function getEncoder(): ContentEncoderInterface
     {
+        if ('quoted-printable' !== $this->encoding && 'base64' !== $this->encoding && '8bit' !== $this->encoding && !\array_key_exists($this->encoding, self::$encoders)) {
+            throw new InvalidArgumentException('The encoding must be one of "quoted-printable", "base64", or "8bit" unless you provide a custom encoder.');
+        }
+
         if ('8bit' === $this->encoding) {
             return self::$encoders[$this->encoding] ??= new EightBitContentEncoder();
         }
@@ -207,7 +208,18 @@ private function getEncoder(): ContentEncoderInterface
             return self::$encoders[$this->encoding] ??= new QpContentEncoder();
         }
 
-        return self::$encoders[$this->encoding] ??= new Base64ContentEncoder();
+        if ('base64' === $this->encoding) {
+            return self::$encoders[$this->encoding] ??= new Base64ContentEncoder();
+        }
+
+        return self::$encoders[$this->encoding];
+    }
+
+    public function addEncoder(string $name, ContentEncoderInterface $encoder): static
+    {
+        self::$encoders[$name] = $encoder;
+
+        return $this;
     }
 
     private function chooseEncoding(): string
diff --git a/src/Symfony/Component/Mime/Tests/Part/TextPartTest.php b/src/Symfony/Component/Mime/Tests/Part/TextPartTest.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Mime\Tests\Part;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\Mime\Encoder\ContentEncoderInterface;
 use Symfony\Component\Mime\Header\Headers;
 use Symfony\Component\Mime\Header\ParameterizedHeader;
 use Symfony\Component\Mime\Header\UnstructuredHeader;
@@ -87,6 +88,35 @@ public function testEncoding()
         ), $p->getPreparedHeaders());
     }
 
+    public function testCustomEncoding()
+    {
+        $p = new TextPart('content', 'utf-8', 'plain', 'test_encoding');
+        $p->addEncoder('test_encoding', new class() implements ContentEncoderInterface {
+            public function encodeByteStream($stream, int $maxLineLength = 0): iterable
+            {
+                while (!feof($stream)) {
+                    yield fread($stream, 16372);
+                }
+            }
+
+            public function getName(): string
+            {
+                return 'test_encoding';
+            }
+
+            public function encodeString(string $string, ?string $charset = 'utf-8', int $firstLineOffset = 0, int $maxLineLength = 0): string
+            {
+                return $string;
+            }
+        });
+        $this->assertEquals('content', $p->bodyToString());
+        $this->assertEquals('content', implode('', iterator_to_array($p->bodyToIterable())));
+        $this->assertEquals(new Headers(
+            new ParameterizedHeader('Content-Type', 'text/plain', ['charset' => 'utf-8']),
+            new UnstructuredHeader('Content-Transfer-Encoding', 'test_encoding')
+        ), $p->getPreparedHeaders());
+    }
+
     public function testSerialize()
     {
         $r = fopen('php://memory', 'r+', false);
