Email resource - added support for entire query as input parameter

Author: Dominik Hošic

src/Resources/Email.php

@@ -14,26 +14,26 @@ final class Email extends BaseResource
     /**
      * Validate an email address.
      *
-     * @param string $email Email address to validate
+     * @param string|array $query Email address to validate
      *
      * @return Response The response from the validation request
      */
-    public function validate($email): Response
+    public function validate($query): Response
     {
-        $query = ["email" => $email];
+        $query = is_array($query) ? $query : ["email" => $query];
         return $this->sendRequest($query);
     }
 
     /**
      * Search for information related to an email address.
      *
-     * @param string $email Email address to search for
+     * @param string|array $query Email address to search for
      *
      * @return Response The response from the search request
      */
-    public function search(string $email): Response
+    public function search($query): Response
     {
-        $query = ["value" => $email];
+        $query = is_array($query) ? $query : ["value" => $query];
         return $this->sendRequest($query);
     }
 

tests/Unit/Email/EmailSearchTest.php

@@ -20,6 +20,7 @@ public function testSearchResults()
         // Input string for email search.
         $input = 'info@';
 
+        // Options that will be sent within the request.
         $options = [
             "resultsLimit" => 5
         ];
@@ -35,4 +36,27 @@ public function testSearchResults()
         $this->assertGreaterThan(0, $response->getResponse()->resultsCount);
         $this->assertNotEmpty($result);
     }
+
+    /**
+     *  Test email search when the input parameter is specified as the entire query.
+     */
+    public function testQueryInput()
+    {
+        // Query that will be sent to the API for validation.
+        $query = [
+            "value" => "info@"
+        ];
+
+        // Options that will be sent within the request.
+        $options = [
+            "resultsLimit" => 5
+        ];
+
+        // Perform email validation.
+        $response = $this->api->email->setOptions($options)->search($query);
+
+        // Assertions.
+        $this->assertInstanceOf(Response::class, $response);
+        $this->assertEquals(200, $response->getStatus());
+    }
 }

tests/Unit/Email/EmailValidateTest.php

@@ -233,4 +233,27 @@ public function testWithClient()
         $this->assertEquals(200, $response->getStatus());
         $this->assertTrue($result->isValid);
     }
+
+    /**
+     * Test email validation when the input parameter is specified as the entire query.
+     */
+    public function testQueryInput()
+    {
+        // Query that will be sent to the API for validation.
+        $query = [
+            "email" => "[email protected]"
+        ];
+
+        // Options that will be sent within the request.
+        $options = [
+            "validationType" => "extended"
+        ];
+
+        // Perform email validation.
+        $response = $this->api->email->setOptions($options)->validate($query);
+
+        // Assertions.
+        $this->assertInstanceOf(Response::class, $response);
+        $this->assertEquals(200, $response->getStatus());
+    }
 }