Merge pull request #174 from danielabyan/feature/fold-header-properly

Fold a string with the correct length

Author: Slamdunk

composer.json

@@ -11,7 +11,7 @@
         "php": "~8.0.0 || ~8.1.0",
         "ext-iconv": "*",
         "laminas/laminas-loader": "^2.8.0",
-        "laminas/laminas-mime": "^2.9.1",
+        "laminas/laminas-mime": "^2.10.0",
         "laminas/laminas-stdlib": "^3.11.0",
         "laminas/laminas-validator": "^2.23.0",
         "symfony/polyfill-mbstring": "^1.16.0",

composer.lock

@@ -12,9 +12,11 @@
 use function iconv_mime_encode;
 use function implode;
 use function str_contains;
+use function str_pad;
 use function str_starts_with;
 use function strlen;
 use function strpos;
+use function substr;
 use function wordwrap;
 
 use const ICONV_MIME_DECODE_CONTINUE_ON_ERROR;
@@ -52,11 +54,23 @@ public static function wrap($value, HeaderInterface $header)
      */
     protected static function wrapUnstructuredHeader($value, HeaderInterface $header)
     {
-        $encoding = $header->getEncoding();
+        $headerNameColonSize = strlen($header->getFieldName() . ': ');
+        $encoding            = $header->getEncoding();
+
         if ($encoding == 'ASCII') {
-            return wordwrap($value, 78, Headers::FOLDING);
+            /*
+             * Before folding the header line, it is necessary to calculate the length of the
+             * entire header (including the name and colon). We need to put a stub at the
+             * beginning of the value so that the folding is performed correctly.
+             */
+            $headerLine       = str_pad('0', $headerNameColonSize, '0') . $value;
+            $foldedHeaderLine = wordwrap($headerLine, 78, Headers::FOLDING);
+
+            // Remove the stub and return the header folded value.
+            return substr($foldedHeaderLine, $headerNameColonSize);
         }
-        return static::mimeEncodeValue($value, $encoding, 78);
+
+        return static::mimeEncodeValue($value, $encoding, 78, $headerNameColonSize);
     }
 
     /**
@@ -88,14 +102,19 @@ protected static function wrapStructuredHeader($value, StructuredInterface $head
      * Performs quoted-printable encoding on a value, setting maximum
      * line-length to 998.
      *
-     * @param  string $value
-     * @param  string $encoding
-     * @param  int    $lineLength maximum line-length, by default 998
+     * @param string            $value
+     * @param string            $encoding
+     * @param int               $lineLength         Maximum line-length, by default 998
+     * @param positive-int|0    $firstLineGapSize   When folding a line, it is necessary to calculate
+     *                                              the length of the entire line (together with the
+     *                                              header name). Therefore, you can specify the header
+     *                                              name and colon length in this argument to fold the
+     *                                              string properly.
      * @return string Returns the mime encode value without the last line ending
      */
