https://github.com/taitems/email-to-name
Generate a name from an email address based on common patterns
https://github.com/taitems/email-to-name
email-identifier email-validation hacktoberfest user-experience user-identification
Last synced: about 1 year ago
JSON representation
Generate a name from an email address based on common patterns
- Host: GitHub
- URL: https://github.com/taitems/email-to-name
- Owner: taitems
- Created: 2018-07-25T08:21:36.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2025-02-11T23:13:55.000Z (over 1 year ago)
- Last Synced: 2025-03-30T13:36:05.522Z (about 1 year ago)
- Topics: email-identifier, email-validation, hacktoberfest, user-experience, user-identification
- Language: JavaScript
- Homepage:
- Size: 788 KB
- Stars: 35
- Watchers: 2
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
[](https://github.com/taitems/email-to-name/actions/workflows/actions.yml)
# Email to Name
A Node.js and web browser compatible script that takes an email address and tries to generate a name.
## Company Names
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`
**With Company Names**
- `emailToName.process('acloudguru@janesmith.com', { companyNames: ['acg', 'acloudguru'] })`
- Output: `Janesmith`
## Common Email Identifiers
Users who operate a personal email domain sometimes use prefixes like `contact`, `hello`, `me` and others. This script also tries to invert those.
## Parameters
| 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` |
## Default Values
#### Common Personal Identifiers
Attempt to use the domain name as the personal identifier when these common email identifiers are used `'hello', 'me', 'email', 'contact'`
#### Generational Suffixes
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'`
#### Generational Numbers
Uppercase these whe at the end of a string and preceded by a space `'ii', 'iii', 'iv'`
#### Titles
Append a period when the following occur at the beginning of a string and are followed by a space `'mr', 'mrs', 'ms', 'dr', 'prof'`
## Development
Run tests. Requires yarn.
`yarn test`
## Contributors
- [@taitems](https://github.com/taitems) - Package creator, maintainer
- [@felipehertzer](https://github.com/felipehertzer) - Added types
## Changelog
- `2.0.7` - Added types (thanks [@felipehertzer](https://github.com/felipehertzer) )
- `2.0.[1..6]` - Adding `release` task wasted commits
- `2.0.0` - Building with `esbuild` with browser targets `chrome58,firefox57,safari11,edge16`
- `1.1.0` - Borrowed heavily from `namecase` libraries
- **ADDED:** Various lowercase conjunctions "son/daughter of" as per namecase
- `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` check
- `0.1.0` added generational handling (Jr, Sr, III etc) as well as titles (Mr, Mrs, Dr, Prof)
- `0.0.0` init commit