Email Cleaner

What's the difference between [e-mail], [e-mail], [e-mail], and johnsmith+anything@gmail? To the email server, there is none! They'd all send to the same email addresses!

Users can take advantage of these tricks to create multiple account with email addresses that will still send to the same account.

However, most backend developer like myself are probably really lazy to even check that stuff. They probably do SELECT * FROM USER WHERE email=[e-mail] or User.find({email: req.body.email}) thus sneakily allowing cheeky users to slip through the cracks. With Email Cleaner it'll prevent users from doing so. Just use it before you send a request to the server, or before you insert it into the database

Feel free to contribute to this project! It's open for pull requests and issues! https://github.com/destroyer22719/email-cleaner

Table of Contents

• How to Use
• Documentation
  • email: string
  • configuration
    • validate: boolean
    • validator: Regex
    • defaultOptions: options
    • excluedDomains: string[]
    • cases: caseOptions[]
    • overrideDefaultCases: boolean
    • options (type)
    • caseOptions (type)

How to Use

Using this module is super simple! It has been tested on NodeJS version 12.0.0 and above.

installation:

npm: npm install email-cleaner

yarn: yarn add email-cleaner

const emailCleaner = require("email-cleaner"); //CommonJS
import emailCleaner from "email-cleaner"; //ES Module

emailCleaner("[e-mail]") // [e-mail]
emailCleaner("[e-mail]") //returns [e-mail]
emailCleaner("[e-mail]") //returns [e-mail]
emailCleaner("[e-mail]") //returns [e-mail]

Documentation

emailCleaner(email, [configuration])

returns type string, or null when email address doesn't match Regex and validate configuration has been set to true (by default it's set to false)

Reminder: By default it won't clean email addresses with periods unless if it's gmail.com. Since it appears in outlook.com/hotmail.com, and yahoo.com emails periods do matter. You can override this by setting defaultOptions. + signs also won't be cleaned by default on yahoo.com as it seems to not work.

email: string

Required

email/string for the function to clean

configuration

Optional

All configurations are optional and are set to the default if not defined, see below for more details

set options that allows you to control how this module works

    validate?: boolean,
    validatorRegex?: RegExp,
    excludedDomains?: string[],
    defaultOptions?: options,
    cases?: caseOptions[],
    overrideDefaultCases?: boolean,

validate: boolean

default: false

Define whether or not you want the string to be validated. If it doesn't match, it'll return null. Else returns string.

validatorRegex: Regex

default: /^(?!\.)[a-z0-9\.\-\+]+@([a-z]+)(\.[a-z]+)+$/i

explaination: Includes case insensitivity*,

^(?!\.): Cannot start with a .

[a-z0-9\.\-\+]+: Include all letters, numbers, -, ., and + one or more times

@([a-z]+): an @ followed by any letter one or more times

(\.[a-z]+)+$: proceeding and/or end with a . and any letter. Eg. .com, school.edu.com, etc.

Set your own custom Regular Expression to validate

defaultOptions: options

See the options type here

Set options for email cleaning. Applies to any domain unless if specified in cases

excludedDomains: string[]

default: []

a string on domains to exclude from cleaning. Note: Don't include the @ sign in array of strings

default:

    defaultOptions: {
        caseSensitive: true,
        periods: false,
        plusSign: true,
    },

cases: caseOptions[]

Sets the options on what should be cleaned if there are any matches of email domain. See caseOptions for further information on configuring.

default:

    defaultCases: [
        {
            domains: ["gmail.com"],
            options: {
                caseSensitive: true,
                periods: true,
                plusSign: true,
            }
        },
        {
            domains: ["outlook.com, hotmail.com"],
            options: {
                caseSensitive: true,
                periods: false,
                plusSign: true,
            }
        },
        {
            domains: ["yahoo.com"],
            options: {
                caseSensitive: true,
                periods: false,
                plusSign: false,
            }
        }
    ]

Any domains written on the cases array that matches the defaultCases array will be overwitten, with the larger the index of the index having their option specified to their domain used. DO NOT change the defaultCases array. If you want to remove it look at overrideDefaultCases

Note: After a few experiments. Removing the . for email providers doesn't work for email providers that aren't gmail.com. Thus the periods option has been set to gmail domains only. It appears with yahoo a [e-mail] doesn't work either, thus plusSign has been set to false as well as periods.

overrideDefaultCases: boolean

default: false

This will remove the defaultCases above. Set to true if you wish to remove them.

options (type)

(type used in defaultOptions and caseOptions.options)

    caseSensitive?: boolean,
    periods?: boolean,
    plusSign?: boolean,

caseSensitive: cleans emails and converts letters all to lowercase

Example

emailClean("[e-mail]", {
    defaultOptions: {
        caseSensitive: true //default
    }
}) // [e-mail]

emailClean("[e-mail]", {
    defaultOptions: {
        caseSensitive: false
    }
}) // [e-mail]

periods: cleans emails and removes . if set to true

Example

emailClean("[e-mail]", {
    defaultOptions: {
        periods: true
    }
}) // [e-mail]

emailClean("[e-mail]", {
    defaultOptions: {
        periods: false //default
    }
}) // [e-mail]

plusSign: cleans emails and removes the + character and anything between it and an @ if set to true

Example

emailClean("[e-mail]", {
    defaultOptions: {
        plusSign: true //default
    }
}) // [e-mail]

emailClean("[e-mail]", {
    defaultOptions: {
        plusSign: false
    }
}) // [e-mail]

caseOptions (type)

Used in cases in the configuration

    domains: string[],
    options: options

domains: A list of domains you want include and apply options for, do not use the @ sign.

Example domains: ["test.com", "other.com"]

See the options type above to apply these options on the matching domain