mailodds

Mailodds - the Ruby gem for the MailOdds Email Validation API

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 SDK is automatically generated by the OpenAPI Generator project:

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

Installation

Build a gem

To build the Ruby code into a gem:

gem build mailodds.gemspec

Then either install the gem locally:

gem install ./mailodds-1.0.0.gem

(for development, run gem install --dev ./mailodds-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'mailodds', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/mailodds/ruby-sdk, then add the following in the Gemfile:

gem 'mailodds', :git => 'https://github.com/mailodds/ruby-sdk.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'mailodds'

# Setup authorization
Mailodds.configure do |config|
  # Configure Bearer authorization: BearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
  # Configure a proc to get access tokens in lieu of the static access_token configuration
  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
end

api_instance = Mailodds::BulkValidationApi.new
job_id = 'job_id_example' # String | 

begin
  #Cancel a job
  result = api_instance.cancel_job(job_id)
  p result
rescue Mailodds::ApiError => e
  puts "Exception when calling BulkValidationApi->cancel_job: #{e}"
end

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
Mailodds::BulkValidationApi	cancel_job	POST /v1/jobs/job_id/cancel	Cancel a job
Mailodds::BulkValidationApi	create_job	POST /v1/jobs	Create bulk validation job (JSON)
Mailodds::BulkValidationApi	create_job_from_s3	POST /v1/jobs/upload/s3	Create job from S3 upload
Mailodds::BulkValidationApi	create_job_upload	POST /v1/jobs/upload	Create bulk validation job (file upload)
Mailodds::BulkValidationApi	delete_job	DELETE /v1/jobs/job_id	Delete a job
Mailodds::BulkValidationApi	get_job	GET /v1/jobs/job_id	Get job status
Mailodds::BulkValidationApi	get_job_results	GET /v1/jobs/job_id/results	Get job results
Mailodds::BulkValidationApi	get_presigned_upload	POST /v1/jobs/upload/presigned	Get S3 presigned upload URL
Mailodds::BulkValidationApi	list_jobs	GET /v1/jobs	List validation jobs
Mailodds::EmailValidationApi	validate_batch	POST /v1/validate/batch	Validate multiple emails (sync)
Mailodds::EmailValidationApi	validate_email	POST /v1/validate	Validate single email
Mailodds::SuppressionListsApi	add_suppression	POST /v1/suppression	Add suppression entries
Mailodds::SuppressionListsApi	check_suppression	POST /v1/suppression/check	Check suppression status
Mailodds::SuppressionListsApi	get_suppression_stats	GET /v1/suppression/stats	Get suppression statistics
Mailodds::SuppressionListsApi	list_suppression	GET /v1/suppression	List suppression entries
Mailodds::SuppressionListsApi	remove_suppression	DELETE /v1/suppression	Remove suppression entries
Mailodds::SystemApi	get_telemetry_summary	GET /v1/telemetry/summary	Get validation telemetry
Mailodds::SystemApi	health_check	GET /health	Health check
Mailodds::ValidationPoliciesApi	add_policy_rule	POST /v1/policies/policy_id/rules	Add rule to policy
Mailodds::ValidationPoliciesApi	create_policy	POST /v1/policies	Create policy
Mailodds::ValidationPoliciesApi	create_policy_from_preset	POST /v1/policies/from-preset	Create policy from preset
Mailodds::ValidationPoliciesApi	delete_policy	DELETE /v1/policies/policy_id	Delete policy
Mailodds::ValidationPoliciesApi	delete_policy_rule	DELETE /v1/policies/policy_id/rules/rule_id	Delete rule
Mailodds::ValidationPoliciesApi	get_policy	GET /v1/policies/policy_id	Get policy
Mailodds::ValidationPoliciesApi	get_policy_presets	GET /v1/policies/presets	Get policy presets
Mailodds::ValidationPoliciesApi	list_policies	GET /v1/policies	List policies
Mailodds::ValidationPoliciesApi	test_policy	POST /v1/policies/test	Test policy evaluation
Mailodds::ValidationPoliciesApi	update_policy	PUT /v1/policies/policy_id	Update policy