Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aman00323/email-checker
Provides email verification on the go.
https://github.com/aman00323/email-checker
curl disposable-emails dns email email-check email-checker email-exists email-validation email-verification email-verifier extract-records fsockopen laravel-email-verification laravel-framework laravel-package mx-record php php7 verification verify
Last synced: about 14 hours ago
JSON representation
Provides email verification on the go.
- Host: GitHub
- URL: https://github.com/aman00323/email-checker
- Owner: aman00323
- License: mit
- Created: 2019-05-02T09:02:27.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-02T10:57:59.000Z (almost 2 years ago)
- Last Synced: 2024-12-15T02:04:39.985Z (8 days ago)
- Topics: curl, disposable-emails, dns, email, email-check, email-checker, email-exists, email-validation, email-verification, email-verifier, extract-records, fsockopen, laravel-email-verification, laravel-framework, laravel-package, mx-record, php, php7, verification, verify
- Language: PHP
- Homepage:
- Size: 274 KB
- Stars: 152
- Watchers: 7
- Forks: 30
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Email Checker
 [](https://madewithlaravel.com/p/email-checker/shield-link) [](https://GitHub.com/aman00323/StrapDown.js/graphs/commit-activity) [](https://github.com/aman00323/email-checker/blob/master/LICENSE) [](https://github.com/aman00323/email-checker/releases)
Email Checker was created and maintained by [Aman Nurani](https://github.com/aman00323). It provides a powerful email validating system for both development and production for Laravel. It uses [fsockopen()](https://www.php.net/manual/en/function.fsockopen.php), [cURL](https://www.php.net/manual/en/book.curl.php) and many more to validate email address exists or not in real world.
Nowadays most of websites are using registration process where they need to verify user's ownership. Mostly developers verify email by sending email verification link to the email, So this will store extra email in database (if they were not exists in real). Additionally some people use [disposable emails](https://en.wikipedia.org/wiki/Disposable_email_address) for temporary usage.
# :tada: WE HAVE MORE THAN 25K DIPOSABLE DOMAIN LIST :tada:
THIS PACKAGE WILL HELP YOU TO VERIFY EMAIL
## Installation
Email Checker requires [PHP](https://php.net) > 7.0. This particular version supports with latest [Laravel](https://laravel.com/).
To get the latest version, simply require the project using [Composer](https://getcomposer.org):
```bash
$ composer require aman00323/emailchecker
```
Once installed, You need to include `Aman\EmailVerifier\EmailChecker` to access methods for email verify.
## Usage
### Check Disposable Emails
If you want to check email is [disposable emails](https://en.wikipedia.org/wiki/Disposable_email_address) or not then you can use the following function of [emailchecker](https://github.com/aman00323/email-verifier/)
***Added new option to check disposable emails***
This option is part of checkDisposableEmail() method, you need to pass second argument as true.
When you pass true inside helper will check emails with list of dispossable. which are hosted on gist, So whenever list will be changed you would't have to update package.
```php
app(EmailChecker::class)->checkDisposableEmail('[email protected]','boolean'));
```
This email verification will be done on the basis of [disposable emails](https://en.wikipedia.org/wiki/Disposable_email_address) list, This function will check if entered email address is in the list of disposable or not.
### Check DNS And MX Records
*For better output you need to set from email address for this method*
```php
app(EmailChecker::class)->setFromEmail('[email protected]','boolean'));
```
OR
Set ENV variable in your .env
```php
EMAIL_CHECKER_SET_FROM='[email protected]'
```
Another usage is to check [DNS](https://en.wikipedia.org/wiki/Domain_Name_System) and [MX Record](https://en.wikipedia.org/wiki/MX_record) of the email address, In this method package will try to extract records from email address and try to verify using [SMTP](https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol).
If this method will successfully extract records, then it will try to send HELLO message on the email address using [fsockopen()](https://www.php.net/manual/en/function.fsockopen.php), if it get valid status from MAIL server then it will return true. Also function will return true if it is not verify with the detail message.
```php
app(EmailChecker::class)->checkMxAndDnsRecord('[email protected]'));
```
This will return array with success and details, Details will indicate email verified with any exception or not.
For better output your server needs to support [fsockopen()](https://www.php.net/manual/en/function.fsockopen.php).
### Check Domain Status
Sometime it is hard to identify that email exist or not based on DNS and MX Records, So this method will check the domain status using [cURL](https://www.php.net/manual/en/book.curl.php).
This method ensures that email which is given has valid domain.
```php
app(EmailChecker::class)->checkDomain('[email protected]'));
```
This method will return TRUE or FALSE, if it successfully get response then it will return TRUE. Response validates based on [HTTP Status Code](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes).
### Check Email
This method will use all of the methods and it gives detail response, if it gives TRUE.
If any of the method will respond with FALSE then will not give detail report.
```php
app(EmailChecker::class)->checkEmail('[email protected]','boolean'));
```
As we have added new option with checkDisposableEmail() which has second argument that will enable deep check to compare domain with large list.
Don't worry it would't take too much time. :smile:
All are different method you can use individually as per your requirement. To call all of the method at once use **Check Email**
## Future Developement
Please let add your ideas to improve this package.
## Contribution
All contributer are welcome, Code must follow [PSR2](https://www.php-fig.org/psr/psr-2/). create feature branch to compare with email checker. Your code must pass testcases.
**NOTE** : This package will not ensure to verify each and email address, some of them cannot be verify due to MAIL server securities.