Skip to content
This repository was archived by the owner on Apr 30, 2024. It is now read-only.

flexhostmail

Pre-release
Pre-release

Choose a tag to compare

@IntegerAlex IntegerAlex released this 29 Feb 01:37
· 3 commits to main since this release

FlexHostMail v0.2.0-beta

Overview

FlexHostMail is a Node.js package designed for secure email-based OTP (One-Time Password) verification systems. In this beta release, we introduce new functionalities and improvements to enhance your OTP implementation.

New Features

  • Configuration Enhancement: Now easily configure FlexHostMail with your Mailgun API key, Mailgun domain, Redis host, and Redis password using the configFHM function.

  • Send OTPs: Utilize the sendOtp function to seamlessly send OTPs to users via email. This function returns the generated OTP for further processing.

  • Verify OTPs: Verify user-provided OTPs with the verifyOtp function, ensuring a secure and reliable OTP verification process.

  • Server Initialization: The startFHM function initializes the FlexHostMail framework, allowing you to kickstart your OTP verification server.

Getting Started

  1. Install FlexHostMail: npm install flexhostmail@0.2.0-beta

  2. Configure FlexHostMail: Use the configFHM function to set up your Mailgun and Redis parameters.

  3. Start the Server: Initialize the FlexHostMail framework with startFHM.

  4. Send and Verify OTPs: Employ sendOtp to dispatch OTPs and verifyOtp to validate user-provided OTPs.

Please note that this is a beta release, and we welcome your feedback to improve and enhance FlexHostMail for future versions.

We appreciate your support and look forward to your valuable contributions and feedback.

Happy coding!