Test endpoints locally

Simplemail currently does not support send request to local url by passing it to callback_url . In order to test email service, you may have to setup it locally.

Local environment requirements

  • Typescript installed at your device

  • Redis server installed at your device

Step 1: Clone the repo

Clone the repo from

LogoGitHub - Vong3432/simplemail: Small service that let you send gmail by APIGitHub
Simplemail Github repo

Step 2: Install packages

npm install

Step 3: Start the Simplemail & workers 

npm start
npm run start:workers

Step 4: Call send email endpoints

Since this is running on your local device, instead of calling the remote API endpoints, you may send request to localhost to send email.

❌ Instead of
https://simplemail-nodejs.herokuapp.com/send-email

✅ Do this
http://localhost:5003/send-email

Once you are done with testing at development, then in your server you may change the send email endpoints to the remote API endpoints in your production server.

PreviousGetting startedNextSend email

Last updated