<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[60698] trunk: Mail: Support inline attachments.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/60698">60698</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/60698","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>TimothyBlynJacobs</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2025-09-01 04:02:25 +0000 (Mon, 01 Sep 2025)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/28059">#28059</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludespluggablephp">trunk/src/wp-includes/pluggable.php</a></li>
<li><a href="#trunktestsphpunittestspluggablesignaturesphp">trunk/tests/phpunit/tests/pluggable/signatures.php</a></li>
<li><a href="#trunktestsphpunittestspluggablewpMailphp">trunk/tests/phpunit/tests/pluggable/wpMail.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludespluggablephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/pluggable.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/pluggable.php 2025-08-31 21:41:54 UTC (rev 60697)
+++ trunk/src/wp-includes/pluggable.php 2025-09-01 04:02:25 UTC (rev 60698)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -158,9 +158,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * The default charset is based on the charset used on the blog. The charset can
</span><span class="cx" style="display: block; padding: 0 10px"> * be set using the {@see 'wp_mail_charset'} filter.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * When using the `$embeds` parameter to embed images for use in HTML emails,
+ * reference the embedded file in your HTML with a `cid:` URL whose value
+ * matches the file's Content-ID. By default, the Content-ID (`cid`) used for
+ * each embedded file is the key in the embeds array, unless modified via the
+ * {@see 'wp_mail_embed_args'} filter. For example:
+ *
+ * `<img src="cid:0" alt="Logo">`
+ * `<img src="cid:my-image" alt="Image">`
+ *
+ * You may also customize the Content-ID for each file by using the
+ * {@see 'wp_mail_embed_args'} filter and setting the `cid` value.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 1.2.1
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0 is_email() is used for email validation,
</span><span class="cx" style="display: block; padding: 0 10px"> * instead of PHPMailer's default validator.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.9.0 Added $embeds parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global PHPMailer\PHPMailer\PHPMailer $phpmailer
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -169,9 +182,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $message Message contents.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|string[] $headers Optional. Additional headers.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|string[] $attachments Optional. Paths to files to attach.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string|string[] $embeds Optional. Paths to files to embed.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool Whether the email was sent successfully.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function wp_mail( $to, $subject, $message, $headers = '', $attachments = array() ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function wp_mail( $to, $subject, $message, $headers = '', $attachments = array(), $embeds = array() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> // Compact the input, apply the filters, and extract them back out.
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -187,9 +201,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $message Message contents.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string|string[] $headers Additional headers.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string|string[] $attachments Paths to files to attach.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string|string[] $embeds Paths to files to embed.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $atts = apply_filters( 'wp_mail', compact( 'to', 'subject', 'message', 'headers', 'attachments' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $atts = apply_filters( 'wp_mail', compact( 'to', 'subject', 'message', 'headers', 'attachments', 'embeds' ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters whether to preempt sending an email.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -209,6 +224,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $message Message contents.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string|string[] $headers Additional headers.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string|string[] $attachments Paths to files to attach.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string|string[] $embeds Paths to files to embed.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $pre_wp_mail = apply_filters( 'pre_wp_mail', null, $atts );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -244,6 +260,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_array( $attachments ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $attachments = explode( "\n", str_replace( "\r\n", "\n", $attachments ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( isset( $atts['embeds'] ) ) {
+ $embeds = $atts['embeds'];
+ }
+
+ if ( ! is_array( $embeds ) ) {
+ $embeds = explode( "\n", str_replace( "\r\n", "\n", $embeds ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> global $phpmailer;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // (Re)create it, if it's gone missing.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -531,6 +556,50 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $embeds ) ) {
+ foreach ( $embeds as $key => $embed_path ) {
+ /**
+ * Filters the arguments for PHPMailer's addEmbeddedImage() method.
+ *
+ * @since 6.9.0
+ *
+ * @param array $args {
+ * An array of arguments for `addEmbeddedImage()`.
+ * @type string $path The path to the file.
+ * @type string $cid The Content-ID of the image. Default: The key in the embeds array.
+ * @type string $name The filename of the image.
+ * @type string $encoding The encoding of the image. Default: 'base64'.
+ * @type string $type The MIME type of the image. Default: empty string, which lets PHPMailer auto-detect.
+ * @type string $disposition The disposition of the image. Default: 'inline'.
+ * }
+ */
+ $embed_args = apply_filters(
+ 'wp_mail_embed_args',
+ array(
+ 'path' => $embed_path,
+ 'cid' => (string) $key,
+ 'name' => basename( $embed_path ),
+ 'encoding' => 'base64',
+ 'type' => '',
+ 'disposition' => 'inline',
+ )
+ );
+
+ try {
+ $phpmailer->addEmbeddedImage(
+ $embed_args['path'],
+ $embed_args['cid'],
+ $embed_args['name'],
+ $embed_args['encoding'],
+ $embed_args['type'],
+ $embed_args['disposition']
+ );
+ } catch ( PHPMailer\PHPMailer\Exception $e ) {
+ continue;
+ }
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Fires after PHPMailer is initialized.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -563,6 +632,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $message Message contents.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string[] $headers Additional headers.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string[] $attachments Paths to files to attach.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string[] $embeds Paths to files to embed.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> do_action( 'wp_mail_succeeded', $mail_data );
</span></span></pre></div>
<a id="trunktestsphpunittestspluggablesignaturesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/pluggable/signatures.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/pluggable/signatures.php 2025-08-31 21:41:54 UTC (rev 60697)
+++ trunk/tests/phpunit/tests/pluggable/signatures.php 2025-09-01 04:02:25 UTC (rev 60698)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -137,6 +137,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'message',
</span><span class="cx" style="display: block; padding: 0 10px"> 'headers' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'attachments' => array(),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'embeds' => array(),
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'wp_authenticate' => array( 'username', 'password' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'wp_logout' => array(),
</span></span></pre></div>
<a id="trunktestsphpunittestspluggablewpMailphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/pluggable/wpMail.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/pluggable/wpMail.php 2025-08-31 21:41:54 UTC (rev 60697)
+++ trunk/tests/phpunit/tests/pluggable/wpMail.php 2025-09-01 04:02:25 UTC (rev 60698)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -554,4 +554,76 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $phpmailer = $GLOBALS['phpmailer'];
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertNotSame( 'user1', $phpmailer->AltBody );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * 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.' );
+ }
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>