Changeset 38058

Timestamp:

07/13/2016 06:03:52 PM (8 years ago)

Author:

boonebgorges

Message:

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 #21659.

Location:

trunk

Files:

• src/wp-includes/pluggable.php (modified) (6 diffs)
• tests/phpunit/includes/mock-mailer.php (modified) (1 diff)
• tests/phpunit/tests/mail.php (modified) (1 diff)

trunk/src/wp-includes/pluggable.php

@@ -217 +217 @@
 
     // Headers
+    $cc = $bcc = $reply_to = array();
+
     if ( empty( $headers ) ) {
         $headers = array();
@@ -228 +230 @@
         }
         $headers = array();
-        $cc = array();
-        $bcc = array();
 
         // If it's actually got contents
@@ -292 +292 @@
                         $bcc = array_merge( (array) $bcc, explode( ',', $content ) );
                         break;
+                    case 'reply-to':
+                        $reply_to = array_merge( (array) $reply_to, explode( ',', $content ) );
+                        break;
                     default:
                         // Add it to our grand headers array
@@ -336 +339 @@
      * @param string $from_email Email address to send from.
      */
-    $phpmailer->From = apply_filters( 'wp_mail_from', $from_email );
+    $from_email = apply_filters( 'wp_mail_from', $from_email );
 
     /**
@@ -345 +348 @@
      * @param string $from_name Name associated with the "from" email address.
      */
-    $phpmailer->FromName = apply_filters( 'wp_mail_from_name', $from_name );
+    $from_name = apply_filters( 'wp_mail_from_name', $from_name );
+
+    $phpmailer->setFrom( $from_email, $from_name );
 
     // Set destination addresses
@@ -351 +356 @@
         $to = explode( ',', $to );
 
-    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;
-        }
-    }
-
     // Set mail's subject and body
     $phpmailer->Subject = $subject;
     $phpmailer->Body    = $message;
 
-    // Add any CC and BCC recipients
-    if ( !empty( $cc ) ) {
-        foreach ( (array) $cc as $recipient ) {
+    // 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;
+        }
+
+        foreach ( (array) $addresses as $address ) {
             try {
                 // Break $recipient into name and address parts if in the format "Foo <bar@baz.com>"
                 $recipient_name = '';
-                if ( preg_match( '/(.*)<(.+)>/', $recipient, $matches ) ) {
+
+                if ( preg_match( '/(.*)<(.+)>/', $address, $matches ) ) {
                     if ( count( $matches ) == 3 ) {
                         $recipient_name = $matches[1];
-                        $recipient = $matches[2];
+                        $address        = $matches[2];
                     }
                 }
-                $phpmailer->AddCc( $recipient, $recipient_name );
-            } catch ( phpmailerException $e ) {
-                continue;
-            }
-        }
-    }
-
-    if ( !empty( $bcc ) ) {
-        foreach ( (array) $bcc 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];
-                    }
+
+                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;
                 }
-                $phpmailer->AddBcc( $recipient, $recipient_name );
             } catch ( phpmailerException $e ) {
                 continue;

trunk/tests/phpunit/includes/mock-mailer.php

@@ -18 +18 @@
             'cc'      => $this->cc,
             'bcc'     => $this->bcc,
-            'header'  => $this->MIMEHeader,
+            'header'  => $this->MIMEHeader . $this->mailHeader,
             'subject' => $this->Subject,
             'body'    => $this->MIMEBody,

trunk/tests/phpunit/tests/mail.php

@@ -308 +308 @@
         $this->assertNotContains( 'quoted-printable', $GLOBALS['phpmailer']->mock_sent[0]['header'] );
     }
+
+    /**
+     * @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 ) );
+        }
+    }
 }