verifyforge 1.0.1

Official Python SDK for VerifyForge Email Validation API

VerifyForge Python SDK - Email Validation API

Official Python SDK for the VerifyForge Email Validation API.

Features

• 🔍 Hybrid Validation - Syntax, MX records, SMTP verification, and disposable detection
• ⚡ Fast & Reliable - Optimized for speed with smart caching
• 🚀 Bulk Processing - Validate up to 100 emails in a single request
• 💯 Type Safe - Full type hints for better IDE support
• 🛡️ Error Handling - Comprehensive error handling with custom exceptions
• 🔐 Secure - API key authentication

Installation

pip install verifyforge

Quick Start

from verifyforge import VerifyForge

# Initialize the client
client = VerifyForge(api_key="your_api_key_here")

# Validate a single email
result = client.validate("[e-mail]")

if result.data.is_valid:
    print(f"✓ Email is valid!")
    print(f"Reachability: {result.data.reachability}")
else:
    print(f"✗ Email is invalid")

print(f"Credits remaining: {result.remaining_credits}")

Usage Examples

Single Email Validation

from verifyforge import VerifyForge

client = VerifyForge(api_key="your_api_key")

# Validate an email
result = client.validate("[e-mail]")

# Access validation details
print(f"Email: {result.data.email}")
print(f"Valid: {result.data.is_valid}")
print(f"Disposable: {result.data.disposable}")
print(f"Role Account: {result.data.role_account}")
print(f"Free Provider: {result.data.free_provider}")
print(f"Reachability: {result.data.reachability}")

# Check MX records
for mx in result.data.mx_records_list:
    print(f"MX: {mx.exchange} (priority: {mx.priority})")

# SMTP analysis
smtp = result.data.smtp
if smtp.connection_successful:
    print(f"SMTP accepts mail: {smtp.accepts_mail}")

Bulk Email Validation

from verifyforge import VerifyForge

client = VerifyForge(api_key="your_api_key")

# Validate multiple emails
emails = [
    "[e-mail]",
    "[e-mail]",
    "[e-mail]",
]

result = client.validate_bulk(emails)

# Summary statistics
print(f"Total validated: {result.summary.total}")
print(f"Duplicates removed: {result.summary.duplicates_removed}")
print(f"Credits used: {result.credits_used}")

# Individual results
for item in result.results:
    status = "✓" if item.is_valid else "✗"
    print(f"{status} {item.email} - {item.reachable}")

Error Handling

from verifyforge import (
    VerifyForge,
    VerifyForgeError,
    AuthenticationError,
    InsufficientCreditsError,
    ValidationError,
)

client = VerifyForge(api_key="your_api_key")

try:
    result = client.validate("[e-mail]")
except AuthenticationError:
    print("Invalid API key")
except InsufficientCreditsError:
    print("Not enough credits")
except ValidationError as e:
    print(f"Validation error: {e.message}")
    print(f"Details: {e.details}")
except VerifyForgeError as e:
    print(f"API error: {e}")

Using Context Manager

from verifyforge import VerifyForge

# Automatically closes the session when done
with VerifyForge(api_key="your_api_key") as client:
    result = client.validate("[e-mail]")
    print(f"Valid: {result.data.is_valid}")

Advanced Configuration

from verifyforge import VerifyForge

# Custom base URL and timeout
client = VerifyForge(
    api_key="your_api_key",
    base_url="https://custom-domain.com",  # Optional
    timeout=60,  # Request timeout in seconds
)

API Reference

VerifyForge

Main client class for interacting with the VerifyForge API.

Constructor

VerifyForge(api_key: str, base_url: str = "https://verifyforge.com", timeout: int = 30)

Parameters:

• api_key (str): Your VerifyForge API key
• base_url (str, optional): Base URL for the API. Defaults to "https://verifyforge.com"
• timeout (int, optional): Request timeout in seconds. Defaults to 30

Methods

validate(email: str) -> ValidationResponse

Validate a single email address.

Parameters:

• email (str): Email address to validate

Returns:

• ValidationResponse: Complete validation results

Raises:

• ValidationError: If email format is invalid
• InsufficientCreditsError: If account has insufficient credits
• APIError: If validation fails

validate_bulk(emails: List[str]) -> BulkValidationResponse

Validate multiple email addresses (up to 100).

Parameters:

• emails (List[str]): List of email addresses to validate

Returns:

• BulkValidationResponse: Results for all emails with summary

Raises:

• ValidationError: If email list is invalid or exceeds 100 emails
• InsufficientCreditsError: If account has insufficient credits
• APIError: If validation fails

Response Types

ValidationResponse

@dataclass
class ValidationResponse:
    success: bool
    data: ValidationResult
    credits_used: int
    remaining_credits: int
    validation_duration: Optional[int]
    api_version: Optional[str]

ValidationResult

@dataclass
class ValidationResult:
    email: str
    is_valid: bool
    syntax: SyntaxValidation
    mx_records_list: List[MXRecord]
    smtp: SMTPAnalysis
    disposable: bool
    role_account: bool
    free_provider: bool
    reachability: str  # "safe", "risky", "invalid", "unknown"
    suggestion: Optional[str]
    gravatar: Optional[Gravatar]

BulkValidationResponse

@dataclass
class BulkValidationResponse:
    success: bool
    results: List[BulkValidationResult]
    summary: BulkValidationSummary
    credits_used: int
    remaining_credits: int
    duration: Optional[int]
    api_version: Optional[str]

Exceptions

All exceptions inherit from VerifyForgeError:

• AuthenticationError: Invalid API key (401)
• InsufficientCreditsError: Insufficient credits (402)
• ValidationError: Request validation failed (400)
• RateLimitError: Rate limit exceeded (429)
• APIError: General API error (5xx)

Requirements

• Python 3.8+
• requests >= 2.31.0

Development

# Clone the repository
git clone https://github.com/VerifyForge/python-sdk.git
cd python-sdk

# Install development dependencies
pip install -e ".[dev]"

# Run tests
pytest

# Run type checking
mypy verifyforge

# Format code
black verifyforge

# Lint code
ruff check verifyforge

Support

• 📧 Email: [e-mail]
• 📚 Documentation: https://verifyforge.com/api-docs
• 🐛 Bug Reports: https://github.com/VerifyForge/python-sdk/issues

License

This project is licensed under the MIT License - see the LICENSE file for details.

Links

• VerifyForge Website
• API Documentation
• Get API Key