Package 'tomba'

Title: Official R Library for Tomba Email Finder
Description: Email Finder R Client Library. 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 generates or retrieves the most likely email address from a domain name, a first name and a last name. Email verify checks the deliverability of a given email address, verifies if it has been found in our database, and returns their sources. Includes support for enrichment, leads management, bulk operations, and more.
Authors: Abedrahim Ben rebia [aut, cre], Mohamed Ben rebia [ctb], Tomba.io [cph]
Maintainer: Abedrahim Ben rebia <[email protected]>
License: Apache License 2.0 | file LICENSE
Version: 1.1.0
Built: 2026-09-30 19:34:39 UTC
Source: https://github.com/tomba-io/r

Help Index


Account

Description

account Returns information about the current account.

Usage

account(obj)

## S4 method for signature 'Tomba'
account(obj)

Arguments

obj

Tomba class

Value

A list your account data containing your pricing,first_name,last_name,email,country,requests used on domain search and email finder, and email verifier.

References

https://docs.tomba.io/api/account

Examples

## Not run: 
client <- Tomba(key="ta_xxxx",secret="ts_xxxx")
result <- account(obj)

## End(Not run)

Account path

Description

Account path

Usage

ACCOUNT_PATH

Format

An object of class character of length 1.


Archive Bulk Operation

Description

Archive a bulk operation.

Usage

archive_bulk(obj, bulk_type, bulk_id)

## S4 method for signature 'Tomba'
archive_bulk(obj, bulk_type, bulk_id)

Arguments

obj

A Tomba object.

bulk_type

Character. The type of bulk operation.

bulk_id

Character or integer. The ID of the bulk operation.

Value

A list confirming the archive.


Author Finder

Description

author_finder This API endpoint generates or retrieves the most likely email address from a blog post url.

Usage

author_finder(obj, url, webhook_url = NULL)

## S4 method for signature 'Tomba'
author_finder(obj, url, webhook_url = NULL)

Arguments

obj

Tomba class

url

a character The URL of the article. For example, "https://clearbit.com/blog/company-name-to-domain-api".

webhook_url

Character. Webhook URL for async results (optional, default NULL).

Value

A list persons data containing the: first_name,last_name,email,score,department,last_updated.

References

https://docs.tomba.io/api/finder#author-finder

Examples

## Not run: 
client <- Tomba(key="ta_xxxx",secret="ts_xxxx")
result <- author_finder(client,url="https://clearbit.com/blog/company-name-to-domain-api")

## End(Not run)

Finder path

Description

Finder path

Usage

AUTHOR_PATH

Format

An object of class character of length 1.


Company Autocomplete

Description

autocomplete Company Autocomplete is an API that lets you auto-complete company names and retreive logo and domain information.

Usage

autocomplete(obj, search)

## S4 method for signature 'Tomba'
autocomplete(obj, search)

Arguments

obj

Tomba class

search

a character name company or website.

Value

A list autocomplete data containing the: Total email on company,company website and name and logo.

References

https://docs.tomba.io/api/domain-suggestions

Examples

## Not run: 
client <- Tomba(key="ta_xxxx",secret="ts_xxxx")
result <- autocomplete(obj,search="google")

## End(Not run)

Autocomplete path

Description

Autocomplete path

Usage

AUTOCOMPLETE_PATH

Format

An object of class character of length 1.


Bulk Progress

Description

Get the progress of a bulk operation.

Usage

bulk_progress(obj, bulk_type, bulk_id)

## S4 method for signature 'Tomba'
bulk_progress(obj, bulk_type, bulk_id)

Arguments

obj

A Tomba object.

bulk_type

Character. The type of bulk operation.

bulk_id

Character or integer. The ID of the bulk operation.

Value

A list with progress information.


Tomba Client

Description

client Tomba http Client

Usage

client(obj, path, query = NULL)

## S4 method for signature 'Tomba'
client(obj, path, query = NULL)

Arguments

obj

Tomba class

path

a character specific path.

query

a list for httr request query

Value

A list of http response

Examples

## Not run: 
client <- Tomba(key="ta_xxxx",secret="ts_xxxx")
result <- client(obj,"https://api.tomba.io/v1/me",null)

