https://github.com/net-tools/mail-checker
https://github.com/net-tools/mail-checker
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/net-tools/mail-checker
- Owner: net-tools
- License: mit
- Created: 2021-03-15T10:35:24.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-29T16:16:02.000Z (about 2 years ago)
- Last Synced: 2025-06-08T11:08:27.179Z (about 1 year ago)
- Language: PHP
- Size: 57.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# net-tools/mail-checker
## Composer library to check email existence through several webservices
## Setup instructions
To install net-tools/mailing package, just require it through composer : `require net-tools/mail-checker:^1.0.0`.
## How to use ?
This project makes it possible to check email existence through several webservices :
```php
// getting an API object of the desired webservice, and then creating checker object (api key and timeout as parameters)
$checker = new Checker(APIs\Bouncer::create('api_key_here', 6));
// do some checking stuff
if ( $checker->check('my_recipient@outlook.com'))
echo "ok";
else
echo "ko";
```
You can also upload an array of email addresses that the webservice will process (depending on the API used, it may answer with a task id to check later, either through a specific API call or by visiting the website)
```php
$api = APIs\Bouncer::create('api_key_here', 6);
$checker = new Checker($api);
$taskid = $checker->upload(['address1@me.com', 'otheraddress@here.com']);
// ...
// later check task processing status
if ( $api->status($taskid) )
$json = $api->download($taskid);
```
The APIs supported are : Bouncer (api key required), EmailValidator (api key required) and Trumail.io.
## PHPUnit
To test with PHPUnit, point the -c configuration option to the /phpunit.xml configuration file.