Generate a name from an email address based on common patterns
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 [email protected]
. 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('[email protected]')
Acloudguru
With Company Names
emailToName.process('[email protected]', { companyNames: ['acg', 'acloudguru'] })
Janesmith
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 |
[email protected] |
Tait Brown |
Tait Brown+test |
removeNumbers |
true |
[email protected] |
Tait |
Tait123 |
titleCase |
true |
[email protected] |
Tait Brown |
tait brown |
caseMc |
true |
[email protected] |
John McKim |
John Mckim |
caseLetterApostrophe |
true |
flannery.o'[email protected] |
Flannery O'Connor |
Flannery O'connor |
uppercaseGenerationalNumbers |
true |
[email protected] |
Tait Brown III |
Tait Brown Iii |
commaPrependGenerationalPhrase |
true |
[email protected] |
Tait Brown, Jr. |
Tait Brown Jr |
appendPeriodToTitlePrefix |
true |
[email protected] |
Prof. Tait Brown |
Prof Tait Brown |
lowercaseFamilyParticle |
true |
[email protected] |
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
2.0.7
- Added types (thanks @felipehertzer )2.0.[1..6]
- Adding release
task wasted commits2.0.0
- Building with esbuild
with browser targets chrome58,firefox57,safari11,edge16
1.1.0
- Borrowed heavily from namecase
libraries
1.0.0
Breaking Change: Relocated company names and common personal identifiers to params
0.2.0
Bugfix: Couldn't use in browser due to module
check0.1.0
added generational handling (Jr, Sr, III etc) as well as titles (Mr, Mrs, Dr, Prof)0.0.0
init commit