email-verification-code-sendgrid

    2.2.0 • Public • Published

    Email Verification Code Sendgrid- V2

    What has changed?

    With Sendgrid, We added 2 other functions to make the verification more secure and more intense.
    Now you can confirm with a Token that is generated at the beginning, or confirm with the code and the token at the same time!

    How the changes can be helpful?

    With the Token Code, you can easily verify the email with a link redirection without restraint!

    This package is a fork from email-verification-code by FahDev1@gmail.com

    Installation

    This is a Node.js module available through the npm registry.

    Installation is done using the npm install command:

    npm install email-verification-code-sendgrid --save

    Usage

    const {
      sendCode,
      verifyCode,
      verifyToken,
      verifyBoth,
    } = require("email-verification-code-sendgrid");
    
    // Send the code to the User Email.
    
    const data = {
      smtpInfo: {
        host: "0.0.0.0",
        port: 587,
        user: "test@example.com",
        pass: 23454,
      },
      company: {
        name: "danisifon.",
        email: "danisifon@gmail.com",
      },
      mailInfo: {
        emailReceiver: "danireceiv@gmail.com",
        subject: "Code Confirmation",
        text(code) {
          return `The Confirmation Code is: ${code}`;
        },
        html(code) {
          return `<p>The Confirmation Code is: ${code}</p>`;
        },
      },
    };
    
    sendCode(data);
    
    // To verify the code validity
    
    const response = verifyCode("example@email.com", 3429921);
    
    // To verify with the Token code
    
    const response = verifyToken("CunedqBnbxT85jbXLrApHh");
    
    // To verify with both codes
    
    const codes = {
      code: 3429921,
      token: "CunedqBnbxT85jbXLrApHh",
    };
    
    const response = verifyBoth(codes);
    
    console.log(response);

    smtpInfo

    Option Type Default Description Required
    host String null SMTP HOST, required to Connect to Your SMTP & Send the mail True
    port Number 587 SMTP PORT, required to Connect to Your SMTP & Send the mail True
    user String null SMTP User, required to Connect to Your SMTP & Send the mail True
    pass String null SMTP Password, required to Connect to Your SMTP & Send the mail True

    company

    Option Type Default Description Required
    name String null Your company Name, sent in the FROM tag false, One of the two is Required.
    email String null Your company email, sent in the from tag false, One of the two is Required.

    mailInfo

    Option Type Default Description Required
    emailReceiver String null User or Receiver Email True
    subject String null The mail Subject False
    text Function '' The mail content.
    NB: This function must have two parameters which corresponds to the Code & the Token
    False, One of the two is Required.
    html Function '' The mail content.
    NB: This function must have two parameters which corresponds to the Code & the Token
    False, One of the two is Required.

    How it Work!

    The script generates a 6-digit & a token codes with 1 hour validity and saves it locally (For security reasons, please call the backend functions) and then sends an email with the message you had inserted previously.

    To check the code, all you need to do is have the email address and the code. The script will look for the code in the local database, compare it, delete it if the code is correct, and give you a response to do so.

    License

    MIT

    Install

    npm i email-verification-code-sendgrid

    DownloadsWeekly Downloads

    8

    Version

    2.2.0

    License

    ISC

    Unpacked Size

    10.5 kB

    Total Files

    5

    Last publish

    Collaborators

    • sifontesdaniel