mailodds

MailOdds provides email validation services to help maintain clean email lists and improve deliverability. The API performs multiple validation checks including format verification, domain validation, MX record checking, and disposable email detection.

Authentication

All API requests require authentication using a Bearer token. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

API keys can be created in the MailOdds dashboard.

Rate Limits

Rate limits vary by plan:

  • Free: 10 requests/minute
  • Starter: 60 requests/minute
  • Pro: 300 requests/minute
  • Business: 1000 requests/minute
  • Enterprise: Custom limits

Response Format

All responses include:

  • schema_version: API schema version (currently "1.0")
  • request_id: Unique request identifier for debugging

Error responses include:

  • error: Machine-readable error code
  • message: Human-readable error description

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Generator version: 7.19.0
  • Build package: org.openapitools.codegen.languages.DartClientCodegen For more information, please visit https://mailodds.com/contact

Requirements

Dart 2.12 or later

Installation & Usage

Github

If this Dart package is published to Github, add the following dependency to your pubspec.yaml

dependencies:
  mailodds:
    git: https://github.com/mailodds/dart-sdk.git

Local

To use the package in your local drive, add the following dependency to your pubspec.yaml

dependencies:
  mailodds:
    path: /path/to/mailodds

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

import 'package:mailodds/api.dart';

// TODO Configure HTTP Bearer authorization: BearerAuth
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('BearerAuth').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('BearerAuth').setAccessToken(yourTokenGeneratorFunction);

final api_instance = BulkValidationApi();
final jobId = jobId_example; // String | 

try {
    final result = api_instance.cancelJob(jobId);
    print(result);
} catch (e) {
    print('Exception when calling BulkValidationApi->cancelJob: $e\n');
}

Documentation for API Endpoints

All URIs are relative to https://api.mailodds.com/v1

Class Method HTTP request Description
BulkValidationApi cancelJob POST /v1/jobs/{job_id}/cancel Cancel a job
BulkValidationApi createJob POST /v1/jobs Create bulk validation job (JSON)
BulkValidationApi createJobFromS3 POST /v1/jobs/upload/s3 Create job from S3 upload
BulkValidationApi createJobUpload POST /v1/jobs/upload Create bulk validation job (file upload)
BulkValidationApi deleteJob DELETE /v1/jobs/{job_id} Delete a job
BulkValidationApi getJob GET /v1/jobs/{job_id} Get job status
BulkValidationApi getJobResults GET /v1/jobs/{job_id}/results Get job results
BulkValidationApi getPresignedUpload POST /v1/jobs/upload/presigned Get S3 presigned upload URL
BulkValidationApi listJobs GET /v1/jobs List validation jobs
EmailValidationApi validateBatch POST /v1/validate/batch Validate multiple emails (sync)
EmailValidationApi validateEmail POST /v1/validate Validate single email
SuppressionListsApi addSuppression POST /v1/suppression Add suppression entries
SuppressionListsApi checkSuppression POST /v1/suppression/check Check suppression status
SuppressionListsApi getSuppressionStats GET /v1/suppression/stats Get suppression statistics
SuppressionListsApi listSuppression GET /v1/suppression List suppression entries
SuppressionListsApi removeSuppression DELETE /v1/suppression Remove suppression entries
SystemApi getTelemetrySummary GET /v1/telemetry/summary Get validation telemetry
SystemApi healthCheck GET /health Health check
ValidationPoliciesApi addPolicyRule POST /v1/policies/{policy_id}/rules Add rule to policy
ValidationPoliciesApi createPolicy POST /v1/policies Create policy
ValidationPoliciesApi createPolicyFromPreset POST /v1/policies/from-preset Create policy from preset
ValidationPoliciesApi deletePolicy DELETE /v1/policies/{policy_id} Delete policy
ValidationPoliciesApi deletePolicyRule DELETE /v1/policies/{policy_id}/rules/{rule_id} Delete rule
ValidationPoliciesApi getPolicy GET /v1/policies/{policy_id} Get policy
ValidationPoliciesApi getPolicyPresets GET /v1/policies/presets Get policy presets
ValidationPoliciesApi listPolicies GET /v1/policies List policies
ValidationPoliciesApi testPolicy POST /v1/policies/test Test policy evaluation
ValidationPoliciesApi updatePolicy PUT /v1/policies/{policy_id} Update policy

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

  • Type: HTTP Bearer authentication

Author

support@mailodds.com

Libraries

api