## End(Not run)

Tomba HTTP DELETE Client

Description

Sends a DELETE request to the Tomba API.

Usage

client_delete(obj, path)

## S4 method for signature 'Tomba'
client_delete(obj, path)

Arguments

obj

A Tomba object.

path

Character. The API path (relative to the base URL).

Value

A list with the parsed API response.


Tomba HTTP POST Client

Description

Sends a POST request with a JSON body to the Tomba API.

Usage

client_post(obj, path, data = list())

## S4 method for signature 'Tomba'
client_post(obj, path, data = list())

Arguments

obj

A Tomba object.

path

Character. The API path (relative to the base URL).

data

A named list to be sent as the JSON request body.

Value

A list with the parsed API response.


Tomba HTTP PUT Client

Description

Sends a PUT request with a JSON body to the Tomba API.

Usage

client_put(obj, path, data = list())

## S4 method for signature 'Tomba'
client_put(obj, path, data = list())

Arguments

obj

A Tomba object.

path

Character. The API path (relative to the base URL).

data

A named list to be sent as the JSON request body.

Value

A list with the parsed API response.


Combined Find (Enrichment)

Description

Get combined person and company data from an email address.

Usage

combined_find(obj, email)

## S4 method for signature 'Tomba'
combined_find(obj, email)

Arguments

obj

A Tomba object.

email

Character. The email address to look up.

Value

A list with combined person and company enrichment data.


Company Find (Enrichment)

Description

Get company data from a domain.

Usage

company_find(obj, domain)

## S4 method for signature 'Tomba'
company_find(obj, domain)

Arguments

obj

A Tomba object.

domain

Character. The domain name.

Value

A list with company enrichment data.


Email Count

Description

count Returns total email addresses we have for one domain.

Usage

count(obj, domain)

## S4 method for signature 'Tomba'
count(obj, domain)

Arguments

obj

Tomba class

domain

a character Domain name from which you want to find the email addresses. For example, "stripe.com".

Value

A list domain count data containing the: Total email,Total personal email,Total generic email,Total email on department key_name.

References

https://docs.tomba.io/api/finder#email-count

Examples

## Not run: 
client <- Tomba(key="ta_xxxx",secret="ts_xxxx")
result <- count(client,domain="tomba.io")

## End(Not run)

Email Count path

Description

Email Count path

Usage

COUNT_PATH

Format

An object of class character of length 1.


Create Bulk Operation

Description

Create a new bulk operation.

Usage

create_bulk(obj, bulk_type, data = list())

## S4 method for signature 'Tomba'
create_bulk(obj, bulk_type, data = list())

Arguments

obj

A Tomba object.

bulk_type

Character. The type of bulk operation.

data

A named list with the bulk operation data.

Value

A list containing the created bulk operation.


Create Flag

Description

Flag an email address, optionally with a reason.

Usage

create_flag(obj, email, reason = NULL)

## S4 method for signature 'Tomba'
create_flag(obj, email, reason = NULL)

Arguments

obj

A Tomba object.

email

Character. The email address to flag.

reason

Character. Optional reason for flagging.

Value

A list confirming the flag creation.


Create API Key

Description

Create a new API key.

Usage

create_key(obj, data = list())

## S4 method for signature 'Tomba'
create_key(obj, data = list())

Arguments

obj

A Tomba object.

data

A named list with key data.

Value

A list containing the created API key.


Create Lead

Description

Create a new lead.

Usage

create_lead(obj, data = list())

## S4 method for signature 'Tomba'
create_lead(obj, data = list())

Arguments

obj

A Tomba object.

data

A named list with lead data.

Value

A list containing the created lead.


Create Lead Attribute

Description

Create a new lead attribute.

Usage

create_lead_attribute(obj, data = list())

## S4 method for signature 'Tomba'
create_lead_attribute(obj, data = list())

Arguments

obj

A Tomba object.

data

A named list with attribute data.

Value

A list containing the created attribute.


Create Leads List

Description

Create a new leads list.

Usage

create_leads_list(obj, data = list())

## S4 method for signature 'Tomba'
create_leads_list(obj, data = list())

