diff --git a/src/Appwrite/Utopia/Response/Model/Account.php b/src/Appwrite/Utopia/Response/Model/Account.php index aaaf501a88..fb03bdb155 100644 --- a/src/Appwrite/Utopia/Response/Model/Account.php +++ b/src/Appwrite/Utopia/Response/Model/Account.php @@ -78,6 +78,41 @@ class Account extends Model 'default' => false, 'example' => true, ]) + ->addRule('emailCanonical', [ + 'type' => self::TYPE_STRING, + 'description' => 'Canonical form of the user email address.', + 'required' => false, + 'default' => '', + 'example' => 'john@appwrite.io', + ]) + ->addRule('emailIsFree', [ + 'type' => self::TYPE_BOOLEAN, + 'description' => 'Whether the user email is from a free email provider.', + 'required' => false, + 'default' => null, + 'example' => true, + ]) + ->addRule('emailIsDisposable', [ + 'type' => self::TYPE_BOOLEAN, + 'description' => 'Whether the user email is from a disposable email provider.', + 'required' => false, + 'default' => null, + 'example' => false, + ]) + ->addRule('emailIsCorporate', [ + 'type' => self::TYPE_BOOLEAN, + 'description' => 'Whether the user email is from a corporate domain.', + 'required' => false, + 'default' => null, + 'example' => true, + ]) + ->addRule('emailIsCanonical', [ + 'type' => self::TYPE_BOOLEAN, + 'description' => 'Whether the user email is in its canonical form.', + 'required' => false, + 'default' => null, + 'example' => true, + ]) ->addRule('phoneVerification', [ 'type' => self::TYPE_BOOLEAN, 'description' => 'Phone verification status.', diff --git a/src/Appwrite/Utopia/Response/Model/User.php b/src/Appwrite/Utopia/Response/Model/User.php index 01447ccfc2..f255519bfd 100644 --- a/src/Appwrite/Utopia/Response/Model/User.php +++ b/src/Appwrite/Utopia/Response/Model/User.php @@ -108,6 +108,41 @@ class User extends Model 'default' => false, 'example' => true, ]) + ->addRule('emailCanonical', [ + 'type' => self::TYPE_STRING, + 'description' => 'Canonical form of the user email address.', + 'required' => false, + 'default' => '', + 'example' => 'john@appwrite.io', + ]) + ->addRule('emailIsFree', [ + 'type' => self::TYPE_BOOLEAN, + 'description' => 'Whether the user email is from a free email provider.', + 'required' => false, + 'default' => null, + 'example' => true, + ]) + ->addRule('emailIsDisposable', [ + 'type' => self::TYPE_BOOLEAN, + 'description' => 'Whether the user email is from a disposable email provider.', + 'required' => false, + 'default' => null, + 'example' => false, + ]) + ->addRule('emailIsCorporate', [ + 'type' => self::TYPE_BOOLEAN, + 'description' => 'Whether the user email is from a corporate domain.', + 'required' => false, + 'default' => null, + 'example' => true, + ]) + ->addRule('emailIsCanonical', [ + 'type' => self::TYPE_BOOLEAN, + 'description' => 'Whether the user email is in its canonical form.', + 'required' => false, + 'default' => null, + 'example' => true, + ]) ->addRule('phoneVerification', [ 'type' => self::TYPE_BOOLEAN, 'description' => 'Phone verification status.', diff --git a/tests/e2e/Services/Account/AccountBase.php b/tests/e2e/Services/Account/AccountBase.php index 8b4dfd4e3e..1804e621de 100644 --- a/tests/e2e/Services/Account/AccountBase.php +++ b/tests/e2e/Services/Account/AccountBase.php @@ -43,11 +43,11 @@ trait AccountBase $this->assertNotEmpty($response['body']['accessedAt']); $this->assertArrayHasKey('targets', $response['body']); $this->assertEquals($email, $response['body']['targets'][0]['identifier']); - $this->assertArrayNotHasKey('emailCanonical', $response['body']); - $this->assertArrayNotHasKey('emailIsFree', $response['body']); - $this->assertArrayNotHasKey('emailIsDisposable', $response['body']); - $this->assertArrayNotHasKey('emailIsCorporate', $response['body']); - $this->assertArrayNotHasKey('emailIsCanonical', $response['body']); + $this->assertEquals($email, $response['body']['emailCanonical']); + $this->assertIsBool($response['body']['emailIsFree']); + $this->assertIsBool($response['body']['emailIsDisposable']); + $this->assertIsBool($response['body']['emailIsCorporate']); + $this->assertIsBool($response['body']['emailIsCanonical']); /** * Test for FAILURE diff --git a/tests/e2e/Services/Users/UsersBase.php b/tests/e2e/Services/Users/UsersBase.php index b06e2d88e1..eeadbfa925 100644 --- a/tests/e2e/Services/Users/UsersBase.php +++ b/tests/e2e/Services/Users/UsersBase.php @@ -337,6 +337,11 @@ trait UsersBase $this->assertEquals($body['status'], true); $this->assertGreaterThan('2000-01-01 00:00:00', $body['registration']); $this->assertEquals($body['labels'], []); + $this->assertEquals('cristiano.ronaldo@manchester-united.co.uk', $body['emailCanonical']); + $this->assertEquals(false, $body['emailIsFree']); + $this->assertEquals(false, $body['emailIsDisposable']); + $this->assertEquals(true, $body['emailIsCorporate']); + $this->assertEquals(true, $body['emailIsCanonical']); /** * Test Create with Custom ID for SUCCESS @@ -751,6 +756,11 @@ trait UsersBase } } $this->assertNotNull($user1, 'user1 should exist in user list'); + $this->assertArrayHasKey('emailCanonical', $user1); + $this->assertArrayHasKey('emailIsFree', $user1); + $this->assertArrayHasKey('emailIsDisposable', $user1); + $this->assertArrayHasKey('emailIsCorporate', $user1); + $this->assertArrayHasKey('emailIsCanonical', $user1); // This test ensures that by default, endpoints dont support select queries // If we add select query to this endpoint, you will need to remove this test @@ -1092,6 +1102,11 @@ trait UsersBase $this->assertNotEmpty($user['body']['email']); $this->assertEquals($user['body']['status'], true); $this->assertGreaterThan('2000-01-01 00:00:00', $user['body']['registration']); + $this->assertArrayHasKey('emailCanonical', $user['body']); + $this->assertArrayHasKey('emailIsFree', $user['body']); + $this->assertArrayHasKey('emailIsDisposable', $user['body']); + $this->assertArrayHasKey('emailIsCorporate', $user['body']); + $this->assertArrayHasKey('emailIsCanonical', $user['body']); $sessions = $this->client->call(Client::METHOD_GET, '/users/' . $data['userId'] . '/sessions', array_merge([ 'content-type' => 'application/json',