Email Insights
AI-Driven Data Trust

{
  "emailAddress": "some-email@some-domain.com",
  "emailProvider": "Google",
  "emailType": "free", // disposable, private
  "isDeliverable": "no", // yes, no, unknown
  "isMailboxFull": true,
  "riskReport": {
    "score": 650, // 200–1000
    "level": "high", // lowest, low, medium, high, highest
    "baseAnalysis": [
      "instance-bounce",
      "future-bounce",
      "fraud"
    ]
  },
  "isFormatValid": true,
  "isCatchAll": false,
  "isReachable": true,
  "emailCorrection": "some-email@somedomain.com",
  "emailDNS": {
    "mx": [
      "mx1.example.com",
      "mx2.example.com"
    ]
  }
}

import { EmailInsights } from '@opportify/sdk-nodejs';

const clientEmailInsights = new EmailInsights({
  version: '1.0',
  apiKey: 'YOUR_API_KEY'
});

async function analyzeEmail() {
  try {
    const response = await clientEmailInsights.analyze({
      email: "email_to_validate@domain.com",
      enableAutoCorrection: true,
      enableAI: true, // only available on paid plans.
    });
    console.log('response', response);
  } catch (error: unknown) {
    console.error('error', error);
  }
}

analyzeEmail();

use Opportify\Sdk\EmailInsights;

$emailInsights = new EmailInsights("YOUR-API-KEY-HERE");

$params = [
    "email" => "test@gmail.com",
    "enableAi" => true,
    "enableAutoCorrection" => true
];

$result = $emailInsights->analyze($params);

// Import classes:
import ai.opportify.client.ApiClient;
import ai.opportify.client.ApiException;
import ai.opportify.client.Configuration;
import ai.opportify.client.auth.*;
import ai.opportify.client.model.*;
import ai.opportify.client.api.EmailInsightsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.opportify.ai/insights/v1");

    // Configure API key authorization: opportifyToken
    ApiKeyAuth opportifyToken = (ApiKeyAuth) defaultClient.getAuthentication("opportifyToken");
    opportifyToken.setApiKey("YOUR API KEY");

    EmailInsightsApi apiInstance = new EmailInsightsApi(defaultClient);
    AnalyzeEmailRequest analyzeEmailRequest = new AnalyzeEmailRequest();
    analyzeEmailRequest.email("email_to_validate@domain.com");
    analyzeEmailRequest.enableAutoCorrection(true);
    analyzeEmailRequest.enableAI(true); // only available for paid plans.
    try {
      AnalyzeEmail200Response result = apiInstance.analyzeEmail(analyzeEmailRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling EmailInsightsApi#analyzeEmail");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

from opportify_sdk import EmailInsights

# Initialize the wrapper with your API key
api_key = "<YOUR-API-KEY-HERE>"
email_insights = EmailInsights(api_key)

# Optional: Configure host, version, and debug mode
email_insights.set_version("v1")

# Define request parameters
params = {
    "email": "<SOME-EMAIL-HERE>",
    "enableAutoCorrection": True,
    "enableAi": True
}

# Call the API
try:
    result = email_insights.analyze(params)
    print("Response:", result)
except Exception as e:
    print(f"Error: {e}")