Changeset 53900

Timestamp:

08/16/2022 06:16:43 PM (2 years ago)

Author:

desrosj

Message:

Mail: Prevent the last character of names in “From” headers from being trimmed.

When extracting the email and name from a “From” header, the last character of the name is incorrectly trimmed when a space is not included between the name and the opening <.

Though the space is required for the header to be compliant with RFC5322 (see ​https://www.rfc-editor.org/rfc/rfc5322#section-3.4), the absence of a space can be ignored here. PHPMailer accepts the name and email as separate parameters and constructs the header correctly later on.

Props hakanca, mikehansenme, SergeyBiryukov, kovshenin, mattyrob, drewapicture, desrosj.
Fixes #19847.

Location:

trunk

Files:

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

trunk/src/wp-includes/pluggable.php

@@ -308 +308 @@
                                 // Text before the bracketed email is the "From" name.
                                 if ( $bracket_pos > 0 ) {
-                                    $from_name = substr( $content, 0, $bracket_pos - 1 );
+                                    $from_name = substr( $content, 0, $bracket_pos );
                                     $from_name = str_replace( '"', '', $from_name );
                                     $from_name = trim( $from_name );

trunk/tests/phpunit/tests/mail.php

@@ -195 +195 @@
 
     /**
+     * @ticket 19847
+     */
+    public function test_wp_mail_with_from_header_missing_space() {
+        $to        = 'address@tld.com';
+        $subject   = 'Testing';
+        $message   = 'Test Message';
+        $from      = 'bar@example.com';
+        $from_name = 'Foo';
+        $headers   = "From: {$from_name}<{$from}>";
+        $corrected = "From: {$from_name} <{$from}>";
+
+        wp_mail( $to, $subject, $message, $headers );
+
+        $mailer = tests_retrieve_phpmailer_instance();
+        // phpcs:disable WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+        $this->assertSame( $from, $mailer->From );
+        $this->assertSame( $from_name, $mailer->FromName );
+        // phpcs:enable
+        $this->assertStringContainsString( $corrected, $mailer->get_sent()->header );
+    }
+
+    /**
      * @ticket 30266
      */