mailsafepro
MailSafePro - the Ruby gem for the Email Validation API — Enterprise-grade Email Verification
API robusta y segura para validación y verificación de correos electrónicos. Soporta verificación individual y en lote, detección de brechas, y autenticación JWT. Cumple con GDPR y dispone de planes de pago flexibles.
🔗 Enlaces importantes:
📧 Contacto: [email protected]
This SDK is automatically generated by the OpenAPI Generator project:
- API version: 2.5.0
- Package version: 1.0.0
- Generator version: 7.18.0
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
Installation
Build a gem
To build the Ruby code into a gem:
gem build mailsafepro.gemspec
Then either install the gem locally:
gem install ./mailsafepro-1.0.0.gem
(for development, run gem install --dev ./mailsafepro-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 'mailsafepro', '~> 1.0.0'
Install from Git
If the Ruby gem is hosted at a git repository: https://github.com/mailsafepro/mailsafepro-ruby, then add the following in the Gemfile:
gem 'mailsafepro', :git => 'https://github.com/mailsafepro/mailsafepro-ruby.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 'mailsafepro'
# Setup authorization
MailSafePro.configure do |config|
# Configure Bearer authorization (JWT): Bearer
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 = MailSafePro::APIKeysApi.new
api_key_create_request = MailSafePro::APIKeyCreateRequest.new # APIKeyCreateRequest |
begin
#Create Api Key
result = api_instance.create_api_key_api_keys_post(api_key_create_request)
p result
rescue MailSafePro::ApiError => e
puts "Exception when calling APIKeysApi->create_api_key_api_keys_post: #{e}"
end
Documentation for API Endpoints
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| MailSafePro::APIKeysApi | create_api_key_api_keys_post | POST /api-keys | Create Api Key |
| MailSafePro::APIKeysApi | create_api_key_api_keys_post_0 | POST /api-keys | Create Api Key |
| MailSafePro::APIKeysApi | force_sync_api_keys_force_sync_post | POST /api-keys/force-sync | Force Sync |
| MailSafePro::APIKeysApi | force_sync_api_keys_force_sync_post_0 | POST /api-keys/force-sync | Force Sync |
| MailSafePro::APIKeysApi | get_api_key_value_api_keys_key_hash_value_get | GET /api-keys/key_hash/value | Get Api Key Value |
| MailSafePro::APIKeysApi | get_api_key_value_api_keys_key_hash_value_get_0 | GET /api-keys/key_hash/value | Get Api Key Value |
| MailSafePro::APIKeysApi | get_usage_api_keys_usage_get | GET /api-keys/usage | Get Usage |
| MailSafePro::APIKeysApi | get_usage_api_keys_usage_get_0 | GET /api-keys/usage | Get Usage |
| MailSafePro::APIKeysApi | list_api_keys_api_keys_get | GET /api-keys | List Api Keys |
| MailSafePro::APIKeysApi | list_api_keys_api_keys_get_0 | GET /api-keys | List Api Keys |
| MailSafePro::APIKeysApi | repair_user_data_endpoint_api_keys_repair_data_post | POST /api-keys/repair-data | Repair User Data Endpoint |
| MailSafePro::APIKeysApi | repair_user_data_endpoint_api_keys_repair_data_post_0 | POST /api-keys/repair-data | Repair User Data Endpoint |
| MailSafePro::APIKeysApi | revoke_api_key_api_keys_key_hash_revoke_delete | DELETE /api-keys/key_hash/revoke | Revoke Api Key |
| MailSafePro::APIKeysApi | revoke_api_key_api_keys_key_hash_revoke_delete_0 | DELETE /api-keys/key_hash/revoke | Revoke Api Key |
| MailSafePro::APIKeysApi | rotate_api_key_api_keys_key_hash_rotate_post | POST /api-keys/key_hash/rotate | Rotate Api Key |
| MailSafePro::APIKeysApi | rotate_api_key_api_keys_key_hash_rotate_post_0 | POST /api-keys/key_hash/rotate | Rotate Api Key |
| MailSafePro::APIKeysApi | sync_plan_keys_api_keys_sync_plan_keys_post | POST /api-keys/sync-plan-keys | Sync Plan Keys |
| MailSafePro::APIKeysApi | sync_plan_keys_api_keys_sync_plan_keys_post_0 | POST /api-keys/sync-plan-keys | Sync Plan Keys |
| MailSafePro::AuthenticationApi | auth_health_check_auth_health_auth_get | GET /auth/health/auth | Auth Health Check |
| MailSafePro::AuthenticationApi | auth_health_check_auth_health_auth_get_0 | GET /auth/health/auth | Auth Health Check |
| MailSafePro::AuthenticationApi | auth_health_check_auth_health_auth_head | HEAD /auth/health/auth | Auth Health Check |
| MailSafePro::AuthenticationApi | auth_health_check_auth_health_auth_head_0 | HEAD /auth/health/auth | Auth Health Check |
| MailSafePro::AuthenticationApi | delete_account_auth_delete_delete | DELETE /auth/delete | Delete Account |
| MailSafePro::AuthenticationApi | delete_account_auth_delete_delete_0 | DELETE /auth/delete | Delete Account |
| MailSafePro::AuthenticationApi | get_current_user_auth_me_get | GET /auth/me | Get Current User |
| MailSafePro::AuthenticationApi | get_current_user_auth_me_get_0 | GET /auth/me | Get Current User |
| MailSafePro::AuthenticationApi | login_web_user_auth_login_post | POST /auth/login | Login Web User |
| MailSafePro::AuthenticationApi | login_web_user_auth_login_post_0 | POST /auth/login | Login Web User |
| MailSafePro::AuthenticationApi | logout_auth_logout_post | POST /auth/logout | Logout |
| MailSafePro::AuthenticationApi | logout_auth_logout_post_0 | POST /auth/logout | Logout |
| MailSafePro::AuthenticationApi | refresh_token_auth_refresh_post | POST /auth/refresh | Refresh Token |
| MailSafePro::AuthenticationApi | refresh_token_auth_refresh_post_0 | POST /auth/refresh | Refresh Token |
| MailSafePro::AuthenticationApi | register_web_user_auth_register_post | POST /auth/register | Register Web User |
| MailSafePro::AuthenticationApi | register_web_user_auth_register_post_0 | POST /auth/register | Register Web User |
| MailSafePro::AuthenticationApi | rotate_api_key_auth_rotate_key_post | POST /auth/rotate-key | Rotate Api Key |
| MailSafePro::AuthenticationApi | rotate_api_key_auth_rotate_key_post_0 | POST /auth/rotate-key | Rotate Api Key |
| MailSafePro::BillingApi | change_plan_billing_billing_change_plan_post | POST /billing/billing/change-plan | Change Plan |
| MailSafePro::BillingApi | change_plan_billing_billing_change_plan_post_0 | POST /billing/billing/change-plan | Change Plan |
| MailSafePro::BillingApi | create_checkout_session_billing_billing_create_checkout_session_post | POST /billing/billing/create-checkout-session | Create Checkout Session |
| MailSafePro::BillingApi | create_checkout_session_billing_billing_create_checkout_session_post_0 | POST /billing/billing/create-checkout-session | Create Checkout Session |
| MailSafePro::BillingApi | get_subscription_billing_billing_subscription_get | GET /billing/billing/subscription | Get Subscription |
| MailSafePro::BillingApi | get_subscription_billing_billing_subscription_get_0 | GET /billing/billing/subscription | Get Subscription |
| MailSafePro::BillingApi | stripe_webhook_billing_billing_webhook_post | POST /billing/billing/webhook | Stripe Webhook |
| MailSafePro::BillingApi | stripe_webhook_billing_billing_webhook_post_0 | POST /billing/billing/webhook | Stripe Webhook |
| MailSafePro::BillingApi | test_notification_billing_billing_test_notification_post | POST /billing/billing/test-notification | Test Notification |
| MailSafePro::BillingApi | test_notification_billing_billing_test_notification_post_0 | POST /billing/billing/test-notification | Test Notification |
| MailSafePro::DefaultApi | ask_gemini_gemini_get | GET /gemini | Ask Gemini |
| MailSafePro::DefaultApi | run_audit_admin_audit_project_post | POST /admin/audit_project | Run Audit |
| MailSafePro::DeveloperToolsApi | clear_request_logs_logs_logs_requests_delete | DELETE /logs/logs/requests | Clear Request Logs |
| MailSafePro::DeveloperToolsApi | get_request_logs_logs_logs_requests_get | GET /logs/logs/requests | Get Request Logs |
| MailSafePro::EmailValidationApi | batch_validate_emails_validate_batch_post | POST /validate/batch | Batch Email Validation |
| MailSafePro::EmailValidationApi | batch_validate_upload_validate_batch_upload_post | POST /validate/batch/upload | Batch Email Validation via File Upload |
| MailSafePro::EmailValidationApi | get_cache_stats_validate_stats_cache_get | GET /validate/stats/cache | Get Cache Stats |
| MailSafePro::EmailValidationApi | get_usage_stats_validate_stats_usage_get | GET /validate/stats/usage | Get Usage Stats |
| MailSafePro::EmailValidationApi | health_check_validate_health_get | GET /validate/health | Health Check |
| MailSafePro::EmailValidationApi | health_check_validate_health_head | HEAD /validate/health | Health Check |
| MailSafePro::EmailValidationApi | validate_email_endpoint_validate_email_post | POST /validate/email | Validate Email Endpoint |
| MailSafePro::HealthApi | basic_health_health_get | GET /health | Basic health check |
| MailSafePro::HealthApi | basic_health_health_get_0 | GET /health | Basic health check |
| MailSafePro::HealthApi | circuit_breaker_status_admin_circuit_breaker_status_get | GET /admin/circuit-breaker-status | Circuit Breaker Status |
| MailSafePro::HealthApi | detailed_health_health_detailed_get | GET /health/detailed | Detailed health check |
| MailSafePro::HealthApi | detailed_health_health_detailed_get_0 | GET /health/detailed | Detailed health check |
| MailSafePro::HealthApi | healthcheck_healthcheck_get | GET /healthcheck | Healthcheck |
| MailSafePro::HealthApi | healthcheck_healthcheck_head | HEAD /healthcheck | Healthcheck |
| MailSafePro::HealthApi | liveness_check_health_liveness_get | GET /health/liveness | Liveness Check |
| MailSafePro::HealthApi | liveness_health_live_get | GET /health/live | Liveness probe (Kubernetes) |
| MailSafePro::HealthApi | liveness_health_live_get_0 | GET /health/live | Liveness probe (Kubernetes) |
| MailSafePro::HealthApi | readiness_check_health_readiness_get | GET /health/readiness | Readiness Check |
| MailSafePro::HealthApi | readiness_health_ready_get | GET /health/ready | Readiness probe (Kubernetes) |
| MailSafePro::HealthApi | readiness_health_ready_get_0 | GET /health/ready | Readiness probe (Kubernetes) |
| MailSafePro::HealthApi | service_status_status_get | GET /status | Service Status |
| MailSafePro::HealthApi | startup_check_health_startup_get | GET /health/startup | Startup Check |
| MailSafePro::JobsApi | create_job_jobs_v1_jobs_post | POST /jobs/v1/jobs | Create validation job |
| MailSafePro::JobsApi | create_job_jobs_v1_jobs_post_0 | POST /jobs/v1/jobs | Create validation job |
| MailSafePro::JobsApi | get_job_results_jobs_v1_jobs_job_id_results_get | GET /jobs/v1/jobs/job_id/results | Get job results (paged) |
| MailSafePro::JobsApi | get_job_results_jobs_v1_jobs_job_id_results_get_0 | GET /jobs/v1/jobs/job_id/results | Get job results (paged) |
| MailSafePro::JobsApi | get_job_status_jobs_v1_jobs_job_id_get | GET /jobs/v1/jobs/job_id | Get job status |
| MailSafePro::JobsApi | get_job_status_jobs_v1_jobs_job_id_get_0 | GET /jobs/v1/jobs/job_id | Get job status |
| MailSafePro::LogsApi | clear_request_logs_logs_logs_requests_delete | DELETE /logs/logs/requests | Clear Request Logs |
| MailSafePro::LogsApi | get_request_logs_logs_logs_requests_get | GET /logs/logs/requests | Get Request Logs |
| MailSafePro::ValidationApi | batch_validate_emails_validate_batch_post | POST /validate/batch | Batch Email Validation |
| MailSafePro::ValidationApi | batch_validate_upload_validate_batch_upload_post | POST /validate/batch/upload | Batch Email Validation via File Upload |
| MailSafePro::ValidationApi | get_cache_stats_validate_stats_cache_get | GET /validate/stats/cache | Get Cache Stats |
| MailSafePro::ValidationApi | get_usage_stats_validate_stats_usage_get | GET /validate/stats/usage | Get Usage Stats |
| MailSafePro::ValidationApi | health_check_validate_health_get | GET /validate/health | Health Check |
| MailSafePro::ValidationApi | health_check_validate_health_head | HEAD /validate/health | Health Check |
| MailSafePro::ValidationApi | validate_email_endpoint_validate_email_post | POST /validate/email | Validate Email Endpoint |
| MailSafePro::WebhooksApi | create_webhook_webhooks_management_webhooks_post | POST /webhooks-management/webhooks/ | Create Webhook |
| MailSafePro::WebhooksApi | delete_webhook_webhooks_management_webhooks_webhook_id_delete | DELETE /webhooks-management/webhooks/webhook_id | Delete Webhook |
| MailSafePro::WebhooksApi | get_deliveries_webhooks_management_webhooks_webhook_id_deliveries_get | GET /webhooks-management/webhooks/webhook_id/deliveries | Get Deliveries |
| MailSafePro::WebhooksApi | get_webhook_webhooks_management_webhooks_webhook_id_get | GET /webhooks-management/webhooks/webhook_id | Get Webhook |
| MailSafePro::WebhooksApi | list_webhooks_webhooks_management_webhooks_get | GET /webhooks-management/webhooks/ | List Webhooks |
| MailSafePro::WebhooksApi | register_endpoint_webhooks_v1_webhooks_endpoints_register_post | POST /webhooks/v1/webhooks/endpoints/register | Register Endpoint |
| MailSafePro::WebhooksApi | register_endpoint_webhooks_v1_webhooks_endpoints_register_post_0 | POST /webhooks/v1/webhooks/endpoints/register | Register Endpoint |
| MailSafePro::WebhooksApi | rotate_secret_webhooks_v1_webhooks_endpoints_rotate_post | POST /webhooks/v1/webhooks/endpoints/rotate | Rotate Secret |
| MailSafePro::WebhooksApi | rotate_secret_webhooks_v1_webhooks_endpoints_rotate_post_0 | POST /webhooks/v1/webhooks/endpoints/rotate | Rotate Secret |
| MailSafePro::WebhooksApi | test_webhook_webhooks_management_webhooks_webhook_id_test_post | POST /webhooks-management/webhooks/webhook_id/test | Test Webhook |
| MailSafePro::WebhooksApi | update_webhook_webhooks_management_webhooks_webhook_id_patch | PATCH /webhooks-management/webhooks/webhook_id | Update Webhook |
| MailSafePro::WebhooksManagementApi | create_webhook_webhooks_management_webhooks_post | POST /webhooks-management/webhooks/ | Create Webhook |
| MailSafePro::WebhooksManagementApi | delete_webhook_webhooks_management_webhooks_webhook_id_delete | DELETE /webhooks-management/webhooks/webhook_id | Delete Webhook |
| MailSafePro::WebhooksManagementApi | get_deliveries_webhooks_management_webhooks_webhook_id_deliveries_get | GET /webhooks-management/webhooks/webhook_id/deliveries | Get Deliveries |
| MailSafePro::WebhooksManagementApi | get_webhook_webhooks_management_webhooks_webhook_id_get | GET /webhooks-management/webhooks/webhook_id | Get Webhook |
| MailSafePro::WebhooksManagementApi | list_webhooks_webhooks_management_webhooks_get | GET /webhooks-management/webhooks/ | List Webhooks |
| MailSafePro::WebhooksManagementApi | test_webhook_webhooks_management_webhooks_webhook_id_test_post | POST /webhooks-management/webhooks/webhook_id/test | Test Webhook |
| MailSafePro::WebhooksManagementApi | update_webhook_webhooks_management_webhooks_webhook_id_patch | PATCH /webhooks-management/webhooks/webhook_id | Update Webhook |
Documentation for Models
- MailSafePro::APIKeyCreateRequest
- MailSafePro::APIKeyListResponse
- MailSafePro::APIKeyMeta
- MailSafePro::BatchEmailResponse
- MailSafePro::BatchValidationRequest
- MailSafePro::BodyChangePlanBillingBillingChangePlanPost
- MailSafePro::CheckoutRequest
- MailSafePro::CheckoutSessionResponse
- MailSafePro::DNSInfo
- MailSafePro::DNSRecordDKIM
- MailSafePro::DNSRecordDMARC
- MailSafePro::DNSRecordSPF
- MailSafePro::EmailResponse
- MailSafePro::EmailValidationRequest
- MailSafePro::HTTPValidationError
- MailSafePro::JobCreateRequest
- MailSafePro::JobCreateResponse
- MailSafePro::JobResultEntry
- MailSafePro::JobResultsPage
- MailSafePro::JobStatusResponse
- MailSafePro::KeyRotationRequest
- MailSafePro::PlanEnum
- MailSafePro::PriorityEnum
- MailSafePro::RegisterEndpoint
- MailSafePro::ResponseTestNotificationBillingBillingTestNotificationPostValue
- MailSafePro::RiskLevelEnum
- MailSafePro::RotateSecret
- MailSafePro::SMTPInfo
- MailSafePro::SubscriptionResponse
- MailSafePro::UserLogin
- MailSafePro::UserRegister
- MailSafePro::ValidationError
- MailSafePro::ValidationErrorLocInner
- MailSafePro::WebhookCreate
- MailSafePro::WebhookResponse
- MailSafePro::WebhookUpdate
Documentation for Authorization
Authentication schemes defined for the API:
Bearer
- Type: Bearer authentication (JWT)
ApiKeyAuth
- Type: API key
- API key parameter name: X-API-Key
- Location: HTTP header