Welcome to Email.Service.Studio

This is a customizable microservice template that can be directly deployed to create your own microservice. It can satisfy common email use cases for your websites.

To clone the template: GitHub Link

API Endpoints :

Auto-Reply Email

One-Time Password Email (OTP Email)

Auto-Reply Email

POST /autoreply

When a visitor has submitted a form on your website, you may like to send an automated email to them and forward the email to the relevant parties to follow up.

Request Schema:

email: string;
name: string;
sender: string;
contactEmail?: string;
message: string;

Request Example:

email: "visitor@example.com",
name: "Visitor Name",
sender: "Email.Service.Studio",
contactEmail: "customerService@example.com",
message: "I have a issue about the online payment ...",

Success Response:

// Nothing will be returned

Fail Response:

Failed to send email to visitor@example.com: ...

OTP Email

POST /otp

You can request to send a one-time password (OTP) email to the user who is signing up or logging in for email verification or authentication. The generated OTP will be encoded and returned in the response. You can then encode the OTP input of the user accordingly and compare it with the returned OTP.

Request Schema:

email: string;
name: string;
sender: string;
contactEmail?: string;

Request Example:

email: "new_user@example.com",
name: "User Name",
sender: "Email.Service.Studio",
contactEmail: "ITSupport@example.com",

Success Response:

// The encoded OTP will be returned
1234...

Fail Response:

Failed to send OTP email to visitor@example.com: ...