bug #54837 [Mailer] [Sendgrid] Use DataPart::getContentId() when DataPart::setContentId() is used (SherinBloemendaal)

fabpot · fabpot · commit 68ffeba7bfb2 · 2024-05-07T08:11:34.000+02:00
This PR was merged into the 6.4 branch. Discussion ---------- [Mailer] [Sendgrid] Use `DataPart::getContentId()` when `DataPart::setContentId()` is used | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | See bellow | License | MIT Fixes the content identifier set via `DataPart::setContentId()` not being respected. Instead the `$filename` of the `DataPart` was being used resulting in unexpected behaviour. To provide backwards compatibility the `DataPart::hasContentId()` is being used to keep the current behaviour. Applied to 6.4 since `DataPart::setContentId()` was introduced in 6.2. Commits ------- 1211fbe [Mailer] [Sendgrid] Use DataPart::getContentId() when DataPart::setContentId() is used.
diff --git a/src/Symfony/Component/Mailer/Bridge/Sendgrid/Tests/Transport/SendgridApiTransportTest.php b/src/Symfony/Component/Mailer/Bridge/Sendgrid/Tests/Transport/SendgridApiTransportTest.php
@@ -245,4 +245,45 @@ public function testTagAndMetadataHeaders()
         $this->assertSame('blue', $payload['personalizations'][0]['custom_args']['Color']);
         $this->assertSame('12345', $payload['personalizations'][0]['custom_args']['Client-ID']);
     }
+
+    public function testInlineWithCustomContentId()
+    {
+        $imagePart = (new DataPart('text-contents', 'text.txt'));
+        $imagePart->asInline();
+        $imagePart->setContentId('content-identifier@symfony');
+
+        $email = new Email();
+        $email->addPart($imagePart);
+        $envelope = new Envelope(new Address('alice@system.com'), [new Address('bob@system.com')]);
+
+        $transport = new SendgridApiTransport('ACCESS_KEY');
+        $method = new \ReflectionMethod(SendgridApiTransport::class, 'getPayload');
+        $payload = $method->invoke($transport, $email, $envelope);
+
+        $this->assertArrayHasKey('attachments', $payload);
+        $this->assertCount(1, $payload['attachments']);
+        $this->assertArrayHasKey('content_id', $payload['attachments'][0]);
+
+        $this->assertSame('content-identifier@symfony', $payload['attachments'][0]['content_id']);
+    }
+
+    public function testInlineWithoutCustomContentId()
+    {
+        $imagePart = (new DataPart('text-contents', 'text.txt'));
+        $imagePart->asInline();
+
+        $email = new Email();
+        $email->addPart($imagePart);
+        $envelope = new Envelope(new Address('alice@system.com'), [new Address('bob@system.com')]);
+
+        $transport = new SendgridApiTransport('ACCESS_KEY');
+        $method = new \ReflectionMethod(SendgridApiTransport::class, 'getPayload');
+        $payload = $method->invoke($transport, $email, $envelope);
+
+        $this->assertArrayHasKey('attachments', $payload);
+        $this->assertCount(1, $payload['attachments']);
+        $this->assertArrayHasKey('content_id', $payload['attachments'][0]);
+
+        $this->assertSame('text.txt', $payload['attachments'][0]['content_id']);
+    }
 }
diff --git a/src/Symfony/Component/Mailer/Bridge/Sendgrid/Transport/SendgridApiTransport.php b/src/Symfony/Component/Mailer/Bridge/Sendgrid/Transport/SendgridApiTransport.php
@@ -179,7 +179,7 @@ private function getAttachments(Email $email): array
             ];
 
             if ('inline' === $disposition) {
-                $att['content_id'] = $filename;
+                $att['content_id'] = $attachment->hasContentId() ? $attachment->getContentId() : $filename;
             }
 
             $attachments[] = $att;

Original file line number	Diff line number	Diff line change
`@@ -179,7 +179,7 @@ private function getAttachments(Email $email): array`
`179`	`179`	`];`
`180`	`180`
`181`	`181`	`if ('inline' === $disposition) {`
`182`		`- $att['content_id'] = $filename;`
	`182`	`+ $att['content_id'] = $attachment->hasContentId() ? $attachment->getContentId() : $filename;`
`183`	`183`	`}`
`184`	`184`
`185`	`185`	`$attachments[] = $att;`