Arguments

obj

A Tomba object.

data

A named list with list data.

Value

A list containing the created leads list.


DEFAULT BASE URL

Description

DEFAULT BASE URL

Usage

DEFAULT_BASE_URL

Format

An object of class character of length 1.


Delete Bulk Operation

Description

Delete a bulk operation.

Usage

delete_bulk(obj, bulk_type, bulk_id)

## S4 method for signature 'Tomba'
delete_bulk(obj, bulk_type, bulk_id)

Arguments

obj

A Tomba object.

bulk_type

Character. The type of bulk operation.

bulk_id

Character or integer. The ID of the bulk operation.

Value

A list confirming deletion.


Delete API Key

Description

Delete an API key by its ID.

Usage

delete_key(obj, id)

## S4 method for signature 'Tomba'
delete_key(obj, id)

Arguments

obj

A Tomba object.

id

Character. The ID of the API key to delete.

Value

A list confirming deletion.


Delete Lead

Description

Delete a lead by its ID.

Usage

delete_lead(obj, lead_id)

## S4 method for signature 'Tomba'
delete_lead(obj, lead_id)

Arguments

obj

A Tomba object.

lead_id

Character or integer. The ID of the lead to delete.

Value

A list confirming deletion.


Delete Lead Attribute

Description

Delete a lead attribute by its ID.

Usage

delete_lead_attribute(obj, id)

## S4 method for signature 'Tomba'
delete_lead_attribute(obj, id)

Arguments

obj

A Tomba object.

id

Character. The ID of the attribute to delete.

Value

A list confirming deletion.


Delete Leads List

Description

Delete a leads list by its ID.

Usage

delete_leads_list(obj, id)

## S4 method for signature 'Tomba'
delete_leads_list(obj, id)

Arguments

obj

A Tomba object.

id

Character. The ID of the leads list to delete.

Value

A list confirming deletion.


Download Bulk Results

Description

Download the results of a completed bulk operation.

Usage

download_bulk(obj, bulk_type, bulk_id)

## S4 method for signature 'Tomba'
download_bulk(obj, bulk_type, bulk_id)

Arguments

obj

A Tomba object.

bulk_type

Character. The type of bulk operation.

bulk_id

Character or integer. The ID of the bulk operation.

Value

A list with the download URL or data.


Email Finder

Description

email_finder Generates or retrieves the most likely email address from a domain name, a first name and a last name.

Usage

email_finder(obj, domain, fname, lname, webhook_url = NULL)

## S4 method for signature 'Tomba'
email_finder(obj, domain, fname, lname, webhook_url = NULL)

Arguments

obj

Tomba class

domain

a character domain name of the company, used for emails. For example, "asana.com".

fname

The person's first name. It doesn't need to be in lowercase..

lname

The person's last name. It doesn't need to be in lowercase..

webhook_url

Character. Webhook URL for async results (optional, default NULL).

Value

A list persons data containing the: first_name,last_name,email,score,department,last_updated.

References

https://docs.tomba.io/api/finder#email-finder

Examples

## Not run: 
client <- Tomba(key="ta_xxxx",secret="ts_xxxx")
result <- email_finder(client,fname="FIRST_NAME",lname="LASST_NAME")

## End(Not run)

Email Format

Description

Get the email format used by a domain.

Usage

email_format(obj, domain)

## S4 method for signature 'Tomba'
email_format(obj, domain)

Arguments

obj

A Tomba object.

domain

Character. The domain name.

Value

A list with the email format information.


Email Sources

Description

email_sources Find email address source somewhere on the web.

Usage

email_sources(obj, email)

## S4 method for signature 'Tomba'
email_sources(obj, email)

Arguments

obj

Tomba class

email

a character email address you want to find sources.

Value

A list sources data data containing the: URL, URL extracted on and last seen on, check if the URL still on page (TRUE|FALSE).

References

https://docs.tomba.io/api/finder#email-sources

Examples

## Not run: 
client <- Tomba(key="ta_xxxx",secret="ts_xxxx")
result <- email_sources(obj,email="[email protected]")

## End(Not run)

Email Verifier

Description

email_verifier Verify the deliverability of an email address.

