email-scramble

email-scramble

Scrambles email addresses to hide them from bots. This library can be used server-side with Node/io.js or on the front-end.

Have a look at the examples.

If you'd like to know more about email obfuscation techniques and their success ratio, here's a great blog post on the subject.

Getting Started

email-scramble uses a simple ROT transformation. The rotation amount can be any integer between 1 and 25. 0 and 26 won't produce any transformation, other numbers are useless (e.g. ROT-42 = ROT-16).

  // To encode, first pick the ROT amount you want.
  var encode = emailScramble.encoder(16);
  var encodedEmail = encode('[e-mail]');

  // To decode, you should pick the same ROT amount.
  var decode = emailScramble.decoder(16);
  var decodedMail = decode(encodedMail);

Here's a real-world example:

  (function (emailScramble) {
    'use strict';
    var decode = emailScramble.decoder(5);

    // <a id="scrambled" href="rfnqyt:[e-mail]">[e-mail]</a>
    var link = document.getElementById('scrambled');
    link.href = decode(link.href);
    link.innerHTML = decode(link.innerHTML);

Download & import

email-scramble is available on npm and bower, or you can download a ZIP

$ npm install --save email-scramble
$ bower install --save email-scramble

This library can be used as a Node/io.js/Browserify CommonJS-like module, a RequireJS AMD module or a global:

    // The CommonJS way.
    var emailScramble = require('email-scramble');

    // Require email-scramble when defining an AMD module.
    define('mypackage', ['email-scramble'], function (emailScramble) {
      // [...]
    });

    // Global variable.
    var emailScramble = window.emailScramble;

Contributing

$ npm install
$ npm test
$ npm run lint

Built with

• https://github.com/mathiasbynens/rot
• https://github.com/umdjs/umd

LICENSE (ISC)

Copyright (c) 2015, Thibaud Colas

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.