Changeset 60698 for trunk/tests/phpunit/tests/pluggable/wpMail.php

Timestamp:

09/01/2025 04:02:25 AM (3 months ago)

Author:

TimothyBlynJacobs

Message:

Mail: Support inline attachments.

MIME allows for referencing included attachments by their Content-ID header using the cid URL scheme. This can be used to embed images inline to the HTML message. For example, <img src="cid:logo">, will display the contents of message part with the Content-Id: <logo> header.

The wp_mail() function now supports including inline attachments through a new $embeds parameter. It accepts a map of Content-ID values to file paths. The wp_mail_embed_args filter can be used to customize the resulting PHPMailer::addEmbeddedImage method call.

Props jesin, swissspidy, chrisvendiadvertisingcom, SirLouen, mukesh27, yashjawale, iamadisingh.
Fixes #28059.

File:

• trunk/tests/phpunit/tests/pluggable/wpMail.php (modified) (1 diff)

trunk/tests/phpunit/tests/pluggable/wpMail.php

@@ -555 +555 @@
         $this->assertNotSame( 'user1', $phpmailer->AltBody );
     }
+
+    /**
+     * Test that wp_mail() can send embedded images.
+     *
+     * @ticket 28059
+     * @covers ::wp_mail
+     */
+    public function test_wp_mail_can_send_embedded_images() {
+        $embeds = array(
+            'canola' => DIR_TESTDATA . '/images/canola.jpg',
+            DIR_TESTDATA . '/images/test-image-2.gif',
+            DIR_TESTDATA . '/images/avif-lossy.avif',
+        );
+
+        $message = '';
+        foreach ( $embeds as $key => $path ) {
+            $message .= '<p><img src="cid:' . $key . '" alt="" /></p>';
+        }
+
+        wp_mail(
+            'user@example.org',
+            'Embedded images test',
+            $message,
+            'Content-Type: text/html',
+            array(),
+            $embeds
+        );
+
+        $mailer      = tests_retrieve_phpmailer_instance();
+        $attachments = $mailer->getAttachments();
+
+        foreach ( $attachments as $attachment ) {
+            $inline_embed_exists = in_array( $attachment[0], $embeds, true ) && 'inline' === $attachment[6];
+            $this->assertTrue( $inline_embed_exists, 'The attachment ' . $attachment[2] . ' is not inline in the embeds array.' );
+        }
+        foreach ( $embeds as $key => $path ) {
+            $this->assertStringContainsString( 'cid:' . $key, $mailer->get_sent()->body, 'The cid ' . $key . ' is not referenced in the mail body.' );
+        }
+    }
+    /**
+     * Test that wp_mail() can send embedded images as a multiple line string.
+     *
+     * @ticket 28059
+     * @covers ::wp_mail
+     */
+    public function test_wp_mail_string_embeds() {
+        $embeds  = DIR_TESTDATA . '/images/canola.jpg' . "\n";
+        $embeds .= DIR_TESTDATA . '/images/test-image-2.gif';
+
+        $message = '<p><img src="cid:0" alt="" /></p><p><img src="cid:1" alt="" /></p>';
+
+        wp_mail(
+            'user@example.org',
+            'Embedded images test',
+            $message,
+            'Content-Type: text/html',
+            array(),
+            $embeds
+        );
+
+        $embeds_array = explode( "\n", $embeds );
+        $mailer       = tests_retrieve_phpmailer_instance();
+        $attachments  = $mailer->getAttachments();
+
+        foreach ( $attachments as $attachment ) {
+            $inline_embed_exists = in_array( $attachment[0], $embeds_array, true ) && 'inline' === $attachment[6];
+            $this->assertTrue( $inline_embed_exists, 'The attachment ' . $attachment[2] . ' is not inline in the embeds array.' );
+        }
+        foreach ( $embeds_array as $key => $path ) {
+            $this->assertStringContainsString( 'cid:' . $key, $mailer->get_sent()->body, 'The cid ' . $key . ' is not referenced in the mail body.' );
+        }
+    }
 }