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.
Authors: Abedrahim Ben rebia [aut, cre],Mohamed Ben rebia [ctb], Tomba.io [cph]
Maintainer: Abedrahim Ben rebia <[email protected]>
License: Apache License (== 2.0)
Version: 1.0.2
Built: 2024-11-12 04:40:35 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://developer.tomba.io/#account-information

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.

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)

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

Arguments

obj

Tomba class
url

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

Value

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

References

https://developer.tomba.io/#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://developer.tomba.io/#autocomplete

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.

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)

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://developer.tomba.io/#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.

DEFAULT BASE URL

Description

DEFAULT BASE URL

Usage

DEFAULT_BASE_URL

Format

An object of class character of length 1.

Domain search

Description

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.

Usage

domain_search(obj, domain)

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

Arguments

obj

Tomba class
domain

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

Value

A list domain data containing the organization name,country,social links, and list of emails.

References

https://developer.tomba.io/#domain-search

Examples

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

## End(Not run)

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)

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

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..

Value

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

References

https://developer.tomba.io/#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 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://developer.tomba.io/#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)

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

Arguments

obj

Tomba class
email

a character email address you want to verify.

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://developer.tomba.io/#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.

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)

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

Arguments

obj

Tomba class
url

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

Value

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

References

https://developer.tomba.io/#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.

Logs

Description

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

Usage

logs(obj)

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

Arguments

obj

Tomba class

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://developer.tomba.io/#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.

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)

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

Arguments

obj

Tomba class
email

a character The email address you want to find phone.

Value

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

References

https://developer.tomba.io/#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.

Search path

Description

Search path

Usage

SEARCH_PATH

Format

An object of class character of length 1.

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://developer.tomba.io/#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.

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

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://developer.tomba.io/#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.