Add new ifValid and ifValidOrElse methods

Author: RohanNagar

CHANGELOG.md

@@ -1,5 +1,11 @@
 # JMail Changelog
 
+## 1.6.3
+
+- Fix bug where email addresses containing control characters in the local-part were incorrectly considered valid. (Thanks @PascalSchumacher for reporting!)
+- Add new methods `ifValid(Consumer<Email> action)` and `ifValidOrElse(Consumer<Email> action, Consumer<FailureReason> failureAction)` to the `EmailValidationResult` object.
+
+---
 ## 1.6.2
 
 - Fix bug where IPv4 addresses with non-arabic numerals would incorrectly be considered valid. (Thanks @harrel56 for reporting!)

src/main/java/com/sanctionco/jmail/EmailValidationResult.java

@@ -3,6 +3,7 @@
 import java.util.Objects;
 import java.util.Optional;
 import java.util.StringJoiner;
+import java.util.function.Consumer;
 
 /**
  * Contains information about an email address validation, including success or failure,
@@ -64,6 +65,33 @@ public FailureReason getFailureReason() {
     return failureReason;
   }
 
+  /**
+   * If the email address is valid, performs the given action with the valid email address,
+   * otherwise does nothing.
+   *
+   * @param action the action to be performed, if the email address is valid
+   */
+  public void ifValid(Consumer<Email> action) {
+    if (emailAddress != null) {
+      action.accept(emailAddress);
+    }
+  }
+
+  /**
+   * If the email address is valid, performs the given action with the valid email address,
+   * otherwise performs the given failure action with the failure reason.
+   *
+   * @param action the action to be performed, if the email address is valid
+   * @param failureAction the action to be performed, if the email address is invalid
+   */
+  public void ifValidOrElse(Consumer<Email> action, Consumer<FailureReason> failureAction) {
+    if (emailAddress != null) {
+      action.accept(emailAddress);
+    } else {
+      failureAction.accept(failureReason);
+    }
+  }
+
   @Override
   public String toString() {
     return new StringJoiner(", ", EmailValidationResult.class.getSimpleName() + "[", "]")

src/test/java/com/sanctionco/jmail/EmailValidationResultTest.java

@@ -1,6 +1,8 @@
 package com.sanctionco.jmail;
 
 import java.util.Optional;
+import java.util.concurrent.atomic.AtomicBoolean;
+import java.util.function.Consumer;
 
 import nl.jqno.equalsverifier.EqualsVerifier;
 
@@ -36,4 +38,70 @@ void testStaticFailureConstructor() {
         .hasToString("EmailValidationResult"
             + "[success=false, emailAddress=null, failureReason=NULL_ADDRESS]");
   }
+
+  @Test
+  void testIfValidTrue() {
+    Optional<Email> testEmail = Email.of("[email protected]");
+    EmailValidationResult result = EmailValidationResult.success(testEmail.get());
+
+    AtomicBoolean completedAction = new AtomicBoolean(false);
+
+    Consumer<Email> action = email -> {
+      completedAction.set(true);
+      assertThat(email).isEqualTo(Email.of("[email protected]").get());
+    };
+
+    result.ifValid(action);
+    assertThat(completedAction).isTrue();
+  }
+
+  @Test
+  void testIfValidFalse() {
+    EmailValidationResult result = EmailValidationResult.failure(FailureReason.NULL_ADDRESS);
+
+    AtomicBoolean completedAction = new AtomicBoolean(false);
+
+    Consumer<Email> action = email -> completedAction.set(true);
+
+    result.ifValid(action);
+    assertThat(completedAction).isFalse();
+  }
+
+  @Test
+  void testIfValidOrElseTrue() {
+    Optional<Email> testEmail = Email.of("[email protected]");
+    EmailValidationResult result = EmailValidationResult.success(testEmail.get());
+
+    AtomicBoolean completedAction = new AtomicBoolean(false);
+    AtomicBoolean completedFailureAction = new AtomicBoolean(false);
+
+    Consumer<Email> action = email -> {
+      completedAction.set(true);
+      assertThat(email).isEqualTo(Email.of("[email protected]").get());
+    };
+
+    Consumer<FailureReason> failureAction = failureReason -> completedFailureAction.set(true);
+
+    result.ifValidOrElse(action, failureAction);
+    assertThat(completedAction).isTrue();
+    assertThat(completedFailureAction).isFalse();
+  }
+
+  @Test
+  void testIfValidOrElseFalse() {
+    EmailValidationResult result = EmailValidationResult.failure(FailureReason.NULL_ADDRESS);
+
+    AtomicBoolean completedAction = new AtomicBoolean(false);
+    AtomicBoolean completedFailureAction = new AtomicBoolean(false);
+
+    Consumer<Email> action = email -> completedAction.set(true);
+    Consumer<FailureReason> failureAction = failureReason -> {
+      completedFailureAction.set(true);
+      assertThat(failureReason).isEqualTo(FailureReason.NULL_ADDRESS);
+    };
+
+    result.ifValidOrElse(action, failureAction);
+    assertThat(completedAction).isFalse();
+    assertThat(completedFailureAction).isTrue();
+  }
 }