Documentation Powered by ReDoc

Email Academy API (1.0.0)

Download OpenAPI specification:Download

Email Academy API provides the usage of its various tools through an API

Tool Limits

Tool Limits

Get tool usage Limits

Each tool has its own usage limits. This endpoint provides the current usage and limits for the given tool.

query Parameters
api_key
required
string
Example: api_key=your-api-key

The user's API key

tool
required
string
Enum: "blacklist_checker" "email_verifier" "bounce_code_analyzer" "inbox_tester" "spfdkim_tester" "rdns_tester" "blacklist_monitor" "website_monitor"
Example: tool=email_verifier

The name of the tool

Responses

Request samples 

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'api.emailacademy.com/v1/tool-limits?api_key=your-api-key&tool=email_verifier',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response samples

Content type
application/json
{
  • "limit": 500,
  • "used": 325,
  • "period": "monthly"
}

Blacklist Checker

Blacklist checker

Validate IP or domain

Validate an IP or domain through various blacklists

Request Body schema: application/json

Request parameters for blacklist checker

host
string

The domain or IP

api_key
string

The user's API key

Responses

Request samples

Content type
application/json
{
  • "api_key": "your-api-key",
  • "host": "example.com"
}

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Validate IP or domain

Validate an IP or domain through various blacklists

query Parameters
api_key
required
string
Example: api_key=your-api-key

The user's API key

host
required
string
Example: host=example.com

The domain or IP

Responses

Request samples 

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'api.emailacademy.com/v1/blacklist?api_key=your-api-key&host=example.com',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Analyze a file

Upload a file of IPs and domains for blacklist check

Request Body schema: multipart/form-data

Request parameters for uploading a file

file
required
any <binary>

The file containing the IPs and domains

api_key
required
string

The user's API key

Responses

Request samples 

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'api.emailacademy.com/v1/blacklist/file/check',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('api_key' => 'your-api-key','file'=> new CURLFILE('/path/to/file')),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response samples

Content type
application/json
{
  • "file_id": "1628750661SHYNuWITqYoeWc"
}

Get file information

Get a list of files with detailed information of the files

query Parameters
api_key
required
string
Example: api_key=your-api-key

The user's API key

offset
string
Example: offset=5

Optional offset for pagination. Defaults to 0

count
string
Example: count=15

Optional count for pagination. Defaults to 10

file_id
string
Example: file_id=1628750661SHYNuWITqYoeWc

Optional file ID filter. Exact file ID must be given.

file_name
string
Example: file_name=bounce

Optional file name filter. The given string will be looked up in the file name.

Responses