View Source Tomba (tomba v0.1.0)
Documentation for Tomba.
Tomba: Tomba.io is an Email Finder for B2B sales and email marketing This is the Lua client library for the Email Finder API. It allows you to lookup the following details :
- Domain Search (Search emails are based on the website You give one domain name and it returns all the email addresses found on the internet.)
- Email Finder (This API endpoint generates or retrieves the most likely email address from a domain name, a first name and a last name..)
- Email Verifier (checks the deliverability of a given email address, verifies if it has been found in our database, and returns their sources.)
- Email Sources (Find email address source somewhere on the web .)
- Company Domain autocomplete (Company Autocomplete is an API that lets you auto-complete company names and retrieve logo and domain information.)
Link to this section Summary
Types
List of options to all request functions.
Result returned from request!/3, get!/2, post!/2, put!/2, etc.
Functions
Returns information about the current account.
Company Autocomplete is an API that lets you auto-complete company names and retrieve logo and domain information.
call to server
Returns total email addresses we have for one domain.
A shortcut for request(:delete, url, options).
A shortcut for request!(:delete, url, options).
Search emails are based on the website You give one domain name and it returns all the email addresses found on the internet.
Generates or retrieves the most likely email address from a domain name, a first name and a last name.
Find email address source somewhere on the web.
Verify the deliverability of an email address.
A shortcut for request(:get, url, options).
A shortcut for request!(:get, url, options).
A shortcut for request(:head, url, options).
A shortcut for request!(:head, url, options).
Returns a your last 1,000 requests you made during the last 3 months.
Tomba Constructor
A shortcut for request(:options, url, options).
A shortcut for request!(:options, url, options).
A shortcut for request(:patch, url, options).
A shortcut for request!(:patch, url, options).
A shortcut for request(:post, url, options).
A shortcut for request!(:post, url, options).
A shortcut for request(:put, url, options).
A shortcut for request!(:put, url, options).
Sends an HTTP request.
Like request/3, but raises HTTPotion.HTTPError if failed.
Starts a linked worker process for use with the direct option.
Starts a worker process for use with the direct option.
Ensures that HTTPotion and its dependencies are started.
Returns domain status if is webmail or disposable.
Stops a worker process started with spawn_worker_process/2 or spawn_link_worker_process/2.
Check your monthly requests.
Link to this section Types
Specs
http_opts() :: [ body: binary() | charlist(), headers: [{atom() | String.Chars.t(), String.Chars.t()}], query: %{optional(String.Chars.t()) => String.Chars.t()}, timeout: timeout(), basic_auth: {List.Chars.t(), List.Chars.t()}, stream_to: pid() | port() | atom() | {atom(), node()}, direct: pid() | port() | atom() | {atom(), node()}, ibrowse: keyword(), auto_sni: boolean(), follow_redirects: boolean() ]
List of options to all request functions.
body- request bodyheaders- HTTP headers (e.g.["Accept": "application/json"])query- URL query string (e.g.%{page: 1})timeout- timeout in millisecondsbasic_auth- basic auth credentials (e.g.{"user", "password"})stream_to- if you want to make an async request, reference to the processdirect- if you want to use ibrowse's direct feature, reference tothe worker spawned by `spawn_worker_process/2` or `spawn_link_worker_process/2`ibrowse- options for ibrowseauto_sni- if true and the URL is https, configures theserver_name_indicationibrowse/ssl optionto be the host part of the requestedURLfollow_redirects- if true and a response is a redirect, re-requests withheader[:Location]
Specs
http_result() :: HTTPotion.Response.t() | %HTTPotion.AsyncResponse{id: term()} | %HTTPotion.ErrorResponse{message: term()}
Specs
http_result_bang() :: HTTPotion.Response.t() | %HTTPotion.AsyncResponse{id: term()}
Result returned from request!/3, get!/2, post!/2, put!/2, etc.
Link to this section Functions
Returns information about the current account.
Parameters
this- Tomba
## Examples
{:ok, result} = Tomba.account(Tomba)
Company Autocomplete is an API that lets you auto-complete company names and retrieve logo and domain information.
Parameters
this- Tombaquery- A string name company or website.
## Examples
{:ok, result} = Tomba.autocomplete(Tomba,"google")
call to server
Parameters
this- Tombapath- A string specific path.params- query params
Returns total email addresses we have for one domain.
Parameters
this- Tombadomain- A string specific domain.
## Examples
{:ok, result} = Tomba.count(Tomba,"tomba.io")
Specs
delete(String.Chars.t(), http_opts()) :: http_result()
A shortcut for request(:delete, url, options).
Specs
delete!(String.Chars.t(), http_opts()) :: http_result_bang()
A shortcut for request!(:delete, url, options).
Search emails are based on the website You give one domain name and it returns all the email addresses found on the internet.
Parameters
this- Tombadomain- A string specific domain.
## Examples
{:ok, result} = Tomba.domain_search(Tomba,"tomba.io")
Generates or retrieves the most likely email address from a domain name, a first name and a last name.
Parameters
this- Tombadomain- A string domain name of the company, used for emails. For example, "tomba.com".fname- A string The person's first name. It doesn't need to be in lowercase.lname- A string The person's last name. It doesn't need to be in lowercase.
## Examples
{:ok, result} = Tomba.email_finder(Tomba,"stripe.com", "fname", "lname")
Find email address source somewhere on the web.
Parameters
this- Tombaemail- A string email address you want to find sources.
## Examples
{:ok, result} = Tomba.email_sources(Tomba,"b.mohamed@tomba.io")
Verify the deliverability of an email address.
Parameters
this- Tombaemail- A string email address you want to verify.
## Examples
{:ok, result} = Tomba.email_verifier(Tomba,"b.mohamed@tomba.io")
Specs
get(String.Chars.t(), http_opts()) :: http_result()
A shortcut for request(:get, url, options).
Specs
get!(String.Chars.t(), http_opts()) :: http_result_bang()
A shortcut for request!(:get, url, options).
Specs
head(String.Chars.t(), http_opts()) :: http_result()
A shortcut for request(:head, url, options).
Specs
head!(String.Chars.t(), http_opts()) :: http_result_bang()
A shortcut for request!(:head, url, options).
Returns a your last 1,000 requests you made during the last 3 months.
Parameters
this- Tomba
## Examples
{:ok, result} = Tomba.logs(Tomba)
Tomba Constructor
Parameters
key- Tomba api key.secret- Tomba secret key.
Specs
options(String.Chars.t(), http_opts()) :: http_result()
A shortcut for request(:options, url, options).
Specs
options!(String.Chars.t(), http_opts()) :: http_result_bang()
A shortcut for request!(:options, url, options).
Specs
patch(String.Chars.t(), http_opts()) :: http_result()
A shortcut for request(:patch, url, options).
Specs
patch!(String.Chars.t(), http_opts()) :: http_result_bang()
A shortcut for request!(:patch, url, options).
Specs
post(String.Chars.t(), http_opts()) :: http_result()
A shortcut for request(:post, url, options).
Specs
post!(String.Chars.t(), http_opts()) :: http_result_bang()
A shortcut for request!(:post, url, options).
Specs
put(String.Chars.t(), http_opts()) :: http_result()
A shortcut for request(:put, url, options).
Specs
put!(String.Chars.t(), http_opts()) :: http_result_bang()
A shortcut for request!(:put, url, options).
Specs
request(atom(), String.Chars.t(), http_opts()) :: http_result()
Sends an HTTP request.
See the type documentation of http_opts for a description of options.
Specs
request!(atom(), String.Chars.t(), http_opts()) :: http_result_bang()
Like request/3, but raises HTTPotion.HTTPError if failed.
request_direct(conn_pid, method, url, body \\ "", headers \\ [], options \\ [])
View SourceStarts a linked worker process for use with the direct option.
Starts a worker process for use with the direct option.
Ensures that HTTPotion and its dependencies are started.
Returns domain status if is webmail or disposable.
Parameters
this- Tombadomain- A string specific path.
## Examples
{:ok, result} = Tomba.status(Tomba,"gmail.com")
Stops a worker process started with spawn_worker_process/2 or spawn_link_worker_process/2.
Check your monthly requests.
Parameters
this- Tomba
## Examples
{:ok, result} = Tomba.usage(Tomba)