<!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>[38058] trunk: Mail: Improve handling of UTF-8 address headers.</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 { 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/38058">38058</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/38058","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-07-13 18:03:52 +0000 (Wed, 13 Jul 2016)</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: Improve handling of UTF-8 address headers.
Previously, `wp_mail()` implemented Reply-To as a generic header, using
PHPMailer's `addCustomHeader()`. As such, the email address portion of
the header was being incorrectly encoded when the name portion
contained UTF-8 characters. Switching to PHPMailer's more specific
`addReplyTo()` method fixes the issue.
For greater readability, the handling of all address-related headers
(To, CC, BCC, Reply-To) has been standardized.
Props szepe.viktor, iandunn, bpetty, stephenharris.
Fixes <a href="https://core.trac.wordpress.org/ticket/21659">#21659</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludespluggablephp">trunk/src/wp-includes/pluggable.php</a></li>
<li><a href="#trunktestsphpunitincludesmockmailerphp">trunk/tests/phpunit/includes/mock-mailer.php</a></li>
<li><a href="#trunktestsphpunittestsmailphp">trunk/tests/phpunit/tests/mail.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 2016-07-13 17:31:15 UTC (rev 38057)
+++ trunk/src/wp-includes/pluggable.php 2016-07-13 18:03:52 UTC (rev 38058)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -216,6 +216,8 @@
</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"> // Headers
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $cc = $bcc = $reply_to = array();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $headers ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $headers = array();
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -227,8 +229,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $tempheaders = $headers;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $headers = array();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $cc = array();
- $bcc = array();
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // If it's actually got contents
</span><span class="cx" style="display: block; padding: 0 10px"> if ( !empty( $tempheaders ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -291,6 +291,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> case 'bcc':
</span><span class="cx" style="display: block; padding: 0 10px"> $bcc = array_merge( (array) $bcc, explode( ',', $content ) );
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ case 'reply-to':
+ $reply_to = array_merge( (array) $reply_to, explode( ',', $content ) );
+ break;
</ins><span class="cx" style="display: block; padding: 0 10px"> default:
</span><span class="cx" style="display: block; padding: 0 10px"> // Add it to our grand headers array
</span><span class="cx" style="display: block; padding: 0 10px"> $headers[trim( $name )] = trim( $content );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -335,7 +338,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $from_email Email address to send from.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $phpmailer->From = apply_filters( 'wp_mail_from', $from_email );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $from_email = apply_filters( 'wp_mail_from', $from_email );
</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 the name to associate with the "from" email address.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -344,63 +347,52 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $from_name Name associated with the "from" email address.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $phpmailer->FromName = apply_filters( 'wp_mail_from_name', $from_name );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $from_name = apply_filters( 'wp_mail_from_name', $from_name );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $phpmailer->setFrom( $from_email, $from_name );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Set destination addresses
</span><span class="cx" style="display: block; padding: 0 10px"> if ( !is_array( $to ) )
</span><span class="cx" style="display: block; padding: 0 10px"> $to = explode( ',', $to );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( (array) $to as $recipient ) {
- try {
- // Break $recipient into name and address parts if in the format "Foo <bar@baz.com>"
- $recipient_name = '';
- if ( preg_match( '/(.*)<(.+)>/', $recipient, $matches ) ) {
- if ( count( $matches ) == 3 ) {
- $recipient_name = $matches[1];
- $recipient = $matches[2];
- }
- }
- $phpmailer->AddAddress( $recipient, $recipient_name);
- } catch ( phpmailerException $e ) {
- continue;
- }
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> // Set mail's subject and body
</span><span class="cx" style="display: block; padding: 0 10px"> $phpmailer->Subject = $subject;
</span><span class="cx" style="display: block; padding: 0 10px"> $phpmailer->Body = $message;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Add any CC and BCC recipients
- if ( !empty( $cc ) ) {
- foreach ( (array) $cc as $recipient ) {
- try {
- // Break $recipient into name and address parts if in the format "Foo <bar@baz.com>"
- $recipient_name = '';
- if ( preg_match( '/(.*)<(.+)>/', $recipient, $matches ) ) {
- if ( count( $matches ) == 3 ) {
- $recipient_name = $matches[1];
- $recipient = $matches[2];
- }
- }
- $phpmailer->AddCc( $recipient, $recipient_name );
- } catch ( phpmailerException $e ) {
- continue;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Use appropriate methods for handling addresses, rather than treating them as generic headers
+ $address_headers = compact( 'to', 'cc', 'bcc', 'reply_to' );
+
+ foreach ( $address_headers as $address_header => $addresses ) {
+ if ( empty( $addresses ) ) {
+ continue;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- }
</del><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( !empty( $bcc ) ) {
- foreach ( (array) $bcc as $recipient) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( (array) $addresses as $address ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> try {
</span><span class="cx" style="display: block; padding: 0 10px"> // Break $recipient into name and address parts if in the format "Foo <bar@baz.com>"
</span><span class="cx" style="display: block; padding: 0 10px"> $recipient_name = '';
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( preg_match( '/(.*)<(.+)>/', $recipient, $matches ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( preg_match( '/(.*)<(.+)>/', $address, $matches ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( count( $matches ) == 3 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $recipient_name = $matches[1];
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $recipient = $matches[2];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $address = $matches[2];
</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">- $phpmailer->AddBcc( $recipient, $recipient_name );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ switch ( $address_header ) {
+ case 'to':
+ $phpmailer->addAddress( $address, $recipient_name );
+ break;
+ case 'cc':
+ $phpmailer->addCc( $address, $recipient_name );
+ break;
+ case 'bcc':
+ $phpmailer->addBcc( $address, $recipient_name );
+ break;
+ case 'reply_to':
+ $phpmailer->addReplyTo( $address, $recipient_name );
+ break;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> } catch ( phpmailerException $e ) {
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunitincludesmockmailerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/includes/mock-mailer.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/mock-mailer.php 2016-07-13 17:31:15 UTC (rev 38057)
+++ trunk/tests/phpunit/includes/mock-mailer.php 2016-07-13 18:03:52 UTC (rev 38058)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -17,7 +17,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'to' => $this->to,
</span><span class="cx" style="display: block; padding: 0 10px"> 'cc' => $this->cc,
</span><span class="cx" style="display: block; padding: 0 10px"> 'bcc' => $this->bcc,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'header' => $this->MIMEHeader,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'header' => $this->MIMEHeader . $this->mailHeader,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'subject' => $this->Subject,
</span><span class="cx" style="display: block; padding: 0 10px"> 'body' => $this->MIMEBody,
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span></span></pre></div>
<a id="trunktestsphpunittestsmailphp"></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/mail.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/mail.php 2016-07-13 17:31:15 UTC (rev 38057)
+++ trunk/tests/phpunit/tests/mail.php 2016-07-13 18:03:52 UTC (rev 38058)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -307,4 +307,39 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertNotContains( 'quoted-printable', $GLOBALS['phpmailer']->mock_sent[0]['header'] );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @ticket 21659
+ */
+ public function test_wp_mail_addresses_arent_encoded() {
+ $to = 'Lukáš To <to@example.org>';
+ $subject = 'Testing #21659';
+ $message = 'Only the name should be encoded, not the address.';
+
+ $headers = array(
+ 'From' => 'From: Lukáš From <from@example.org>',
+ 'Cc' => 'Cc: Lukáš CC <cc@example.org>',
+ 'Bcc' => 'Bcc: Lukáš BCC <bcc@example.org>',
+ 'Reply-To' => 'Reply-To: Lukáš Reply-To <reply_to@example.org>',
+ );
+
+ $expected = array(
+ 'To' => 'To: =?UTF-8?B?THVrw6HFoSBUbw==?= <to@example.org>',
+ 'From' => 'From: =?UTF-8?Q?Luk=C3=A1=C5=A1_From?= <from@example.org>',
+ 'Cc' => 'Cc: =?UTF-8?B?THVrw6HFoSBDQw==?= <cc@example.org>',
+ 'Bcc' => 'Bcc: =?UTF-8?B?THVrw6HFoSBCQ0M=?= <bcc@example.org>',
+ 'Reply-To' => 'Reply-To: =?UTF-8?Q?Luk=C3=A1=C5=A1_Reply-To?= <reply_to@example.org>',
+ );
+
+ wp_mail( $to, $subject, $message, array_values( $headers ) );
+
+ $mailer = tests_retrieve_phpmailer_instance();
+ $sent_headers = preg_split( "/\r\n|\n|\r/", $mailer->get_sent()->header );
+ $headers['To'] = "To: $to";
+
+ foreach ( $headers as $header => $value ) {
+ $target_headers = preg_grep( "/^$header:/", $sent_headers );
+ $this->assertEquals( $expected[ $header ], array_pop( $target_headers ) );
+ }
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>