# Athena EVS
[![N|Solid](https://cldup.com/dTxpPi9lDf.thumb.png)](https://athenaevs.com/images/athena_evs_logo.svg?v=1)

# Oveview
Athena EVS helps verifies the validity and deliverability of an email address. We ensure that email addresses in your list are accurate and active, which helps improve email marketing campaigns, reduce bounce rates, and maintain a clean email list. Here are the key functions of Athena EVS:

- **Syntax Check**: Validates the format of an email address according to standard email syntax rules.
- **Domain Check**: Verifies that the domain of the email address (e.g., gmail.com) exists and can receive emails.
- **MX Record Check**: Checks the Mail Exchange (MX) records of the domain to ensure it is set up to receive emails.
- **Disposable Email Detection**: Identifies temporary or disposable email addresses often used for short-term purposes.
- **Role-based Account Detection**: Identifies addresses associated with roles (e.g., info@, support@) which are not typically linked to a specific person.
- **Spam Trap Detection**: Detects known spam traps to help avoid blacklisting and other deliverability issues.
- **Email Ping/SMTP Check**: Pings the email address or initiates an SMTP handshake to check if the mailbox exists and is active, without sending an actual email.

Athena from Japan helps individuals and organizations maintain their sender reputation, increase email campaign effectiveness, and ensure compliance with anti-spam regulations.
# Installation
Install from Composer:
```php
composer require athenaevs/athenaevs-php
composer install
```
# Single email address verification
Once the SDK is installed, you can use it to verify a single email address like this
```php
use AthenaEvs\Client;

$client = new Client($api = 'Your API Key');
$response = $client->verify('[email protected]');

print_r( $response ); // something like [ 'success' => true, 'result' => 'deliverable' ]
```
# Batch verification
You can also verify a batch of multiple emails address within a single API request as follows
```php
use AthenaEvs\Client;

$client = new Client($api = 'Your API Key');
$response = $client->batchVerify([ '[email protected]', '[email protected]', ...]);

print_r( $response ); // something like [ 'success' => true, 'batch_id' => '100093' ]
```
The batch verify API returns a batch ID. You can use this batch ID to query the verification progress
```php
$response = $client->checkProgress( 100093 )

// Sample results
// [ 'status' => 'In queue', 'percentage' => 0.72 ]
```
Once the verification process is complete, it will return a `complete` status and the verification results can be retrived by the GET RESULT API
```php
$response = $client->getResult( 100093 )
```

```php
// Sample response
{
  "email_batch": [
      {
          "address": "[email protected]",
          "status": "valid",
          "sub_status": "",
          "free_email": false,
          "did_you_mean": null,
          "account": null,
          "domain": null,
          "domain_age_days": "9692",
          "smtp_provider": "example",
          "mx_found": "true",
          "mx_record": "mx.example.com",
          "firstname": "zero",
          "lastname": "bounce",
          "gender": "male",
          "country": null,
          "region": null,
          "city": null,
          "zipcode": null,
          "processed_at": "2020-09-17 17:43:11.829"
      },
      {
          "address": "[email protected]",
          "status": "invalid",
          "sub_status": "mailbox_not_found",
          "free_email": false,
          "did_you_mean": null,
          "account": null,
          "domain": null,
          "domain_age_days": "9692",
          "smtp_provider": "example",
          "mx_found": "true",
          "mx_record": "mx.example.com",
          "firstname": "zero",
          "lastname": "bounce",
          "gender": "male",
          "country": null,
          "region": null,
          "city": null,
          "zipcode": null,
          "processed_at": "2020-09-17 17:43:11.830"
      },
      {
          "address": "[email protected]",
          "status": "do_not_mail",
          "sub_status": "disposable",
          "free_email": false,
          "did_you_mean": null,
          "account": null,
          "domain": null,
          "domain_age_days": "9692",
          "smtp_provider": "example",
          "mx_found": "true",
          "mx_record": "mx.example.com",
          "firstname": "zero",
          "lastname": "bounce",
          "gender": "male",
          "country": null,
          "region": null,
          "city": null,
          "zipcode": null,
          "processed_at": "2020-09-17 17:43:11.830"
      }
  ]
}
```
See [our API Documentation](https://api.athenaevs.com) for the details of request / response format.
# Reference
Contact us for further assistance and cooperation at [Rencontru LTD.](https://rencontru.com)