This is the official python wrapper for the Emailable API.
See the Python API docs.
pip install emailable
The Emailable API requires either an API key or an access token for authentication. API keys can be created and managed in the Emailable Dashboard.
An API key can be set globally for the Emailable client:
client = emailable.Client('your_api_key')
Or, you can specify an api_key or an access_token with each request:
# set api_key at request time client.verify(api_key='your_api_key') # set access_token at request time client.verify(access_token='your_access_token')
# verify an email address response = client.verify('[email protected]') response.state => 'deliverable' # additional parameters are available. see API docs for more info. client.verify('[email protected]', smtp=False, accept_all=True, timeout=25)
Some email servers are slow to respond. As a result, the timeout may be reached before we are able to complete the verification process. If this happens, the verification will continue in the background on our servers. We recommend sleeping for at least one second and trying your request again. Re-requesting the same verification with the same options will not impact your credit allocation within a 5 minute window.
A slow response will return with a 249 status code.
response = client.verify('[email protected]') response.status_code => 249 response.message => 'Your request is taking longer than normal. Please send your request again.'
emails = ['[email protected]', '[email protected]', ...] response = client.batch(emails) response.id => '5cff27400000000000000000' # you can optionally pass in a callback url that we'll POST to when the # batch is complete. response = client.batch(emails, {'url': 'https://emailable.com/'})
To get the status of a batch call batch_status with the batch's id. If your batch is still being processed, you will receive a message along with the current progress of the batch. When a batch is completed, you can access the results in the emails attribute.
response = client.batch_status('5cff27400000000000000000') # if your batch is still running response.processed => 1 response.total => 2 response.message => 'Your batch is being processed.' # if your batch is complete response.emails => [{'email': '[email protected]', 'state': 'deliverable'...}, {'email': '[email protected]', 'state': 'deliverable'...}...] # get the counts response.total_counts =>{'deliverable': 2, 'undeliverable': 0 ...} response.reason_counts =>{'accepted_email': 2, 'rejected_email': 0 ...}
Tests can be run with the following command:
pytest
Run make release VERSION=x.y.z on an up to date master with a clean tree,
then git push --follow-tags. It runs the tests, bumps VERSION, commits,
and tags x.y.z. Pushing the tag triggers the release workflow, which
publishes to PyPI and creates the GitHub release.
Bug reports and pull requests are welcome on GitHub at https://github.com/emailable/emailable-python.