A Node.js and web browser compatible script that takes an email address and tries to generate a name.
Privacy conscious individuals often use the name of website as the email identifier. If Jane Smith has her own domain name with an email server, she might sign up as suspiciouswebsite@janesmith.com
. That way if "Suspicious Website" ends up selling her email address on to a third party, if they send this exact email address spam, it's possible to see who leaked her email address.
It's also therefore possible to invert this method and detect the personal domain if the email identifier matches your company/website name.
No Company Names
emailToName.process('acloudguru@janesmith.com')
- Output:
Acloudguru
- Output:
With Company Names
emailToName.process('acloudguru@janesmith.com', { companyNames: ['acg', 'acloudguru'] })
- Output:
Janesmith
- Output:
Users who operate a personal email domain sometimes use prefixes like contact
, hello
, me
and others. This script also tries to invert those.
Value | Default | Example (Input) | Example (On) | Example (Off) |
---|---|---|---|---|
removePlusWords |
true |
tait.brown+test@gmail.com |
Tait Brown |
Tait Brown+test |
removeNumbers |
true |
tait123@gmail.com |
Tait |
Tait123 |
titleCase |
true |
tait.brown@gmail.com |
Tait Brown |
tait brown |
caseMc |
true |
john.mckim@gmail.com |
John McKim |
John Mckim |
caseLetterApostrophe |
true |
flannery.o'connor@gmail.com |
Flannery O'Connor |
Flannery O'connor |
uppercaseGenerationalNumbers |
true |
tait.brown.iii@gmail.com |
Tait Brown III |
Tait Brown Iii |
commaPrependGenerationalPhrase |
true |
tait.brown.jr@gmail.com |
Tait Brown, Jr. |
Tait Brown Jr |
appendPeriodToTitlePrefix |
true |
prof.tait.brown@gmail.com |
Prof. Tait Brown |
Prof Tait Brown |
lowercaseFamilyParticle |
true |
dutch.van.der.linde@gmail.com |
Dutch van der Linde |
Dutch Van Der Linde |
Attempt to use the domain name as the personal identifier when these common email identifiers are used 'hello', 'me', 'email', 'contact'
Prepend a comma and append a period for the following, when at the end of a string and preceded by a space 'jr', 'jnr', 'sr', 'snr'
Uppercase these whe at the end of a string and preceded by a space 'ii', 'iii', 'iv'
Append a period when the following occur at the beginning of a string and are followed by a space 'mr', 'mrs', 'ms', 'dr', 'prof'
Run tests. Requires yarn.
yarn test
- @taitems - Package creator, maintainer
- @felipehertzer - Added types
2.0.7
- Added types (thanks @felipehertzer )2.0.[1..6]
- Addingrelease
task wasted commits2.0.0
- Building withesbuild
with browser targetschrome58,firefox57,safari11,edge16
1.1.0
- Borrowed heavily fromnamecase
libraries- ADDED: Various lowercase conjunctions "son/daughter of" as per namecase
1.0.0
Breaking Change: Relocated company names and common personal identifiers toparams
0.2.0
Bugfix: Couldn't use in browser due tomodule
check0.1.0
added generational handling (Jr, Sr, III etc) as well as titles (Mr, Mrs, Dr, Prof)0.0.0
init commit