Backend Server for Reacher Email Verification API: https://reacher.email.
This repository holds the backend for Reacher. The backend is a HTTP server with the following components:
check-if-email-exists
, which performs the core email verification logic,warp
web framework.
There are 3 ways you can run this backend.
After clicking on the button, just follow the instructions on screen.
The Docker image is hosted on Docker Hub: https://hub.docker.com/r/reacherhq/backend.
To run it, run the following command:
docker run -p 8080:8080 reacherhq/backend
You can then send a POST request with the following body to http://localhost:8080/v0/check_email
:
{
"to_email": "someone@gmail.com"
}
If you prefer to run the server locally on your machine, just clone the repository and run:
cargo run
The server will then be listening on http://127.0.0.1:8080
.
These are the environment variables used to configure the HTTP server:
Env Var | Required? | Description | Default |
---|---|---|---|
RCH_FROM_EMAIL |
No | The email to use in the MAIL FROM: SMTP command. |
user@example.org |
RCH_HTTP_HOST |
No | The host name to bind the HTTP server to. | 127.0.0.1 |
PORT |
No | The port to bind the HTTP server to, populated by Heroku. | 8080 |
RCH_SENTRY_DSN |
No | Sentry DSN used for bug reports. | not defined |
RCH_SAASIFY_SECRET |
No | All requests must have a x-saasify-proxy-secret header set, equal to the value of RCH_SAASIFY_SECRET . Also see #185. |
reacher_dev_secret |
See https://help.reacher.email/rest-api-documentation.
Also check the openapi.json
file for the OpenAPI v3 specification of the backend's API.
reacherhq/backend
's source code is provided under a dual license model.
If you want to use reacherhq/backend
to develop commercial sites, tools, and applications, the Commercial License is the appropriate license. With this option, your source code is kept proprietary. Purchase an reacherhq/backend
Commercial License at https://reacher.email/pricing.
If you are creating an open source application under a license compatible with the GNU Affero GPL license v3, you may use reacherhq/backend
under the terms of the AGPL-3.0.
Read more about Reacher's license.
If you like my open-source work at Reacher, consider sponsoring me! You'll also get 8000 free email verifications every month with your Reacher account, and a this contribution would mean A WHOLE LOT to me.