https://github.com/dunckr/email-obfuscate
Protect email addresses from being simply scraped by bots.
https://github.com/dunckr/email-obfuscate
email-obfuscator javascript-library
Last synced: 9 months ago
JSON representation
Protect email addresses from being simply scraped by bots.
- Host: GitHub
- URL: https://github.com/dunckr/email-obfuscate
- Owner: dunckr
- Created: 2015-10-17T13:10:19.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-09-09T18:04:46.000Z (over 8 years ago)
- Last Synced: 2025-09-03T09:52:24.208Z (9 months ago)
- Topics: email-obfuscator, javascript-library
- Language: JavaScript
- Homepage: http://dunckr.github.io/email-obfuscate/example/
- Size: 146 KB
- Stars: 29
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Email Obfuscate [](https://travis-ci.org/dunckr/email-obfuscate)
Guard email addresses from being simply scraped by bots.
## Demo
[http://dunckr.github.io/email-obfuscate/example/](http://dunckr.github.io/email-obfuscate/example/)
## Overview
Email addresses are [harvested](https://en.wikipedia.org/wiki/Email_address_harvesting) from websites using [web scrapers](https://github.com/lorien/awesome-web-scraping).
There are many strategies that can be employed to mitigate scrapers:
[1,](http://security.stackexchange.com/questions/81964/are-web-scrapers-fooled-by-obscured-emails-anymore)
[2,](https://www.quora.com/Whats-the-best-way-to-prevent-email-scraping)
[3,](http://stackoverflow.com/questions/3161548/how-do-i-prevent-site-scraping)
[4.](http://stackoverflow.com/questions/23002711/how-to-show-email-addresses-on-the-website-to-avoid-spams)
However, it must be noted that preventing scraping is an [arms-race](https://en.wikipedia.org/wiki/Arms_race).
This library's aim to prevent searching for ```mailto``` links or using email address regexes.
It does this by constructing an email address from an object then drawing the text as an image using the canvas.
For older browsers without a canvas (IE8) we append an element using the alternate text.
## Installation
```sh
npm install email-obfuscate --save
```
## Usage
```js
import EmailObfuscate from 'email-obfuscate';
var el = document.getElementById('email');
EmailObfuscate(el, {
// Email construct: name@domain.tld
name: 'test',
domain: 'example',
tld: 'com',
// Alternate Text
altText: 'Email'
});
```
## API
### EmailObfuscate(el, [options])
#### el
Type: `HTMLElement`
The element to replace with EmailObfuscate.
#### options
##### name
Type: `string`
Default: `test`
The name portion of the email address to use (**name**@email.com).
##### domain
Type: `string`
Default: `example`
The domain name portion of the email address to use (name@**email**.com).
##### tld
Type: `string`
Default: `com`
The top-level domain portion of the email address to use (name@email.**com**).
##### altText
Type: `string`
Default: `Email`
The alternate text to use to represent the email address.
## Dev
```sh
npm run start
```
## Test
```sh
npm run test
```
## Build
```sh
npm run build
```
## License
MIT © [Duncan Beaton](http://dunckr.com)