Renamed Inbox -> Inboxes; updated type for all IDs to long; Minor code readability improvements in DefaultMailtrapHttpClient

Author: vitalii-t

README.md

@@ -89,7 +89,7 @@ public class MailtrapJavaSDKTest {
         // OR send email to the Mailtrap Sandbox
 
         try {
-            int inboxId = 1000001;
+            long inboxId = 1000001L;
 
             // Either instantiate a new client
             MailtrapClient sandboxClient = MailtrapClientFactory.createMailtrapClient(

src/main/java/io/mailtrap/api/AttachmentsImpl.java

@@ -20,15 +20,15 @@ public AttachmentsImpl(MailtrapConfig config) {
     }
 
     @Override
-    public AttachmentResponse getSingleAttachment(long accountId, int inboxId, long messageId, long attachmentId) {
+    public AttachmentResponse getSingleAttachment(long accountId, long inboxId, long messageId, long attachmentId) {
         return httpClient.get(
                 String.format(apiHost + "/api/accounts/%s/inboxes/%s/messages/%s/attachments/%s", accountId, inboxId, messageId, attachmentId),
                 new RequestData(),
                 AttachmentResponse.class);
     }
 
     @Override
-    public List<AttachmentResponse> getAttachments(long accountId, int inboxId, long messageId, String attachmentType) {
+    public List<AttachmentResponse> getAttachments(long accountId, long inboxId, long messageId, String attachmentType) {
         var queryParams = RequestData.buildQueryParams(
                 entry("attachment_type", Optional.ofNullable(attachmentType)));
 

src/main/java/io/mailtrap/api/InboxImpl.java renamed to src/main/java/io/mailtrap/api/InboxesImpl.java

@@ -2,7 +2,7 @@
 
 import io.mailtrap.Constants;
 import io.mailtrap.CustomValidator;
-import io.mailtrap.api.abstractions.Inbox;
+import io.mailtrap.api.abstractions.Inboxes;
 import io.mailtrap.api.abstractions.classes.ApiResourceWithValidation;
 import io.mailtrap.config.MailtrapConfig;
 import io.mailtrap.http.RequestData;
@@ -12,9 +12,9 @@
 
 import java.util.List;
 
-public class InboxImpl extends ApiResourceWithValidation implements Inbox {
+public class InboxesImpl extends ApiResourceWithValidation implements Inboxes {
 
-    public InboxImpl(MailtrapConfig config, CustomValidator validator) {
+    public InboxesImpl(MailtrapConfig config, CustomValidator validator) {
         super(config, validator);
         this.apiHost = Constants.GENERAL_HOST;
     }
@@ -33,7 +33,7 @@ public InboxResponse createInbox(long accountId, long projectId, CreateInboxRequ
     }
 
     @Override
-    public InboxResponse getInboxAttributes(long accountId, int inboxId) {
+    public InboxResponse getInboxAttributes(long accountId, long inboxId) {
         return httpClient.get(
                 String.format(apiHost + "/api/accounts/%s/inboxes/%s", accountId, inboxId),
                 new RequestData(),
@@ -42,7 +42,7 @@ public InboxResponse getInboxAttributes(long accountId, int inboxId) {
     }
 
     @Override
-    public InboxResponse deleteInbox(long accountId, int inboxId) {
+    public InboxResponse deleteInbox(long accountId, long inboxId) {
         return httpClient.delete(
                 String.format(apiHost + "/api/accounts/%s/inboxes/%s", accountId, inboxId),
                 new RequestData(),
@@ -51,7 +51,7 @@ public InboxResponse deleteInbox(long accountId, int inboxId) {
     }
 
     @Override
-    public InboxResponse updateInbox(long accountId, int inboxId, UpdateInboxRequest request) {
+    public InboxResponse updateInbox(long accountId, long inboxId, UpdateInboxRequest request) {
 
         validateRequestBodyAndThrowException(request);
 
@@ -64,7 +64,7 @@ public InboxResponse updateInbox(long accountId, int inboxId, UpdateInboxRequest
     }
 
     @Override
-    public InboxResponse cleanInbox(long accountId, int inboxId) {
+    public InboxResponse cleanInbox(long accountId, long inboxId) {
         return httpClient.patch(
                 String.format(apiHost + "/api/accounts/%s/inboxes/%s/clean", accountId, inboxId),
                 null,
@@ -74,7 +74,7 @@ public InboxResponse cleanInbox(long accountId, int inboxId) {
     }
 
     @Override
-    public InboxResponse markAsRead(long accountId, int inboxId) {
+    public InboxResponse markAsRead(long accountId, long inboxId) {
         return httpClient.patch(
                 String.format(apiHost + "/api/accounts/%s/inboxes/%s/all_read", accountId, inboxId),
                 null,
@@ -84,7 +84,7 @@ public InboxResponse markAsRead(long accountId, int inboxId) {
     }
 
     @Override
-    public InboxResponse resetCredentials(long accountId, int inboxId) {
+    public InboxResponse resetCredentials(long accountId, long inboxId) {
         return httpClient.patch(
                 String.format(apiHost + "/api/accounts/%s/inboxes/%s/reset_credentials", accountId, inboxId),
                 null,
@@ -94,7 +94,7 @@ public InboxResponse resetCredentials(long accountId, int inboxId) {
     }
 
     @Override
-    public InboxResponse enableEmailAddress(long accountId, int inboxId) {
+    public InboxResponse enableEmailAddress(long accountId, long inboxId) {
         return httpClient.patch(
                 String.format(apiHost + "/api/accounts/%s/inboxes/%s/toggle_email_username", accountId, inboxId),
                 null,
@@ -104,7 +104,7 @@ public InboxResponse enableEmailAddress(long accountId, int inboxId) {
     }
 
     @Override
-    public InboxResponse resetEmailAddresses(long accountId, int inboxId) {
+    public InboxResponse resetEmailAddresses(long accountId, long inboxId) {
         return httpClient.patch(
                 String.format(apiHost + "/api/accounts/%s/inboxes/%s/reset_email_username", accountId, inboxId),
                 null,

src/main/java/io/mailtrap/api/TestingEmailsImpl.java

@@ -20,7 +20,7 @@ public TestingEmailsImpl(MailtrapConfig config, CustomValidator customValidator)
     }
 
     @Override
-    public SendResponse send(MailtrapMail mail, int inboxId) {
+    public SendResponse send(MailtrapMail mail, long inboxId) {
         validateRequestBodyOrThrowException(mail);
         RequestData requestData = new RequestData();
         if (mail.getHeaders() != null) {

src/main/java/io/mailtrap/api/abstractions/Attachments.java

@@ -19,7 +19,7 @@ public interface Attachments {
      * @param attachmentId - unique attachment ID
      * @return attachment details and download path
      */
-    AttachmentResponse getSingleAttachment(long accountId, int inboxId, long messageId, long attachmentId);
+    AttachmentResponse getSingleAttachment(long accountId, long inboxId, long messageId, long attachmentId);
 
     /**
      * Get message attachments by inboxId and messageId
@@ -30,6 +30,6 @@ public interface Attachments {
      * @param attachmentType - attachment type; optional query param
      * @return attachments with their details and download paths
      */
-    List<AttachmentResponse> getAttachments(long accountId, int inboxId, long messageId, @Nullable String attachmentType);
+    List<AttachmentResponse> getAttachments(long accountId, long inboxId, long messageId, @Nullable String attachmentType);
 
 }

src/main/java/io/mailtrap/api/abstractions/Inbox.java renamed to src/main/java/io/mailtrap/api/abstractions/Inboxes.java

@@ -7,9 +7,9 @@
 import java.util.List;
 
 /**
- * Interface representing the Mailtrap Testing API for interaction with inbox
+ * Interface representing the Mailtrap Testing API for interaction with inboxes
  */
-public interface Inbox {
+public interface Inboxes {
 
     /**
      * Create an inbox in a project
@@ -28,7 +28,7 @@ public interface Inbox {
      * @param inboxId   unique inbox ID
      * @return the attributes of the inbox
      */
-    InboxResponse getInboxAttributes(long accountId, int inboxId);
+    InboxResponse getInboxAttributes(long accountId, long inboxId);
 
     /**
      * Delete an inbox with all its emails
@@ -37,7 +37,7 @@ public interface Inbox {
      * @param inboxId   unique inbox ID
      * @return the attributes of the deleted inbox
      */
-    InboxResponse deleteInbox(long accountId, int inboxId);
+    InboxResponse deleteInbox(long accountId, long inboxId);
 
     /**
      * Update inbox name, inbox email username
@@ -47,7 +47,7 @@ public interface Inbox {
      * @param request   request data
      * @return the attributes of the updated inbox
      */
-    InboxResponse updateInbox(long accountId, int inboxId, UpdateInboxRequest request);
+    InboxResponse updateInbox(long accountId, long inboxId, UpdateInboxRequest request);
 
     /**
      * Delete all messages (emails) from inbox
@@ -56,7 +56,7 @@ public interface Inbox {
      * @param inboxId   unique inbox ID
      * @return the attributes of the inbox. <b>permissions</b> returns the permissions of the token for the inbox.
      */
-    InboxResponse cleanInbox(long accountId, int inboxId);
+    InboxResponse cleanInbox(long accountId, long inboxId);
 
     /**
      * Mark all messages in the inbox as read
@@ -65,7 +65,7 @@ public interface Inbox {
      * @param inboxId   unique inbox ID
      * @return the attributes of the inbox. <b>permissions</b> returns the permissions of the token for the inbox
      */
-    InboxResponse markAsRead(long accountId, int inboxId);
+    InboxResponse markAsRead(long accountId, long inboxId);
 
     /**
      * Reset SMTP credentials of the inbox
@@ -74,7 +74,7 @@ public interface Inbox {
      * @param inboxId   unique inbox ID
      * @return the attributes of the inbox. <b>permissions</b> returns the permissions of the token for the inbox
      */
-    InboxResponse resetCredentials(long accountId, int inboxId);
+    InboxResponse resetCredentials(long accountId, long inboxId);
 
     /**
      * Turn the email address of the inbox on/off
@@ -83,7 +83,7 @@ public interface Inbox {
      * @param inboxId   unique inbox ID
      * @return the attributes of the inbox. <b>permissions</b> returns the permissions of the token for the inbox
      */
-    InboxResponse enableEmailAddress(long accountId, int inboxId);
+    InboxResponse enableEmailAddress(long accountId, long inboxId);
 
     /**
      * Reset username of email address per inbox
@@ -92,7 +92,7 @@ public interface Inbox {
      * @param inboxId   unique inbox ID
      * @return the attributes of the inbox. <b>permissions</b> returns the permissions of the token for the inbox
      */
-    InboxResponse resetEmailAddresses(long accountId, int inboxId);
+    InboxResponse resetEmailAddresses(long accountId, long inboxId);
 
     /**
      * Get a list of inboxes

src/main/java/io/mailtrap/api/abstractions/TestingEmails.java

@@ -20,5 +20,5 @@ public interface TestingEmails {
      * @throws HttpException               If there is an HTTP-related error during the send operation.
      * @throws InvalidRequestBodyException If the request body is invalid.
      */
-    SendResponse send(MailtrapMail mail, int inboxId) throws HttpException, InvalidRequestBodyException;
+    SendResponse send(MailtrapMail mail, long inboxId) throws HttpException, InvalidRequestBodyException;
 }

src/main/java/io/mailtrap/client/MailtrapClient.java

@@ -74,7 +74,7 @@ public void switchToBulkSendingApi() {
      *
      * @param inboxId the inbox ID to use for testing
      */
-    public void switchToEmailTestingApi(Integer inboxId) {
+    public void switchToEmailTestingApi(Long inboxId) {
         this.sendingContextHolder.setInboxId(inboxId);
         this.sendingContextHolder.setSandbox(true);
         this.sendingContextHolder.setBulk(false);

src/main/java/io/mailtrap/client/layers/MailtrapEmailTestingApi.java

@@ -1,7 +1,7 @@
 package io.mailtrap.client.layers;
 
 import io.mailtrap.api.abstractions.Attachments;
-import io.mailtrap.api.abstractions.Inbox;
+import io.mailtrap.api.abstractions.Inboxes;
 import io.mailtrap.api.abstractions.TestingEmails;
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
@@ -16,5 +16,5 @@
 public class MailtrapEmailTestingApi {
     private final TestingEmails emails;
     private final Attachments attachments;
-    private final Inbox inbox;
+    private final Inboxes inboxes;
 }

src/main/java/io/mailtrap/config/MailtrapConfig.java

@@ -41,7 +41,7 @@ public class MailtrapConfig {
     /**
      * Inbox ID. Should be used alongside with {@link #sandbox}, as Email Testing API requires inbox ID
      */
-    private final Integer inboxId;
+    private final Long inboxId;
 
     private MailtrapConfig(Builder builder) {
         if (builder.sandbox && builder.bulk) {
@@ -65,7 +65,7 @@ public static class Builder {
         private CustomHttpClient httpClient;
         private boolean sandbox;
         private boolean bulk;
-        private Integer inboxId;
+        private Long inboxId;
 
         public Builder connectionTimeout(Duration connectionTimeout) {
             this.connectionTimeout = connectionTimeout;
@@ -92,7 +92,7 @@ public Builder bulk(boolean bulk) {
             return this;
         }
 
-        public Builder inboxId(Integer inboxId) {
+        public Builder inboxId(Long inboxId) {
             this.inboxId = inboxId;
             return this;
         }