Overview

The client library for Bulk Email Verification API in Python language.

The minimum Python version is 3.6.

Installation

pip install bulk-email-verifier

Examples

Full API documentation available here

Create a new client

from bulkemailverifier import *

client = Client('Your API key')

Create bulk request

emails = [
    'example@example.com',
    'test@example.org',
    'test'
]

request_id = client.create_request(emails=emails)

Get request status

result = client.get_status(request_ids=[request_id])

# Finished once result.data[i].ready == True
print(result)

Get email records

completed = client.get_records(request_id=request_id)

# Invalid and failed emails
failed = client.get_records(request_id=request_id, return_failed=True)

List your requests

result = client.get_requests()

Download CSV result

client.download(filename='emails.csv', request_id=request_id)

Extras

# Paginate over request IDs in descending order and get results in XML
result = client.get_requests_raw(
    only_ids=True,
    page=2,
    per_page=20,
    sort=Client.SORT_DESC,
    output_format=Client.XML_FORMAT
)

Response model overview

ResponseRecords:
    - data: [Record]
        - email_address: str
        - format_check: bool
        - smtp_check: bool
        - dns_check: bool
        - free_check: bool
        - disposable_check: bool
        - catch_all_check: bool
        - result: str
        - error: str
        - mx_records: [str]

ResponseRequests:
    - current_page: int
    - from_requests: int
    - last_page: int
    - per_page: int
    - to_requests: int
    - total: int
    - data: [BulkRequest]
        - id: int
        - date_start: datetime.datetime
        - total_emails: int
        - invalid_emails: int
        - processed_emails: int
        - failed_emails: int
        - ready: bool

ResponseStatus:
    - data: [BulkRequest]