Add support for bulk sending mode in Mailtrap client

Introduce a new `bulk` mode in the Mailtrap client, setting a dedicated `BULK_HOST` for bulk operations. Updated validation logic to prevent conflicts between bulk and sandbox modes. Added corresponding test cases to ensure correct functionality and URL generation.

Author: andrii-porokhnavets

mailtrap/client.py

@@ -13,19 +13,22 @@
 class MailtrapClient:
     DEFAULT_HOST = "send.api.mailtrap.io"
     DEFAULT_PORT = 443
+    BULK_HOST = "bulk.api.mailtrap.io"
     SANDBOX_HOST = "sandbox.api.mailtrap.io"
 
     def __init__(
         self,
         token: str,
         api_host: Optional[str] = None,
         api_port: int = DEFAULT_PORT,
+        bulk: bool = False,
         sandbox: bool = False,
         inbox_id: Optional[str] = None,
     ) -> None:
         self.token = token
         self.api_host = api_host
         self.api_port = api_port
+        self.bulk = bulk
         self.sandbox = sandbox
         self.inbox_id = inbox_id
 
@@ -70,6 +73,8 @@ def _host(self) -> str:
             return self.api_host
         if self.sandbox:
             return self.SANDBOX_HOST
+        if self.bulk:
+            return self.BULK_HOST
         return self.DEFAULT_HOST
 
     @staticmethod
@@ -90,3 +95,6 @@ def _validate_itself(self) -> None:
             raise ClientConfigurationError(
                 "`inbox_id` is not allowed in non-sandbox mode"
             )
+
+        if self.bulk and self.sandbox:
+            raise ClientConfigurationError("bulk mode is not allowed in sandbox mode")

tests/unit/test_client.py

@@ -35,6 +35,7 @@ def get_client(**kwargs: Any) -> mt.MailtrapClient:
         [
             {"sandbox": True},
             {"inbox_id": "12345"},
+            {"bulk": True, "sandbox": True, "inbox_id": "12345"},
         ],
     )
     def test_client_validation(self, arguments: dict[str, Any]) -> None:
@@ -54,10 +55,22 @@ def test_base_url_should_truncate_slash_from_host(self) -> None:
                 {"api_host": "example.send.com", "api_port": 543},
                 "https://example.send.com:543/api/send",
             ),
+            (
+                {"api_host": "example.send.com", "sandbox": True, "inbox_id": "12345"},
+                "https://example.send.com:443/api/send/12345",
+            ),
+            (
+                {"api_host": "example.send.com", "bulk": True},
+                "https://example.send.com:443/api/send",
+            ),
             (
                 {"sandbox": True, "inbox_id": "12345"},
                 "https://sandbox.api.mailtrap.io:443/api/send/12345",
             ),
+            (
+                {"bulk": True},
+                "https://bulk.api.mailtrap.io:443/api/send",
+            ),
         ],
     )
     def test_api_send_url_should_return_default_sending_url(