Skip to content

amulyakashyap09/fakemailfilter

Repository files navigation

Fake Mail Filter CI status Coverage Status

FakeEmailFilter is a Nodejs library checks that particular email exists or not before sending the email.

Installation

Requirements

  • Linux/Windows/Mac
  • Node > 7.4.x

$ npm install fakemailfilter --save

Usage

"use strict";

const fmf = require("./fakeEmailFilter")

const start = async ()=>{
    let fromEmail = "[email protected]";
    let toEmail = "[email protected]";
    let result = await fmf.checkIfEmailIsValid(fromEmail, toEmail)
    console.log("Result : ", result)    
}

start();

Sample Output

$ This email does not exists

{
    "email": "[email protected]", 
    "status": false, 
    "error": "this email does not exists"
}

$ This email does not exists

{
    "email": "[email protected]", 
    "status": true, 
    "error": null
}

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT