Code review updates, improved mail validation

Author: vitalii-t

examples/java/io/mailtrap/examples/bulk/Batch.java

@@ -10,7 +10,7 @@
 import java.util.List;
 import java.util.Map;
 
-public class Bulk {
+public class Batch {
 
     private static final String TOKEN = "<YOUR MAILTRAP TOKEN>";
     private static final String SENDER_EMAIL = "[email protected]";

examples/java/io/mailtrap/examples/sending/Batch.java

@@ -10,7 +10,7 @@
 import java.util.List;
 import java.util.Map;
 
-public class Bulk {
+public class Batch {
 
     private static final String TOKEN = "<YOUR MAILTRAP TOKEN>";
     private static final String SENDER_EMAIL = "[email protected]";

examples/java/io/mailtrap/examples/testing/Batch.java

@@ -38,7 +38,7 @@ public static void main(String[] args) {
         final var batchMail = MailtrapBatchMail.builder()
             // Optionally you can add this `base` object - if you have some common data across emails
             // Each property can be overridden in `requests` for individual emails
-            .base(BatchEmailBase.builder().subject("Base Subject for all emails").build())
+            .base(BatchEmailBase.builder().templateUuid("base-template-uuid").build())
             .requests(List.of(mail))
             .build();
 

src/main/java/io/mailtrap/api/apiresource/SendApiResource.java

@@ -8,6 +8,8 @@
 import org.apache.commons.collections4.MapUtils;
 import org.apache.commons.lang3.StringUtils;
 
+import java.util.Objects;
+
 /**
  * Abstract class representing a resource for sending emails via Mailtrap API.
  */
@@ -17,10 +19,16 @@ protected SendApiResource(MailtrapConfig config, CustomValidator customValidator
         super(config, customValidator);
     }
 
-    protected void assertBatchMailNotNull(MailtrapBatchMail batchMail){
+    protected void assertBatchMailNotNull(MailtrapBatchMail batchMail) {
         if (batchMail == null) {
             throw new InvalidRequestBodyException("BatchMail must not be null");
         }
+        if (batchMail.getRequests() == null || batchMail.getRequests().isEmpty()) {
+            throw new InvalidRequestBodyException("BatchMail.requests must not be null or empty");
+        }
+        if (batchMail.getRequests().stream().anyMatch(Objects::isNull)) {
+            throw new InvalidRequestBodyException("BatchMail.requests must not contain null items");
+        }
     }
 
     /**
@@ -36,9 +44,9 @@ protected void validateMailPayload(MailtrapMail mail) throws InvalidRequestBodyE
         }
 
         // Check if all three subject, text, and html are empty
-        boolean isSubjectTextHtmlEmpty = StringUtils.isEmpty(mail.getSubject())
-            && StringUtils.isEmpty(mail.getText())
-            && StringUtils.isEmpty(mail.getHtml());
+        boolean isSubjectTextHtmlEmpty = StringUtils.isBlank(mail.getSubject())
+            && StringUtils.isBlank(mail.getText())
+            && StringUtils.isBlank(mail.getHtml());
 
         // Validate depending on whether the templateUuid is set
         if (StringUtils.isEmpty(mail.getTemplateUuid())) {
@@ -65,9 +73,14 @@ private void validateWithoutTemplate(MailtrapMail mail, boolean isSubjectTextHtm
         }
 
         // Ensure the subject is not empty
-        if (StringUtils.isEmpty(mail.getSubject())) {
+        if (StringUtils.isBlank(mail.getSubject())) {
             throw new InvalidRequestBodyException("Subject must not be null or empty");
         }
+
+        // Ensure at least one of text or html is present
+        if (StringUtils.isBlank(mail.getText()) && StringUtils.isBlank(mail.getHtml())) {
+            throw new InvalidRequestBodyException("Mail must have subject and either text or html when templateUuid is not provided");
+        }
     }
 
     private void validateWithTemplate(MailtrapMail mail) throws InvalidRequestBodyException {

src/main/java/io/mailtrap/model/request/emails/BatchEmailBase.java

@@ -49,7 +49,7 @@ public class BatchEmailBase {
     /**
      * Values that are specific to the entire send that will be carried along with the email and its activity data
      */
-    @JsonProperty("custom_properties")
+    @JsonProperty("custom_variables")
     private Map<String, String> customVariables;
 
     /**

src/main/java/io/mailtrap/model/request/emails/MailtrapBatchMail.java

@@ -1,6 +1,9 @@
 package io.mailtrap.model.request.emails;
 
 import io.mailtrap.model.AbstractModel;
+import jakarta.validation.Valid;
+import jakarta.validation.constraints.NotNull;
+import jakarta.validation.constraints.Size;
 import lombok.Builder;
 import lombok.Getter;
 import lombok.Setter;
@@ -12,8 +15,12 @@
 @Builder
 public class MailtrapBatchMail extends AbstractModel {
 
+    @Valid
     private BatchEmailBase base;
 
+    @NotNull
+    @Size(min = 1)
+    @Valid
     private List<MailtrapMail> requests;
 
 }

src/test/java/io/mailtrap/api/bulkemails/BulkEmailsImplTest.java

@@ -101,6 +101,16 @@ void send_MailWithTemplateVariablesAndHtml_ThrowsInvalidRequestBodyException() {
         assertEquals(TEMPLATE_VARIABLES_SHOULD_BE_USED_WITH_TEMPLATE_UUID, exception.getMessage());
     }
 
+    @Test
+    void send_MailWithSubjectAndNoTextNoHtml_ThrowsInvalidRequestBodyException() {
+        // Set up invalid data
+        MailtrapMail mail = createTestMailWithSubjectAndNoTextAndNoHtml();
+
+        // Assert
+        InvalidRequestBodyException exception = assertThrows(InvalidRequestBodyException.class, () -> bulkEmails.send(mail));
+        assertEquals(MAIL_MUST_HAVE_SUBJECT_AND_EITHER_TEXT_OR_HTML, exception.getMessage());
+    }
+
     @Test
     void send_NullableMail_ThrowsInvalidRequestBodyException() {
         // Assert

src/test/java/io/mailtrap/api/sendingemails/SendingEmailsImplTest.java

@@ -101,6 +101,16 @@ void send_MailWithTemplateVariablesAndHtml_ThrowsInvalidRequestBodyException() {
         assertEquals(TEMPLATE_VARIABLES_SHOULD_BE_USED_WITH_TEMPLATE_UUID, exception.getMessage());
     }
 
+    @Test
+    void send_MailWithSubjectAndNoTextNoHtml_ThrowsInvalidRequestBodyException() {
+        // Set up invalid data
+        MailtrapMail mail = createTestMailWithSubjectAndNoTextAndNoHtml();
+
+        // Assert
+        InvalidRequestBodyException exception = assertThrows(InvalidRequestBodyException.class, () -> sendApi.send(mail));
+        assertEquals(MAIL_MUST_HAVE_SUBJECT_AND_EITHER_TEXT_OR_HTML, exception.getMessage());
+    }
+
     @Test
     void send_NullableMail_ThrowsInvalidRequestBodyException() {
         // Assert

src/test/java/io/mailtrap/api/testingemails/TestingEmailsImplTest.java

@@ -103,6 +103,16 @@ void send_MailWithTemplateVariablesAndHtml_ThrowsInvalidRequestBodyException() {
         assertEquals(TEMPLATE_VARIABLES_SHOULD_BE_USED_WITH_TEMPLATE_UUID, exception.getMessage());
     }
 
+    @Test
+    void send_MailWithSubjectAndNoTextNoHtml_ThrowsInvalidRequestBodyException() {
+        // Set up invalid data
+        MailtrapMail mail = createTestMailWithSubjectAndNoTextAndNoHtml();
+
+        // Assert
+        InvalidRequestBodyException exception = assertThrows(InvalidRequestBodyException.class, () -> testingApi.send(mail, INBOX_ID));
+        assertEquals(MAIL_MUST_HAVE_SUBJECT_AND_EITHER_TEXT_OR_HTML, exception.getMessage());
+    }
+
     @Test
     void send_NullableMail_ThrowsInvalidRequestBodyException() {
         // Assert

src/test/java/io/mailtrap/testutils/BaseSendTest.java

@@ -17,6 +17,7 @@ public class BaseSendTest {
     protected final String TEMPLATE_UUID_OR_SUBJECT_AND_TEXT_OR_HTML_MUST_NOT_BE_EMPTY = "Mail must have subject and either text or html when templateUuid is not provided";
     protected final String TEMPLATE_UUID_IS_USED_SUBJECT_AND_TEXT_AND_HTML_SHOULD_BE_EMPTY = "When templateUuid is used, subject, text, and html must not be used";
     protected final String TEMPLATE_VARIABLES_SHOULD_BE_USED_WITH_TEMPLATE_UUID = "Mail templateVariables must only be used with templateUuid";
+    protected final String MAIL_MUST_HAVE_SUBJECT_AND_EITHER_TEXT_OR_HTML = "Mail must have subject and either text or html when templateUuid is not provided";
     protected final String MAIL_MUST_NOT_BE_NULL = "Mail must not be null";
     protected final String BATCH_MAIL_MUST_NOT_BE_NULL = "BatchMail must not be null";
 
@@ -74,6 +75,19 @@ protected MailtrapMail createTestMailWithoutTemplateUuidAndSubjectAndTextAndHtml
                 .build();
     }
 
+    protected MailtrapMail createTestMailWithSubjectAndNoTextAndNoHtml() {
+        Address from = getAddress("[email protected]", "John Doe");
+        Address to = getAddress("[email protected]", "Jane Doe");
+        EmailAttachment attachment = getAttachment();
+
+        return MailtrapMail.builder()
+                .from(from)
+                .subject("Sample invalidvalid mail subject")
+                .to(List.of(to))
+                .attachments(List.of(attachment))
+                .build();
+    }
+
     protected MailtrapMail createTestMailWithTemplateUuidAndText() {
         Address from = getAddress("[email protected]", null);
         Address to = getAddress("[email protected]", null);