rawpixel

rawpixel-vincent

delta9-vincent

obfuscate-mail

    "test:bundle": "cp test/obfuscate.js test/obfuscate.bundle.js && echo 'const obfuscate = require(\"../dist/bundle\");const { DEFAULT_OPTIONS } = require(\"../dist/bundle\");' | cat - test/obfuscate.bundle.js > temp && mv temp test/obfuscate.bundle.js && mocha test/obfuscate.bundle.js && rm test/obfuscate.bundle.js",

    "test:source": "cp test/obfuscate.js test/obfuscate.source.js && echo 'const obfuscate = require(\"../obfuscateEmail\");const { DEFAULT_OPTIONS } = require(\"../utils\");' | cat - test/obfuscate.source.js > temp && mv temp test/obfuscate.source.js && mocha test/obfuscate.source.js && rm test/obfuscate.source.js",

    "build": "npm run types:emit && npm run bundle && npm run build:esm",

    "build:esm": "npx gen-esm-wrapper dist/bundle.js dist/bundle.mjs",

    "bundle": "rm -f dist/bundle.js && mkdir -p dist && browserify --standalone obfuscateEmail --node --ignore-missing obfuscateEmail.js | terser > ./dist/bundle.js",

    "types:emit": "tsc --allowJs --removeComments",

    "coverage": "nyc --reporter=lcov npm run test:source",

    "precommit": "npm run build && npm run test:bundle && git add dist/."

    "url": "git+https://github.com/rawpixel-vincent/obfuscate-email.git"

    "url": "https://github.com/rawpixel-vincent/obfuscate-email/issues"

  "homepage": "https://github.com/rawpixel-vincent/obfuscate-email#readme",

[![npm](https://img.shields.io/npm/v/obfuscate-mail)](https://www.npmjs.com/package/obfuscate-mail)

![Tests](https://github.com/rawpixel-vincent/obfuscate-mail/actions/workflows/node.js.yml/badge.svg)

[![Coverage Status](https://coveralls.io/repos/github/rawpixel-vincent/obfuscate-mail/badge.svg)](https://coveralls.io/github/rawpixel-vincent/obfuscate-mail?branch=main)

![license](https://img.shields.io/npm/l/obfuscate-mail)

Email addresses should never been displayed by an api unless specifically requested by a recently authentified user.

This node.js library gives the options to obfuscate email addresses will leaving them more or less identifiable.

const obfuscate = require('obfuscate-mail');

obfuscate('example.example@example.com', {

  // invalidEmailValue: '*********@****.**',

- `minimumNameObfuscationLength` - default `4`

- `visibleCharactersStartLength` - default `3`

- `visibleCharactersMiddleLength` - default `2`

- `visibleCharactersEndLength` - default `2`

- `invalidEmailValue` - default `*********@****.**`

## [Test it with runKit](https://runkit.com/rawpixel-vincent/obfuscate-email)

const result = obfuscate('example@example.com');

expect(result).equal('exa******@***.com');

const result = obfuscate('example.example@example.com');

expect(result).equal('exa***.e***le@***.com');

const result = obfuscate('e@example.com');

const result = obfuscate('exa@example.com');

const result = obfuscate('examp@example.com');

const result = obfuscate('example@example.com', {

expect(result).equal('exa******@example.com');

const result = obfuscate('example.company+test@example.com', {

expect(result).equal('exa******mp******st@*********.com');

expect(result).equal('exa******@example.***');

const result = obfuscate('company.name@test.com', {

expect(result).equal('co****ny****ame@*****.com');

expect(result).equal('comp***.***e@***.com');

expect(result).equal('com***y***me@***.com');

const result = obfuscate('company.example@test.com', {

expect(result).equal('co***y.e***le@***.com');

		{
		"name": "obfuscate-mail",
		"version": "1.4.4",
		"version": "1.4.5",
		"description": "Obfuscate email",
		@@ -5,0 +5,0 @@ "main": "obfuscateEmail.js",

		@@ -15,2 +15,3 @@ # obfuscate mail
		```

		```sh
		@@ -22,14 +23,21 @@ yarn add obfuscate-mail
		const obfuscate = require('obfuscate-mail');

		obfuscate('example@example.com');
		// => exa****@*.com
		```


		```js
		import obfuscate from 'obfuscate-mail';
		```

		obfuscate('example@example.com');
		// => exa****@*.com
		```js
		obfuscate('example.example@example.com', {
		// asterisksLength: 6,
		// minimumNameObfuscationLength: 4,
		// visibleCharactersStartLength: 3,
		// visibleCharactersMiddleLength: 2,
		// visibleCharactersEndLength: 2,
		// showDomainName: false,
		// showDomainExtension: true,
		// invalidEmailValue: '*******@.',
		});
		```
		> `=> exa*.ele@**.com`

		@@ -36,0 +44,0 @@ ## Options

Improved metrics