feature #48901 Allow Usage of ContentId in html (m42e)

fabpot · fabpot · commit 0aa12cdcde5d · 2023-01-09T18:57:45.000+01:00
This PR was merged into the 6.3 branch. Discussion ---------- Allow Usage of ContentId in html Detect usage of Content-Id in html and mark part as related, just as it would happen with a `cid:<name>` reference. | Q | A | ------------- | --- | Branch? | 6.3  | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | | License | MIT | Doc PR | -  Assumed you have a defined `Content-Id` for your attachment, as you modify and forward an id. The HTML part will already contain the reference to that id in the `cid:` reference. Which means the name is no longer part of the html body. In this case it is currently not detected that the parts are related to each other. This will be improved with this PR. I do not consider it a bug fix. The feature has a very special use case. If you consider otherwise, let me know and I will create a PR against the maintenance branch. (I already have one prepared: https://github.com/m42e/symfony/tree/allow-usage-of-content-id-in-html-5.4 Which means the feature/fix would reach more people. Please let me know what you think.) Commits ------- a5e4fc2 Allow Usage of ContentId in html
diff --git a/src/Symfony/Component/Mime/CHANGELOG.md b/src/Symfony/Component/Mime/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+6.3
+---
+
+ * Support detection of related parts if `Content-Id` is used instead of the name
+
 6.2
 ---
 
diff --git a/src/Symfony/Component/Mime/Email.php b/src/Symfony/Component/Mime/Email.php
@@ -492,14 +492,16 @@ private function prepareParts(): ?array
         $otherParts = $relatedParts = [];
         foreach ($this->attachments as $part) {
             foreach ($names as $name) {
-                if ($name !== $part->getName()) {
+                if ($name !== $part->getName() && (!$part->hasContentId() || $name !== $part->getContentId())) {
                     continue;
                 }
                 if (isset($relatedParts[$name])) {
                     continue 2;
                 }
 
-                $html = str_replace('cid:'.$name, 'cid:'.$part->getContentId(), $html, $count);
+                if ($name !== $part->getContentId()) {
+                    $html = str_replace('cid:'.$name, 'cid:'.$part->getContentId(), $html, $count);
+                }
                 $relatedParts[$name] = $part;
                 $part->setName($part->getContentId())->asInline();
 
diff --git a/src/Symfony/Component/Mime/Tests/EmailTest.php b/src/Symfony/Component/Mime/Tests/EmailTest.php
@@ -409,6 +409,24 @@ public function testGenerateBodyWithTextAndHtmlAndAttachedFileAndAttachedImageRe
         $this->assertStringContainsString('cid:'.$parts[1]->getContentId(), $generatedHtml->getBody());
     }
 
+    public function testGenerateBodyWithTextAndHtmlAndAttachedFileAndAttachedImageReferencedViaCidAndContentId()
+    {
+        [$text, $html, $filePart, $file, $imagePart, $image] = $this->generateSomeParts();
+        $e = (new Email())->from('me@example.com')->to('you@example.com');
+        $e->text('text content');
+        $e->addPart(new DataPart($file));
+        $img = new DataPart($image, 'test.gif');
+        $e->addPart($img);
+        $e->html($content = 'html content <img src="cid:'.$img->getContentId().'">');
+        $body = $e->getBody();
+        $this->assertInstanceOf(MixedPart::class, $body);
+        $this->assertCount(2, $related = $body->getParts());
+        $this->assertInstanceOf(RelatedPart::class, $related[0]);
+        $this->assertEquals($filePart, $related[1]);
+        $this->assertCount(2, $parts = $related[0]->getParts());
+        $this->assertInstanceOf(AlternativePart::class, $parts[0]);
+    }
+
     public function testGenerateBodyWithHtmlAndInlinedImageTwiceReferencedViaCid()
     {
         // inline image (twice) referenced in the HTML content