-    public static function mimeEncodeValue($value, $encoding, $lineLength = 998)
+    public static function mimeEncodeValue($value, $encoding, $lineLength = 998, $firstLineGapSize = 0)
     {
-        return Mime::encodeQuotedPrintableHeader($value, $encoding, $lineLength, Headers::EOL);
+        return Mime::encodeQuotedPrintableHeader($value, $encoding, $lineLength, Headers::EOL, $firstLineGapSize);
     }
 
     /**

src/Header/HeaderWrap.php

@@ -7,7 +7,6 @@
 use PHPUnit\Framework\TestCase;
 
 use function str_repeat;
-use function wordwrap;
 
 /**
  * @group      Laminas_Mail
@@ -21,7 +20,10 @@ public function testHeaderFolding(): void
         $subject = new Header\Subject();
         $subject->setSubject($string);
 
-        $expected = wordwrap($string, 78, "\r\n ");
+        $expected = "foobarblahblahblah baz batfoobarblahblahblah baz\r\n "
+                    . "batfoobarblahblahblah baz batfoobarblahblahblah baz batfoobarblahblahblah baz\r\n "
+                    . "batfoobarblahblahblah baz batfoobarblahblahblah baz batfoobarblahblahblah baz\r\n "
+                    . "batfoobarblahblahblah baz batfoobarblahblahblah baz bat";
         $test     = $subject->getFieldValue(Header\HeaderInterface::FORMAT_ENCODED);
         $this->assertEquals($expected, $test);
     }

test/Header/SubjectTest.php

@@ -884,8 +884,8 @@ public function testMessageSubjectFromString(): void
         $mail       = Message::fromString($rawMessage);
 
         $this->assertStringContainsString(
-            'Subject: =?UTF-8?Q?Non=20=E2=80=9Cascii=E2=80=9D=20characters=20like=20accented=20?=' . "\r\n"
-            . ' =?UTF-8?Q?vowels=20=C3=B2=C3=A0=C3=B9=C3=A8=C3=A9=C3=AC?=' . "\r\n",
+            'Subject: =?UTF-8?Q?Non=20=E2=80=9Cascii=E2=80=9D=20characters=20like=20?=' . "\r\n"
+            . ' =?UTF-8?Q?accented=20vowels=20=C3=B2=C3=A0=C3=B9=C3=A8=C3=A9=C3=AC?=' . "\r\n",
             $mail->toString()
         );
     }
@@ -896,8 +896,8 @@ public function testMessageSubjectSetSubject(): void
         $mail->setSubject('Non “ascii” characters like accented vowels òàùèéì');
 
         $this->assertStringContainsString(
-            'Subject: =?UTF-8?Q?Non=20=E2=80=9Cascii=E2=80=9D=20characters=20like=20accented=20?=' . "\r\n"
-            . ' =?UTF-8?Q?vowels=20=C3=B2=C3=A0=C3=B9=C3=A8=C3=A9=C3=AC?=' . "\r\n",
+            'Subject: =?UTF-8?Q?Non=20=E2=80=9Cascii=E2=80=9D=20characters=20like=20?=' . "\r\n"
+            . ' =?UTF-8?Q?accented=20vowels=20=C3=B2=C3=A0=C3=B9=C3=A8=C3=A9=C3=AC?=' . "\r\n",
             $mail->toString()
         );
     }
@@ -909,8 +909,8 @@ public function testCorrectHeaderEncodingAddHeader(): void
         $mail->getHeaders()->addHeader($header);
 
         $this->assertStringContainsString(
-            'X-Test: =?UTF-8?Q?Non=20=E2=80=9Cascii=E2=80=9D=20characters=20like=20accented=20?=' . "\r\n"
-            . ' =?UTF-8?Q?vowels=20=C3=B2=C3=A0=C3=B9=C3=A8=C3=A9=C3=AC?=' . "\r\n",
+            'X-Test: =?UTF-8?Q?Non=20=E2=80=9Cascii=E2=80=9D=20characters=20like=20?=' . "\r\n"
+            . ' =?UTF-8?Q?accented=20vowels=20=C3=B2=C3=A0=C3=B9=C3=A8=C3=A9=C3=AC?=' . "\r\n",
             $mail->toString()
         );
     }
@@ -924,8 +924,8 @@ public function testCorrectHeaderEncodingSetHeaders(): void
         $mail->setHeaders($headers);
 
         $this->assertStringContainsString(
-            'X-Test: =?UTF-8?Q?Non=20=E2=80=9Cascii=E2=80=9D=20characters=20like=20accented=20?=' . "\r\n"
-            . ' =?UTF-8?Q?vowels=20=C3=B2=C3=A0=C3=B9=C3=A8=C3=A9=C3=AC?=' . "\r\n",
+            'X-Test: =?UTF-8?Q?Non=20=E2=80=9Cascii=E2=80=9D=20characters=20like=20?=' . "\r\n"
+            . ' =?UTF-8?Q?accented=20vowels=20=C3=B2=C3=A0=C3=B9=C3=A8=C3=A9=C3=AC?=' . "\r\n",
             $mail->toString()
         );
     }
@@ -939,8 +939,8 @@ public function testCorrectHeaderEncodingFromString(): void
         $mail->getHeaders()->addHeader($header);
 
         $this->assertStringContainsString(
-            'X-Test: =?UTF-8?Q?Non=20=E2=80=9Cascii=E2=80=9D=20characters=20like=20accented=20?=' . "\r\n"
-            . ' =?UTF-8?Q?vowels=20=C3=B2=C3=A0=C3=B9=C3=A8=C3=A9=C3=AC?=' . "\r\n",
+            'X-Test: =?UTF-8?Q?Non=20=E2=80=9Cascii=E2=80=9D=20characters=20like=20?=' . "\r\n"
+            . ' =?UTF-8?Q?accented=20vowels=20=C3=B2=C3=A0=C3=B9=C3=A8=C3=A9=C3=AC?=',
             $mail->toString()
         );
     }
@@ -957,8 +957,8 @@ public function testCorrectHeaderEncodingFromStringAndSetHeaders(): void
         $mail->setHeaders($headers);
 
         $this->assertStringContainsString(
-            'X-Test: =?UTF-8?Q?Non=20=E2=80=9Cascii=E2=80=9D=20characters=20like=20accented=20?=' . "\r\n"
-            . ' =?UTF-8?Q?vowels=20=C3=B2=C3=A0=C3=B9=C3=A8=C3=A9=C3=AC?=' . "\r\n",
+            'X-Test: =?UTF-8?Q?Non=20=E2=80=9Cascii=E2=80=9D=20characters=20like=20?=' . "\r\n"
+            . ' =?UTF-8?Q?accented=20vowels=20=C3=B2=C3=A0=C3=B9=C3=A8=C3=A9=C3=AC?=',
             $mail->toString()
         );
     }