#444 improve decoding of recipient addresses, properly handling delimitation

Author: bbottema

modules/simple-java-mail/src/main/java/org/simplejavamail/converter/internal/mimemessage/MimeMessageParser.java

@@ -45,6 +45,7 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
+import static com.pivovarit.function.ThrowingFunction.unchecked;
 import static java.lang.String.format;
 import static java.nio.charset.StandardCharsets.UTF_8;
 import static java.util.Optional.ofNullable;
@@ -471,10 +472,14 @@ public static Address[] retrieveRecipients(@NotNull final MimeMessage mimeMessag
 		try {
 			// return mimeMessage.getRecipients(recipientType); // can fail in strict mode, see https://github.com/bbottema/simple-java-mail/issues/227
 			// workaround following (copied and modified from JavaMail internal code):
-			val s = ofNullable(mimeMessage.getHeader(getHeaderName(recipientType), ","))
-					.map(MimeMessageParser::decodeText)
+			// and while we're at it, properly decode the personal names
+			val recipientHeader = mimeMessage.getHeader(getHeaderName(recipientType), ",");
+			return ofNullable(recipientHeader)
+					.map(unchecked(h -> InternetAddress.parseHeader(h, false)))
+					.map(ias -> Arrays.stream(ias)
+							.map(unchecked(ia -> new InternetAddress(ia.getAddress(), decodePersonalName(ia.getPersonal()))))
+							.toArray(Address[]::new))
 					.orElse(null);
-			return (s == null) ? null : InternetAddress.parseHeader(s, false);
 		} catch (final MessagingException e) {
 			throw new MimeMessageParseException(format(MimeMessageParseException.ERROR_GETTING_RECIPIENTS, recipientType), e);
 		}
@@ -490,6 +495,12 @@ private static String getHeaderName(RecipientType recipientType) {
 			return "Bcc";
 		}
 	}
+
+	@Nullable
+	private static String decodePersonalName(String personalName) {
+		return personalName != null ? decodeText(personalName) : null;
+	}
+
 	@Nullable
 	public static String parseContentDescription(@NotNull final MimePart mimePart) {
 		try {

modules/simple-java-mail/src/test/java/org/simplejavamail/converter/EmailConverterTest.java

@@ -148,6 +148,13 @@ public void testProblematicEmbeddedImage() {
 		assertThat(s1.getHTMLText()).containsPattern("\"cid:DB294AA3-160F-4825-923A-B16C8B674543@home\"");
 	}
 
+	@Test
+	public void testProblematicCommasInRecipeints() {
+		Email s1 = EmailConverter.emlToEmail(new File(RESOURCE_TEST_MESSAGES + "/#444 Email with encoded comma in recipients.eml"));
+		EmailAssert.assertThat(s1).hasFromRecipient(new Recipient("Some Name, Jane Doe", "[email protected]", null));
+		EmailAssert.assertThat(s1).hasOnlyRecipients(new Recipient("Some Name 2, John Doe", "[email protected]", TO));
+	}
+
 	@Test
 	public void testProblematicExchangeDeliveryReceipts() throws Exception {
 		SecureTestDataHelper.runTestWithSecureTestData(passwords -> {

modules/simple-java-mail/src/test/resources/test-messages/#444 Email with encoded comma in recipients.eml

@@ -0,0 +1,31 @@
+Received: from localhost (localhost [127.0.0.1])
+Subject: =?iso-8859-1?Q?Test E-Mail?=
+From: =?iso-8859-1?Q?Some_Name=2C_Jane_Doe?= <[email protected]>
+To: =?iso-8859-1?Q?Some_Name_2=2C_John_Doe?= <[email protected]>
+Date: Thu, 17 Jul 2022 11:30:35 +0200
+Mime-Version: 1.0
+Content-Type: multipart/mixed;
+ boundary="=_XcF8-p0YPEze5FKM4wBEsW6g4fs7szT74eXdtYFWHz2tdNBa"
+X-Priority: 3 (Normal)
+Thread-Index: AdZmVACDs7DEv8/jTk61asogqNbsIg==
+Message-Id: <5f22933b.3ac9.2d67554856caaa4d@local>
+
+This is a multi-part message in MIME format. Your mail reader does not
+understand MIME message format.
+
+--=_XcF8-p0YPEze5FKM4wBEsW6g4fs7szT74eXdtYFWHz2tdNBa
+Content-Type: multipart/alternative;
+ boundary="=_XcF8-p5aPECh5FzV4wU-tWHDHl3ZdfMTYuEsAukbZ+BKbIZY"
+
+This is a multi-part message in MIME format. Your mail reader does not
+understand MIME message format.
+
+--=_XcF8-p5aPECh5FzV4wU-tWHDHl3ZdfMTYuEsAukbZ+BKbIZY
+Content-Type: text/plain; charset=iso-8859-1
+Content-Transfer-Encoding: quoted-printable
+
+This is a multi-part message in MIME format. Your mail reader does not
+understand MIME message format.
+
+--=_XcF8-p0YPEze5FKM4wBEsW6g4fs7szT74eXdtYFWHz2tdNBa--
+

pom.xml

@@ -66,6 +66,12 @@
             <version>1.18.22</version>
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>com.pivovarit</groupId>
+            <artifactId>throwing-function</artifactId>
+            <version>1.5.1</version>
+            <scope>compile</scope>
+        </dependency>
 
         <!-- testing -->
         <dependency>