Package 'emailvalidation'

Title: Client for the 'emailalvalidation.io' E-Mail Validation API
Description: An R client for the 'emailvalidation.io' e-mail verification API. The API requires registration of an API key. Basic features are free, some require a paid subscription. You can find the full API documentation at <https://emailvalidation.io/docs> .
Authors: Dominik Kukacka [aut, cre]
Maintainer: Dominik Kukacka <[email protected]>
License: MIT + file LICENSE
Version: 0.1.0
Built: 2025-02-04 04:24:42 UTC
Source: https://github.com/cran/emailvalidation

Help Index

Emailvalidation API Key

Description

emailvalidation.io requires authentication via an API key. For this package, the API key is saved as a environmental variable. In interactive mode, using emailvalidation_api_key will require you to enter an API key. Alternatively, you can also use Sys.setenv(EMAILVALIDATION_API_KEY = <key>) to set the API key manually.

Usage

emailvalidation_api_key(force = FALSE)

Arguments

force

If TRUE, resets the API key & requires the user to provide a new API key. If FALSE and an API key already exists, the key will be printed to the console. If no key exists, you will be required to enter a key. force. Defaults to FALSE.

Value

Returns the set API key that has been stored as an enviroment variable.

Get the current status of the API.

Description

Get the current status of the API.

Usage

get_api_status()

Value

Returns your current quota. Requests to this endpoint do not count against your quota or rate limit.

Checks the provided email address

Description

Checks the provided email address

Usage

get_email_info(email, catch_all = NULL)

Arguments

email

(required) The email address you want to check
catch_all

If set to 1 we check if the email domain is a catch-all enabled domain (Only available in higher up plans)

Value

Returns all available information about the specified email address.