Usage

email_verifier(obj, email, webhook_url = NULL)

## S4 method for signature 'Tomba'
email_verifier(obj, email, webhook_url = NULL)

Arguments

obj

Tomba class

email

a character email address you want to verify.

webhook_url

Character. Webhook URL for async results (optional, default NULL).

Value

A list email data containing the: MX records,SMTP server accepts all,SMTP check,deliverability score,status of the email address,status of the verification.

References

https://docs.tomba.io/api/verifier#email-verifier

Examples

## Not run: 
client <- Tomba(key="ta_xxxx",secret="ts_xxxx")
result <- email_verifier(obj,email="[email protected]")

## End(Not run)

Finder path

Description

Finder path

Usage

FINDER_PATH

Format

An object of class character of length 1.


Get Bulk Operation

Description

Get a specific bulk operation by type and ID.

Usage

get_bulk(obj, bulk_type, bulk_id)

## S4 method for signature 'Tomba'
get_bulk(obj, bulk_type, bulk_id)

Arguments

obj

A Tomba object.

bulk_type

Character. The type of bulk operation.

bulk_id

Character or integer. The ID of the bulk operation.

Value

A list containing bulk operation details.


Get API Key

Description

Get a specific API key by its ID.

Usage

get_key(obj, id)

## S4 method for signature 'Tomba'
get_key(obj, id)

Arguments

obj

A Tomba object.

id

Character. The ID of the API key.

Value

A list containing the API key details.


Get Lead

Description

Get a specific lead by its ID.

Usage

get_lead(obj, lead_id)

## S4 method for signature 'Tomba'
get_lead(obj, lead_id)

Arguments

obj

A Tomba object.

lead_id

Character or integer. The ID of the lead.

Value

A list containing lead details.


Get Location

Description

Get the location of a domain.

Usage

get_location(obj, domain)

## S4 method for signature 'Tomba'
get_location(obj, domain)

Arguments

obj

A Tomba object.

domain

Character. The domain name.

Value

A list with the location data for the domain.


Launch Bulk Operation

Description

Launch a bulk operation to begin processing.

Usage

launch_bulk(obj, bulk_type, bulk_id)

## S4 method for signature 'Tomba'
launch_bulk(obj, bulk_type, bulk_id)

Arguments

obj

A Tomba object.

bulk_type

Character. The type of bulk operation.

bulk_id

Character or integer. The ID of the bulk operation.

Value

A list confirming the launch.


Author Finder

Description

linkedin_finder This API endpoint generates or retrieves the most likely email address from a Linkedin URL.

Usage

linkedin_finder(obj, url, webhook_url = NULL)

## S4 method for signature 'Tomba'
linkedin_finder(obj, url, webhook_url = NULL)

Arguments

obj

Tomba class

url

a character The URL of the Linkedin. For example, "https://www.linkedin.com/in/alex-maccaw-ab592978".

webhook_url

Character. Webhook URL for async results (optional, default NULL).

Value

A list persons data containing the: first_name,last_name,email,score,department,last_updated.

References

https://docs.tomba.io/api/finder#linkedin-finder

Examples

## Not run: 
client <- Tomba(key="ta_xxxx",secret="ts_xxxx")
result <- linkedin_finder(client,url="httpshttps://www.linkedin.com/in/alex-maccaw-ab592978")

## End(Not run)

Finder path

Description

Finder path

Usage

LINKEDIN_PATH

Format

An object of class character of length 1.


List Bulk Operations

Description

List all bulk operations of a given type.

Usage

list_bulks(obj, bulk_type, page = NULL, limit = NULL)

## S4 method for signature 'Tomba'
list_bulks(obj, bulk_type, page = NULL, limit = NULL)

Arguments

obj

A Tomba object.

bulk_type

Character. The type of bulk operation.

page

Integer. Page number for pagination (optional).

limit

Integer. Number of results per page (optional).

Value

A list containing bulk operations.


List Flags

Description

Get all flagged email addresses.

Usage

list_flags(obj, page = NULL, limit = NULL)

## S4 method for signature 'Tomba'
list_flags(obj, page = NULL, limit = NULL)

Arguments

obj

