| Title: | Client for the 'emailalvalidation.io' E-Mail Validation API |
| Version: | 0.1.0 |
| 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 . |
| License: | MIT + file LICENSE |
| Encoding: | UTF-8 |
| URL: | https://emailvalidation.io, https://emailvalidation.io/docs |
| RoxygenNote: | 7.2.3 |
| Imports: | httr, jsonlite |
| Suggests: | knitr, rmarkdown, testthat (≥ 3.0.0) |
| Config/testthat/edition: | 3 |
| VignetteBuilder: | knitr |
| NeedsCompilation: | no |
| Packaged: | 2023-05-09 12:55:40 UTC; andreasaltheimer |
| Author: | Dominik Kukacka [aut, cre] |
| Maintainer: | Dominik Kukacka <dominik@everapi.com> |
| Repository: | CRAN |
| Date/Publication: | 2023-05-11 08:50:14 UTC |
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 |
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.