masroore/mailcheck-php

Reduce misspelled email addresses in your PHP apps.

0.1.5 2023-01-15 18:03 UTC

Requires

• php: ^8.1 || ^8.2
• ext-mbstring: *

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.8
• nunomaduro/collision: ^6.0
• nunomaduro/larastan: ^2.0.1
• orchestra/testbench: ^7.0
• pestphp/pest: ^1.21
• pestphp/pest-plugin-laravel: ^1.1
• phpstan/extension-installer: ^1.1
• phpstan/phpstan-deprecation-rules: ^1.0
• phpstan/phpstan-phpunit: ^1.0
• phpunit/phpunit: ^9.5

MIT

• Masroor Ehsan

• mailcheck
• mail check
• email typo
• domain typo

README

The PHP library that suggests a right domain when your users misspell it in an email address. See the original at https://github.com/mailcheck/mailcheck.

When your user types in "[e-mail]", Mailcheck will suggest "[e-mail]".

Mailcheck will offer up suggestions for second and top level domains too. For example, when a user types in "[e-mail]", "hotmail.com" will be suggested. Similarly, if only the second level domain is misspelled, it will be corrected independently of the top level domain.

Installation

Requires PHP 8.1+

You can install the package via composer:

composer require masroore/mailcheck

Usage

> $mailcheck = new Kaiju\Mailcheck\Mailcheck();
> print_r($mailcheck->suggest("[e-mail]"));

# Kaiju\Mailcheck\EmailSuggestion Object
# (
#     [fullAddress] => [e-mail]
#     [originalAddress] => [e-mail]
#     [account] => user
#     [domain] => gmail.com
# )

Returns null if no suggestion:

> $mailcheck->suggest("[e-mail]")
# => null

Domains

Mailcheck has inbuilt defaults if the domains, secondLevelDomains or topLevelDomains options aren't provided. We still recommend supplying your own domains based on the distribution of your users.

Adding your own Domains

You can replace Mailcheck's default domain/TLD suggestions by supplying replacements:

$mailcheck->setDomains(['customdomain.com', 'anotherdomain.net']); // replaces existing domains
$mailcheck->setSecondLevelDomains(['domain', 'yetanotherdomain']); // replaces existing SLDs
$mailcheck->setTopLevelDomains(['com.au', 'ru']);  // replaces existing TLDs

Contributing

Let's make Mailcheck awesome. We're on the lookout for maintainers and contributors.

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Maintainers

• Dr. Masroor Ehsan, Author.

License

Licensed under the MIT License.