Initial commit

Author: devnix

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*.php]
+indent_style = space
+# indent_size = 
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

.gitignore

@@ -0,0 +1,3 @@
+vendor/
+.phpunit.result.cache
+.php_cs.cache

.php_cs.dist

@@ -0,0 +1,16 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->in('src')
+    ->in('tests')
+;
+
+return PhpCsFixer\Config::create()
+    ->setRules([
+        '@Symfony' => true,
+        '@PSR2' => true,
+        // 'strict_param' => true,
+        'array_syntax' => ['syntax' => 'short'],
+    ])
+    ->setFinder($finder)
+;

README.md

@@ -0,0 +1,62 @@
+# Mailcheck for PHP
+
+Validate and suggest emails for your email inputs
+
+## Disclaimer
+
+This library uses by default a public data source to suggest various know email 
+providers.
+
+As this list is pretty much a work in progress you may be missing some domains, 
+so please feel free to open an issue or a pull request to improve it.
+
+## Installation
+
+`composer require devnix/mailcheck`
+
+## Usage
+
+You just need to initialize an instance to get a shiny suggestion service!
+
+```php
+use Devnix\Mailcheck\Mailcheck;
+
+$mailcheck = new Mailcheck();
+```
+
+Then you can ask for an array of suggestions, ordered by Levenshtein distance...
+
+```php
+$mailcheck->suggest('[email protected]');
+```
+
+```
+array:5 [
+  0 => "[email protected]"
+  1 => "[email protected]"
+  2 => "[email protected]"
+  3 => "[email protected]"
+  4 => "[email protected]"
+]
+```
+
+...or just the first coincidence
+
+```php
+$mailcheck->suggestOne('[email protected]');
+```
+
+```
+"[email protected]"
+```
+
+## Contributing
+
+You can help by reporting bugs, submitting pull requests, providing feedback 
+about your needs or bad suggestions. 
+
+You can execute all the tests by rugging `composer test`. We use tools like 
+[PHPStan](https://github.com/phpstan/phpstan), 
+[PHPUnit](https://github.com/sebastianbergmann/phpunit), and 
+[PHP CS Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer). We like to follow 
+the [Symfony Coding Standars](https://symfony.com/doc/current/contributing/code/standards.html).

composer.json

@@ -0,0 +1,44 @@
+{
+    "name": "devnix/mailcheck",
+    "description": "Provide email suggestions based on multiple dictionaries",
+    "type": "library",
+    "license": "GPLv3",
+    "authors": [
+        {
+            "name": "DevNIX",
+            "email": "[email protected]"
+        }
+    ],
+    "require": {
+        "ext-curl": "*",
+        "egulias/email-validator": "^2.1",
+        "layershifter/tld-extract": "^2.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "Devnix\\Mailcheck\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Devnix\\Mailcheck\\Tests\\": "tests/"
+        }
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^8.4",
+        "symfony/var-dumper": "^4.3",
+        "phpstan/phpstan": "^0.11.19",
+        "friendsofphp/php-cs-fixer": "^2.16"
+    },
+    "scripts": {
+        "lint": "./vendor/bin/php-cs-fixer fix --diff --dry-run",
+        "phpstan": "./vendor/bin/phpstan analyse -l 4 src tests",
+        "phpunit": "./vendor/bin/phpunit",
+        "fix": "./vendor/bin/php-cs-fixer fix",
+        "test": [
+            "@composer run lint",
+            "@composer run phpstan",
+            "@composer run phpunit"
+        ]
+    }
+}