A Tomba object.

page

Integer. Page number for pagination (optional).

limit

Integer. Number of results per page (optional).

Value

A list containing flagged emails.


List API Keys

Description

Get all API keys associated with your account.

Usage

list_keys(obj)

## S4 method for signature 'Tomba'
list_keys(obj)

Arguments

obj

A Tomba object.

Value

A list containing API keys.


List Lead Attributes

Description

Get all lead attributes.

Usage

list_lead_attributes(obj)

## S4 method for signature 'Tomba'
list_lead_attributes(obj)

Arguments

obj

A Tomba object.

Value

A list containing lead attributes.


List Leads

Description

Get all leads with optional pagination and domain filter.

Usage

list_leads(obj, page = NULL, limit = NULL, domain = NULL)

## S4 method for signature 'Tomba'
list_leads(obj, page = NULL, limit = NULL, domain = NULL)

Arguments

obj

A Tomba object.

page

Integer. Page number for pagination (optional).

limit

Integer. Number of results per page (optional).

domain

Character. Filter leads by domain (optional).

Value

A list containing leads data.


List Leads Lists

Description

Get all leads lists.

Usage

list_leads_lists(obj)

## S4 method for signature 'Tomba'
list_leads_lists(obj)

Arguments

obj

A Tomba object.

Value

A list containing leads lists.


Logs

Description

logs Returns a your last 1,000 requests you made during the last 3 months.

Usage

logs(obj, page = NULL, limit = NULL)

## S4 method for signature 'Tomba'
logs(obj, page = NULL, limit = NULL)

Arguments

obj

Tomba class

page

Integer. Page number for pagination (optional).

limit

Integer. Number of results per page (optional).

Value

A list requests data containing the: url and The User Agent and IP address associated with the Request,The cost false Free true 1 request,The date,The ISO 3166-1 alpha-2 country code.

References

https://docs.tomba.io/api/account#logs

Examples

## Not run: 
client <- Tomba(key="ta_xxxx",secret="ts_xxxx")
result <- logs(client)

## End(Not run)

Logs path

Description

Logs path

Usage

LOGS_PATH

Format

An object of class character of length 1.


Person Find (Enrichment)

Description

Get person data from an email address.

Usage

person_find(obj, email)

## S4 method for signature 'Tomba'
person_find(obj, email)

Arguments

obj

A Tomba object.

email

Character. The email address to look up.

Value

A list with person enrichment data.


Phone Finder

Description

phone_finder Search phone are based on the email You give one email and it returns phone data.

Usage

phone_finder(obj, email, webhook_url = NULL)

## S4 method for signature 'Tomba'
phone_finder(obj, email, webhook_url = NULL)

Arguments

obj

Tomba class

email

a character The email address you want to find phone.

webhook_url

Character. Webhook URL for async results (optional, default NULL).

Value

A list phone data containing the: local_format,intl_format,country_code,line_type,carrier,timezones

References

https://docs.tomba.io/api/phone#phone-finder

Examples

## Not run: 
client <- Tomba(key="ta_xxxx",secret="ts_xxxx")
result <- phone_finder(client,email="******@zapier.com")

## End(Not run)

Finder path

Description

Finder path

Usage

PHONE_PATH

Format

An object of class character of length 1.


Phone Validator

Description

Validate a phone number and retrieve metadata.

Usage

phone_validator(obj, phone, country_code = NULL)

## S4 method for signature 'Tomba'
phone_validator(obj, phone, country_code = NULL)

Arguments

obj

A Tomba object.

phone

Character. The phone number to validate.

country_code

Character. Optional country code for parsing local numbers (e.g., "US").

Value

A list with validation data.

See Also

https://docs.tomba.io/api/phone#phone-validator


Rename Bulk Operation

Description

Rename a bulk operation.

Usage

rename_bulk(obj, bulk_type, bulk_id, name)

## S4 method for signature 'Tomba'
rename_bulk(obj, bulk_type, bulk_id, name)

Arguments

obj

A Tomba object.

bulk_type

Character. The type of bulk operation.

bulk_id

Character or integer. The ID of the bulk operation.

name

Character. The new name for the bulk operation.

Value

