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,warpweb framework.
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 3000:3000 reacherhq/backendYou 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 runThe 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. |
reacher_dev_secret |
See https://reacher.email/docs.
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 designed to meet the development and distribution needs of both commercial and open-source projects.
If you want to use this library to build closed-sourced commercial sites and applications, then you'll need to purchase a commercial license. This allows you to keep your software proprietary whilst still using reacherhq/backend. You can purchase a commercial license here. A commercial license grants you:
- On-premise running as well as running on public cloud providers for commercial purposes for proprietary systems.
- Ability to modify the source (forking) for your own purposes.
Not only does it grant you a license to run such a critical piece of infrastructure, but you are also supporting further innovation in this space and our ability to contribute to it!
If you are creating an open source application under a license compatible with the Affero GNU GPL license v3, you may use reacherhq/backend under the terms of the AGPLv3. You can read more about this license here.
Please read the LICENSE file for more information about the dual 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.