From aeab24a463bb611cf645e06547cb0de9221f25bf Mon Sep 17 00:00:00 2001 From: Fabien Potencier Date: Sun, 17 Jul 2022 19:33:15 +0200 Subject: [PATCH] [Mime] Fix inline parts when added via attachPart() --- src/Symfony/Component/Mime/Email.php | 26 +++-- .../Component/Mime/Tests/EmailTest.php | 102 +++++++++++++++--- 2 files changed, 108 insertions(+), 20 deletions(-) diff --git a/src/Symfony/Component/Mime/Email.php b/src/Symfony/Component/Mime/Email.php index d7cea51fb01de..29da5ef2fdcb9 100644 --- a/src/Symfony/Component/Mime/Email.php +++ b/src/Symfony/Component/Mime/Email.php @@ -507,25 +507,37 @@ private function prepareParts(): ?array $names = array_filter(array_unique(array_merge($names[2], $names[3]))); } + // usage of reflection is a temporary workaround for missing getters that will be added in 6.2 + $dispositionRef = new \ReflectionProperty(TextPart::class, 'disposition'); + $dispositionRef->setAccessible(true); + $nameRef = new \ReflectionProperty(TextPart::class, 'name'); + $nameRef->setAccessible(true); $attachmentParts = $inlineParts = []; foreach ($this->attachments as $attachment) { + $part = $this->createDataPart($attachment); + if (isset($attachment['part'])) { + $attachment['name'] = $nameRef->getValue($part); + } + foreach ($names as $name) { - if (isset($attachment['part'])) { - continue; - } if ($name !== $attachment['name']) { continue; } if (isset($inlineParts[$name])) { continue 2; } - $attachment['inline'] = true; - $inlineParts[$name] = $part = $this->createDataPart($attachment); + $part->setDisposition('inline'); $html = str_replace('cid:'.$name, 'cid:'.$part->getContentId(), $html); $part->setName($part->getContentId()); - continue 2; + + break; + } + + if ('inline' === $dispositionRef->getValue($part)) { + $inlineParts[$attachment['name']] = $part; + } else { + $attachmentParts[] = $part; } - $attachmentParts[] = $this->createDataPart($attachment); } if (null !== $htmlPart) { $htmlPart = new TextPart($html, $this->htmlCharset, 'html'); diff --git a/src/Symfony/Component/Mime/Tests/EmailTest.php b/src/Symfony/Component/Mime/Tests/EmailTest.php index 995771a67f520..a79a785576361 100644 --- a/src/Symfony/Component/Mime/Tests/EmailTest.php +++ b/src/Symfony/Component/Mime/Tests/EmailTest.php @@ -246,76 +246,116 @@ public function testGetBody() $this->assertEquals($text, $e->getBody()); } - public function testGenerateBody() + public function testGenerateBodyWithTextOnly() { $text = new TextPart('text content'); - $html = new TextPart('html content', 'utf-8', 'html'); - $att = new DataPart($file = fopen(__DIR__.'/Fixtures/mimetypes/test', 'r')); - $img = new DataPart($image = fopen(__DIR__.'/Fixtures/mimetypes/test.gif', 'r'), 'test.gif'); - $e = (new Email())->from('me@example.com')->to('you@example.com'); $e->text('text content'); $this->assertEquals($text, $e->getBody()); $this->assertEquals('text content', $e->getTextBody()); + } + public function testGenerateBodyWithHtmlOnly() + { + $html = new TextPart('html content', 'utf-8', 'html'); $e = (new Email())->from('me@example.com')->to('you@example.com'); $e->html('html content'); $this->assertEquals($html, $e->getBody()); $this->assertEquals('html content', $e->getHtmlBody()); + } + public function testGenerateBodyWithTextAndHtml() + { + $text = new TextPart('text content'); + $html = new TextPart('html content', 'utf-8', 'html'); $e = (new Email())->from('me@example.com')->to('you@example.com'); $e->html('html content'); $e->text('text content'); $this->assertEquals(new AlternativePart($text, $html), $e->getBody()); + } + public function testGenerateBodyWithTextAndHtmlNotUtf8() + { $e = (new Email())->from('me@example.com')->to('you@example.com'); $e->html('html content', 'iso-8859-1'); $e->text('text content', 'iso-8859-1'); $this->assertEquals('iso-8859-1', $e->getTextCharset()); $this->assertEquals('iso-8859-1', $e->getHtmlCharset()); $this->assertEquals(new AlternativePart(new TextPart('text content', 'iso-8859-1'), new TextPart('html content', 'iso-8859-1', 'html')), $e->getBody()); + } + public function testGenerateBodyWithTextContentAndAttachedFile() + { + [$text, $html, $filePart, $file, $imagePart, $image] = $this->generateSomeParts(); $e = (new Email())->from('me@example.com')->to('you@example.com'); $e->attach($file); $e->text('text content'); - $this->assertEquals(new MixedPart($text, $att), $e->getBody()); + $this->assertEquals(new MixedPart($text, $filePart), $e->getBody()); + } + public function testGenerateBodyWithHtmlContentAndAttachedFile() + { + [$text, $html, $filePart, $file, $imagePart, $image] = $this->generateSomeParts(); $e = (new Email())->from('me@example.com')->to('you@example.com'); $e->attach($file); $e->html('html content'); - $this->assertEquals(new MixedPart($html, $att), $e->getBody()); + $this->assertEquals(new MixedPart($html, $filePart), $e->getBody()); + } + public function testGenerateBodyWithAttachedFileOnly() + { + [$text, $html, $filePart, $file, $imagePart, $image] = $this->generateSomeParts(); $e = (new Email())->from('me@example.com')->to('you@example.com'); $e->attach($file); - $this->assertEquals(new MixedPart($att), $e->getBody()); + $this->assertEquals(new MixedPart($filePart), $e->getBody()); + } + public function testGenerateBodyWithTextAndHtmlContentAndAttachedFile() + { + [$text, $html, $filePart, $file, $imagePart, $image] = $this->generateSomeParts(); $e = (new Email())->from('me@example.com')->to('you@example.com'); $e->html('html content'); $e->text('text content'); $e->attach($file); - $this->assertEquals(new MixedPart(new AlternativePart($text, $html), $att), $e->getBody()); + $this->assertEquals(new MixedPart(new AlternativePart($text, $html), $filePart), $e->getBody()); + } + public function testGenerateBodyWithTextAndHtmlAndAttachedFileAndAttachedImageNotReferenced() + { + [$text, $html, $filePart, $file, $imagePart, $image] = $this->generateSomeParts(); $e = (new Email())->from('me@example.com')->to('you@example.com'); $e->html('html content'); $e->text('text content'); $e->attach($file); $e->attach($image, 'test.gif'); - $this->assertEquals(new MixedPart(new AlternativePart($text, $html), $att, $img), $e->getBody()); + $this->assertEquals(new MixedPart(new AlternativePart($text, $html), $filePart, $imagePart), $e->getBody()); + } + public function testGenerateBodyWithTextAndAttachedFileAndAttachedImageNotReferenced() + { + [$text, $html, $filePart, $file, $imagePart, $image] = $this->generateSomeParts(); $e = (new Email())->from('me@example.com')->to('you@example.com'); $e->text('text content'); $e->attach($file); $e->attach($image, 'test.gif'); - $this->assertEquals(new MixedPart($text, $att, $img), $e->getBody()); + $this->assertEquals(new MixedPart($text, $filePart, $imagePart), $e->getBody()); + } + public function testGenerateBodyWithTextAndHtmlAndAttachedFileAndAttachedImageNotReferencedViaCid() + { + [$text, $html, $filePart, $file, $imagePart, $image] = $this->generateSomeParts(); $e = (new Email())->from('me@example.com')->to('you@example.com'); $e->html($content = 'html content '); $e->text('text content'); $e->attach($file); $e->attach($image, 'test.gif'); $fullhtml = new TextPart($content, 'utf-8', 'html'); - $this->assertEquals(new MixedPart(new AlternativePart($text, $fullhtml), $att, $img), $e->getBody()); + $this->assertEquals(new MixedPart(new AlternativePart($text, $fullhtml), $filePart, $imagePart), $e->getBody()); + } + public function testGenerateBodyWithTextAndHtmlAndAttachedFileAndAttachedImageReferencedViaCid() + { + [$text, $html, $filePart, $file, $imagePart, $image] = $this->generateSomeParts(); $e = (new Email())->from('me@example.com')->to('you@example.com'); $e->html($content = 'html content '); $e->text('text content'); @@ -325,12 +365,35 @@ public function testGenerateBody() $this->assertInstanceOf(MixedPart::class, $body); $this->assertCount(2, $related = $body->getParts()); $this->assertInstanceOf(RelatedPart::class, $related[0]); - $this->assertEquals($att, $related[1]); + $this->assertEquals($filePart, $related[1]); $this->assertCount(2, $parts = $related[0]->getParts()); $this->assertInstanceOf(AlternativePart::class, $parts[0]); $generatedHtml = $parts[0]->getParts()[1]; $this->assertStringContainsString('cid:'.$parts[1]->getContentId(), $generatedHtml->getBody()); + } + public function testGenerateBodyWithTextAndHtmlAndAttachedFileAndAttachedImagePartAsInlineReferencedViaCid() + { + [$text, $html, $filePart, $file, $imagePart, $image] = $this->generateSomeParts(); + $e = (new Email())->from('me@example.com')->to('you@example.com'); + $e->html($content = 'html content '); + $e->text('text content'); + $e->attach($file); + $e->attachPart((new DataPart($image, 'test.gif'))->asInline()); + $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]); + $generatedHtml = $parts[0]->getParts()[1]; + $this->assertStringContainsString('cid:'.$parts[1]->getContentId(), $generatedHtml->getBody()); + } + + public function testGenerateBodyWithHtmlAndInlinedImageTwiceReferencedViaCid() + { + // inline image (twice) referenced in the HTML content $content = 'html content '; $r = fopen('php://memory', 'r+', false); fwrite($r, $content); @@ -339,6 +402,7 @@ public function testGenerateBody() $e = (new Email())->from('me@example.com')->to('you@example.com'); $e->html($r); // embedding the same image twice results in one image only in the email + $image = fopen(__DIR__.'/Fixtures/mimetypes/test.gif', 'r'); $e->embed($image, 'test.gif'); $e->embed($image, 'test.gif'); $body = $e->getBody(); @@ -348,8 +412,19 @@ public function testGenerateBody() $this->assertStringMatchesFormat('html content ', $parts[0]->bodyToString()); } + private function generateSomeParts(): array + { + $text = new TextPart('text content'); + $html = new TextPart('html content', 'utf-8', 'html'); + $filePart = new DataPart($file = fopen(__DIR__.'/Fixtures/mimetypes/test', 'r')); + $imagePart = new DataPart($image = fopen(__DIR__.'/Fixtures/mimetypes/test.gif', 'r'), 'test.gif'); + + return [$text, $html, $filePart, $file, $imagePart, $image]; + } + public function testAttachments() { + // inline part $contents = file_get_contents($name = __DIR__.'/Fixtures/mimetypes/test', 'r'); $att = new DataPart($file = fopen($name, 'r'), 'test'); $inline = (new DataPart($contents, 'test'))->asInline(); @@ -358,6 +433,7 @@ public function testAttachments() $e->embed($contents, 'test'); $this->assertEquals([$att, $inline], $e->getAttachments()); + // inline part from path $att = DataPart::fromPath($name, 'test'); $inline = DataPart::fromPath($name, 'test')->asInline(); $e = new Email();