A list confirming the rename.


Reset API Key

Description

Reset an API key by its ID.

Usage

reset_key(obj, id)

## S4 method for signature 'Tomba'
reset_key(obj, id)

Arguments

obj

A Tomba object.

id

Character. The ID of the API key to reset.

Value

A list containing the reset key.

See Also

https://docs.tomba.io/api/keys#reset-an-api-key

Examples

## Not run: 
cl <- Tomba(key = "ta_xxxx", secret = "ts_xxxx")
result <- reset_key(cl, id = "key-id-here")

## End(Not run)

Search path

Description

Search path

Usage

SEARCH_PATH

Format

An object of class character of length 1.


Similar Domains

Description

Retrieve domains similar to the given domain.

Usage

similar_domains(obj, domain)

## S4 method for signature 'Tomba'
similar_domains(obj, domain)

Arguments

obj

A Tomba object.

domain

Character. The domain name.

Value

A list with similar domain information.


Email Sources path

Description

Email Sources path

Usage

SOURCES_PATH

Format

An object of class character of length 1.


Domain status

Description

status Returns domain status if is webmail or disposable.

Usage

status(obj, domain)

## S4 method for signature 'Tomba'
status(obj, domain)

Arguments

obj

Tomba class

domain

a character Domain name from which you want to check. For example, "gmail.com".

Value

A list domain status data containing the: is webmail email service or is disposable email service

References

https://docs.tomba.io/api/domain#domain-status

Examples

## Not run: 
client <- Tomba(key="ta_xxxx",secret="ts_xxxx")
result <- status(client,domain="gmail.com")

## End(Not run)

Domain status path

Description

Domain status path

Usage

STATUS_PATH

Format

An object of class character of length 1.


Technology Check

Description

Retrieve the technologies used by a domain.

Usage

technology_check(obj, domain)

## S4 method for signature 'Tomba'
technology_check(obj, domain)

Arguments

obj

A Tomba object.

domain

Character. The domain name.

Value

A list with technologies used by the domain.


The official R client library for the tomba.io

Description

Search emails are based on the website You give one domain name and it returns all the email addresses found on the internet. at https://tomba.io/

Author(s)

Abedrahim Ben rebia [email protected]


Tomba init

Description

An S4 class The Tomba API Constructor

Slots

key

A character Tomba API KEY

secret

A character Tomba SECRET KEY


Update Lead

Description

Update an existing lead by its ID.

Usage

update_lead(obj, lead_id, data = list())

## S4 method for signature 'Tomba'
update_lead(obj, lead_id, data = list())

Arguments

obj

A Tomba object.

lead_id

Character or integer. The ID of the lead to update.

data

A named list with lead data to update.

Value

A list containing the updated lead.


Update Lead Attribute

Description

Update a lead attribute by its ID.

Usage

update_lead_attribute(obj, id, data = list())

## S4 method for signature 'Tomba'
update_lead_attribute(obj, id, data = list())

Arguments

obj

A Tomba object.

id

Character. The ID of the attribute to update.

data

A named list with attribute data to update.

Value

A list containing the updated attribute.


Update Leads List

Description

Update a leads list by its ID.

Usage

update_leads_list(obj, id, data = list())

## S4 method for signature 'Tomba'
update_leads_list(obj, id, data = list())

Arguments

obj

A Tomba object.

id

Character. The ID of the leads list to update.

data

A named list with list data to update.

Value

A list containing the updated leads list.


Usage

Description

usage Check your monthly requests.

Usage

usage(obj)

## S4 method for signature 'Tomba'
usage(obj)

Arguments

obj

Tomba class

Value

A list requests data containing the: usage of the domain,finder,verifier and source from: Website, Google Sheets add-on,api, browser extension, bulk tasks.

References

https://docs.tomba.io/api/account#usage

Examples

## Not run: 
client <- Tomba(key="ta_xxxx",secret="ts_xxxx")
result <- usage(client)

## End(Not run)

Uage path

Description

Uage path

Usage

USAGE_PATH

Format

An object of class character of length 1.


Verifier path

Description

Verifier path

Usage

VERIFIER_PATH

Format

An object of class character of length 1.