#429: mail.<protocol>.username -> mail.<protocol>.user, as per Sun/Jakarta documentation. This is the default user property in case manual authenticator is not used (which is the case with Simple Java Mail if a password was not provided by the user)

bbottema · bbottema · commit 2f39d781d927 · 2022-12-25T12:26:06.000+01:00
diff --git a/modules/core-module/src/main/java/org/simplejavamail/api/mailer/config/TransportStrategy.java b/modules/core-module/src/main/java/org/simplejavamail/api/mailer/config/TransportStrategy.java
@@ -97,11 +97,11 @@ public String propertyNamePort() {
 		}
 
 		/**
-		 * @return "mail.smtp.username"
+		 * @return "mail.smtp.user"
 		 */
 		@Override
 		public String propertyNameUsername() {
-			return "mail.smtp.username";
+			return "mail.smtp.user";
 		}
 
 		/**
@@ -258,11 +258,11 @@ public String propertyNamePort() {
 		}
 
 		/**
-		 * @return "mail.smtps.username"
+		 * @return "mail.smtps.user"
 		 */
 		@Override
 		public String propertyNameUsername() {
-			return "mail.smtps.username";
+			return "mail.smtps.user";
 		}
 
 		/**
@@ -397,11 +397,11 @@ public String propertyNamePort() {
 		}
 
 		/**
-		 * @return "mail.smtp.username"
+		 * @return "mail.smtp.user"
 		 */
 		@Override
 		public String propertyNameUsername() {
-			return "mail.smtp.username";
+			return "mail.smtp.user";
 		}
 
 		/**
diff --git a/modules/simple-java-mail/src/test/java/org/simplejavamail/mailer/MailerLiveTest.java b/modules/simple-java-mail/src/test/java/org/simplejavamail/mailer/MailerLiveTest.java
@@ -61,16 +61,19 @@ public class MailerLiveTest {
 	private static final String RESOURCES_PKCS = determineResourceFolder("simple-java-mail") + "/test/resources/pkcs12";
 
 	private static final Integer SERVER_PORT = 251;
+	
+	private static final String USERNAME = "usey";
+	private static final String PASSWORD = "passy";
 
 	@Rule
-	public final SmtpServerRule smtpServerRule = new SmtpServerRule(SERVER_PORT);
+	public final SmtpServerRule smtpServerRule = new SmtpServerRule(SERVER_PORT, "usey", "passy");
 
 	private Mailer mailer;
 
 	@Before
 	public void setup() {
 		ConfigLoaderTestHelper.clearConfigProperties();
-		mailer = MailerBuilder.withSMTPServer("localhost", SERVER_PORT).buildMailer();
+		mailer = MailerBuilder.withSMTPServer("localhost", SERVER_PORT, USERNAME, PASSWORD).buildMailer();
 	}
 	
 	@Test
@@ -141,7 +144,7 @@ public void createMailSession_OutlookMessageDefaultSmimeSignTest()
 			throws IOException, MessagingException, ExecutionException, InterruptedException {
 		// override the default from the @Before test
 		mailer = MailerBuilder
-				.withSMTPServer("localhost", SERVER_PORT)
+				.withSMTPServer("localhost", SERVER_PORT, USERNAME, PASSWORD)
 				.signByDefaultWithSmime(new File(RESOURCES_PKCS + "/smime_keystore.pkcs12"), "letmein", "smime_test_user_alias", "letmein")
 				.buildMailer();
 
diff --git a/modules/simple-java-mail/src/test/java/org/simplejavamail/mailer/MailerSOCKSLiveTest.java b/modules/simple-java-mail/src/test/java/org/simplejavamail/mailer/MailerSOCKSLiveTest.java
@@ -21,7 +21,7 @@ public class MailerSOCKSLiveTest {
 	private static final Integer PROXY_SERVER_PORT = 253;
 
 	@Rule
-	public final SmtpServerRule smtpServerRule = new SmtpServerRule(SMTP_SERVER_PORT);
+	public final SmtpServerRule smtpServerRule = new SmtpServerRule(SMTP_SERVER_PORT, null, null);
 	@ClassRule
 	public static final SockServerRule sockServerRule = new SockServerRule(PROXY_SERVER_PORT);
 
diff --git a/modules/simple-java-mail/src/test/java/org/simplejavamail/mailer/MailerTest.java b/modules/simple-java-mail/src/test/java/org/simplejavamail/mailer/MailerTest.java
@@ -87,7 +87,7 @@ public void createMailSession_MinimalConstructor_WithoutConfig() {
 		assertThat(session.getProperty("mail.smtp.ssl.trust")).isEqualTo("*");
 		assertThat(session.getProperty("mail.smtp.ssl.checkserveridentity")).isNull();
 		
-		assertThat(session.getProperty("mail.smtp.username")).isNull();
+		assertThat(session.getProperty("mail.smtp.user")).isNull();
 		assertThat(session.getProperty("mail.smtp.auth")).isNull();
 		assertThat(session.getProperty("mail.smtp.socks.host")).isNull();
 		assertThat(session.getProperty("mail.smtp.socks.port")).isNull();
@@ -125,7 +125,7 @@ public void createMailSession_AnonymousProxyConstructor_WithoutConfig() {
 		assertThat(session.getProperty("mail.smtp.starttls.required")).isEqualTo("true");
 		assertThat(session.getProperty("mail.smtp.ssl.checkserveridentity")).isEqualTo("true");
 		
-		assertThat(session.getProperty("mail.smtp.username")).isEqualTo("username smtp");
+		assertThat(session.getProperty("mail.smtp.user")).isEqualTo("username smtp");
 		assertThat(session.getProperty("mail.smtp.auth")).isEqualTo("true");
 		assertThat(session.getProperty("mail.smtp.socks.host")).isEqualTo("proxy host");
 		assertThat(session.getProperty("mail.smtp.socks.port")).isEqualTo("1080");
@@ -150,7 +150,7 @@ public void createMailSession_MaximumConstructor_WithoutConfig() {
 		assertThat(session.getProperty("mail.smtp.starttls.enable")).isEqualTo("true");
 		assertThat(session.getProperty("mail.smtp.starttls.required")).isEqualTo("true");
 		assertThat(session.getProperty("mail.smtp.ssl.checkserveridentity")).isEqualTo("true");
-		assertThat(session.getProperty("mail.smtp.username")).isEqualTo("username smtp");
+		assertThat(session.getProperty("mail.smtp.user")).isEqualTo("username smtp");
 		assertThat(session.getProperty("mail.smtp.auth")).isEqualTo("true");
 		// the following two are because authentication is needed, otherwise proxy would be straightworward
 		assertThat(session.getProperty("mail.smtp.socks.host")).isEqualTo("localhost");
@@ -176,7 +176,7 @@ public void createMailSession_MinimalConstructor_WithConfig() {
 		assertThat(session.getProperty("mail.smtp.starttls.enable")).isEqualTo("true");
 		assertThat(session.getProperty("mail.smtp.starttls.required")).isEqualTo("true");
 		assertThat(session.getProperty("mail.smtp.ssl.checkserveridentity")).isEqualTo("true");
-		assertThat(session.getProperty("mail.smtp.username")).isEqualTo("username smtp");
+		assertThat(session.getProperty("mail.smtp.user")).isEqualTo("username smtp");
 		assertThat(session.getProperty("mail.smtp.auth")).isEqualTo("true");
 		// the following two are because authentication is needed, otherwise proxy would be straightworward
 		assertThat(session.getProperty("mail.smtp.socks.host")).isEqualTo("localhost");
@@ -206,7 +206,7 @@ public void createMailSession_MinimalConstructor_WithConfig_OPPORTUNISTIC_TLS()
 		assertThat(session.getProperty("mail.smtp.starttls.required")).isNull();
 		assertThat(session.getProperty("mail.smtp.ssl.checkserveridentity")).isNull();
 		
-		assertThat(session.getProperty("mail.smtp.username")).isEqualTo("username smtp");
+		assertThat(session.getProperty("mail.smtp.user")).isEqualTo("username smtp");
 		assertThat(session.getProperty("mail.smtp.auth")).isEqualTo("true");
 		// the following two are because authentication is needed, otherwise proxy would be straightworward
 		assertThat(session.getProperty("mail.smtp.socks.host")).isEqualTo("localhost");
@@ -236,7 +236,7 @@ public void createMailSession_MinimalConstructor_WithConfig_OPPORTUNISTIC_TLS_Ma
 		assertThat(session.getProperty("mail.smtp.ssl.trust")).isEqualTo("*");
 		assertThat(session.getProperty("mail.smtp.ssl.checkserveridentity")).isNull();
 		
-		assertThat(session.getProperty("mail.smtp.username")).isEqualTo("username smtp");
+		assertThat(session.getProperty("mail.smtp.user")).isEqualTo("username smtp");
 		assertThat(session.getProperty("mail.smtp.auth")).isEqualTo("true");
 		// the following two are because authentication is needed, otherwise proxy would be straightworward
 		assertThat(session.getProperty("mail.smtp.socks.host")).isEqualTo("localhost");
@@ -256,7 +256,7 @@ public void createMailSession_MaximumConstructor_WithConfig() {
 		assertThat(session.getProperty("mail.smtp.starttls.enable")).isEqualTo("true");
 		assertThat(session.getProperty("mail.smtp.starttls.required")).isEqualTo("true");
 		assertThat(session.getProperty("mail.smtp.ssl.checkserveridentity")).isEqualTo("true");
-		assertThat(session.getProperty("mail.smtp.username")).isEqualTo("overridden username smtp");
+		assertThat(session.getProperty("mail.smtp.user")).isEqualTo("overridden username smtp");
 		assertThat(session.getProperty("mail.smtp.auth")).isEqualTo("true");
 		// the following two are because authentication is needed, otherwise proxy would be straightworward
 		assertThat(session.getProperty("mail.smtp.socks.host")).isEqualTo("localhost");
@@ -276,7 +276,7 @@ public void createMailSession_MaximumConstructor_WithConfig_TLS() {
 		assertThat(session.getProperty("mail.smtps.port")).isEqualTo("25");
 		assertThat(session.getProperty("mail.transport.protocol")).isEqualTo("smtps");
 		assertThat(session.getProperty("mail.smtps.quitwait")).isEqualTo("false");
-		assertThat(session.getProperty("mail.smtps.username")).isEqualTo("overridden username smtp");
+		assertThat(session.getProperty("mail.smtps.user")).isEqualTo("overridden username smtp");
 		assertThat(session.getProperty("mail.smtps.auth")).isEqualTo("true");
 		assertThat(session.getProperty("extra1")).isEqualTo("overridden value1");
 		assertThat(session.getProperty("extra2")).isEqualTo("overridden value2");
diff --git a/modules/simple-java-mail/src/test/java/testutil/testrules/SmtpServerRule.java b/modules/simple-java-mail/src/test/java/testutil/testrules/SmtpServerRule.java
@@ -2,8 +2,14 @@
 
 import jakarta.mail.MessagingException;
 import jakarta.mail.internet.MimeMessage;
+import lombok.RequiredArgsConstructor;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 import org.junit.rules.ExternalResource;
+import org.subethamail.smtp.MessageContext;
+import org.subethamail.smtp.auth.EasyAuthenticationHandlerFactory;
+import org.subethamail.smtp.auth.LoginFailedException;
+import org.subethamail.smtp.auth.UsernamePasswordValidator;
 import org.subethamail.smtp.server.SMTPServer;
 import org.subethamail.wiser.Wiser;
 import org.subethamail.wiser.WiserMessage;
@@ -12,12 +18,13 @@
 import java.io.InputStream;
 import java.io.PrintStream;
 import java.util.List;
+import java.util.Objects;
 
 import static java.lang.String.format;
 import static org.assertj.core.api.Assertions.assertThat;
 
 /**
- * SmtpServerRule - a TestRule wrapping a Wiser instance (a SMTP server in Java), started and stopped right before and after each test.
+ * SmtpServerRule - a TestRule wrapping a Wiser instance (an SMTP server in Java), started and stopped right before and after each test.
  * <br>
  * SmtpServerRule exposes the same methods as the {@link Wiser} instance by delegating the implementation to the instance. These methods, however, can not be
  * used outside a JUnit statement (otherwise an {@link IllegalStateException} is raised).
@@ -26,27 +33,43 @@
  */
 public class SmtpServerRule extends ExternalResource {
 	private final Wiser wiser;
-
-	public SmtpServerRule(@NotNull Integer port) {
-		this.wiser = Wiser.accepter((from, recipient) -> true).port(port);
+	
+	@RequiredArgsConstructor
+	static class RequiredUsernamePasswordValidator implements UsernamePasswordValidator {
+		@Nullable final String username;
+		@Nullable final String password;
+		
+		@Override
+		public void login(String username, String password, MessageContext context) throws LoginFailedException {
+			if (!Objects.equals(this.username, username) || !Objects.equals(this.password, password)) {
+				throw new LoginFailedException();
+			}
+		}
 	}
-
+	
+	public SmtpServerRule(@NotNull Integer port, @Nullable String username, @Nullable String password) {
+		this.wiser = Wiser.create(SMTPServer
+				.port(port)
+				.authenticationHandlerFactory(new EasyAuthenticationHandlerFactory(new RequiredUsernamePasswordValidator(username, password)))
+				.requireAuth(password != null));
+	}
+	
 	@Override
 	protected void before() {
 		this.wiser.start();
 	}
-
+	
 	@Override
 	protected void after() {
 		this.wiser.stop();
 	}
-
+	
 	@NotNull
 	public Wiser getWiser() {
 		checkState("getWiser()");
 		return this.wiser;
 	}
-
+	
 	@NotNull
 	public List<WiserMessage> getMessages() {
 		checkState("getMessages()");
@@ -79,39 +102,39 @@ public MimeMessage getMessage(String envelopeReceiver)
 			throws MessagingException {
 		checkState("getMessages()");
 		List<WiserMessage> messages = getMessages();
-
+		
 		WiserMessage wiserMessage = messages.stream()
-				.filter(m->m.getEnvelopeReceiver().equals(envelopeReceiver))
+				.filter(m -> m.getEnvelopeReceiver().equals(envelopeReceiver))
 				.findFirst()
 				.orElseThrow(() -> new AssertionError("message not found for recipient " + envelopeReceiver));
-
+		
 		messages.remove(wiserMessage);
 		return wiserMessage.getMimeMessage();
 	}
-
+	
 	@NotNull
 	public SMTPServer getServer() {
 		checkState("getServer()");
 		return wiser.getServer();
 	}
-
+	
 	public boolean accept(String from, String recipient) {
 		checkState("accept(String, String)");
 		return wiser.accept(from, recipient);
 	}
-
+	
 	public void deliver(String from, String recipient, InputStream data)
 			throws IOException {
 		checkState("deliver(String, String, InputStream)");
 		wiser.deliver(from, recipient, data);
 	}
-
+	
 	public void dumpMessages(PrintStream out)
 			throws MessagingException {
 		checkState("dumpMessages(PrintStream)");
 		wiser.dumpMessages(out);
 	}
-
+	
 	private void checkState(String method) {
 		if (this.wiser == null) {
 			throw new IllegalStateException(format("%s must not be called outside of a JUnit statement", method));

Original file line number	Diff line number	Diff line change
`@@ -97,11 +97,11 @@ public String propertyNamePort() {`
`97`	`97`	`}`
`98`	`98`
`99`	`99`	`/**`
`100`		`- * @return "mail.smtp.username"`
	`100`	`+ * @return "mail.smtp.user"`
`101`	`101`	`*/`
`102`	`102`	`@Override`
`103`	`103`	`public String propertyNameUsername() {`
`104`		`- return "mail.smtp.username";`
	`104`	`+ return "mail.smtp.user";`
`105`	`105`	`}`
`106`	`106`
`107`	`107`	`/**`
`@@ -258,11 +258,11 @@ public String propertyNamePort() {`
`258`	`258`	`}`
`259`	`259`
`260`	`260`	`/**`
`261`		`- * @return "mail.smtps.username"`
	`261`	`+ * @return "mail.smtps.user"`
`262`	`262`	`*/`
`263`	`263`	`@Override`
`264`	`264`	`public String propertyNameUsername() {`
`265`		`- return "mail.smtps.username";`
	`265`	`+ return "mail.smtps.user";`
`266`	`266`	`}`
`267`	`267`
`268`	`268`	`/**`
`@@ -397,11 +397,11 @@ public String propertyNamePort() {`
`397`	`397`	`}`
`398`	`398`
`399`	`399`	`/**`
`400`		`- * @return "mail.smtp.username"`
	`400`	`+ * @return "mail.smtp.user"`
`401`	`401`	`*/`
`402`	`402`	`@Override`
`403`	`403`	`public String propertyNameUsername() {`
`404`		`- return "mail.smtp.username";`
	`404`	`+ return "mail.smtp.user";`
`405`	`405`	`}`
`406`	`406`
`407`	`407`	`/**`