You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+39-29Lines changed: 39 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,46 +1,64 @@
1
1
# Disposable Email Domains
2
2
3
+
A list of [disposable email domains](http://en.wikipedia.org/wiki/Disposable_email_address) (like `mailinator.com`) commonly used to create temporary accounts. Use this list to detect or block fake accounts during your signup process.
3
4
4
-
A list of [disposable email domains](http://en.wikipedia.org/wiki/Disposable_email_address) like `mailinator.com`. You can use it to detect or block disposable accounts in your signup process. Exact domain matches are found in [index.json](https://github.com/tompec/disposable-email-domains/blob/main/index.json) and wildcard domains (ex: `*.33mail.com`) are in [wildcard.json](https://github.com/tompec/disposable-email-domains/blob/main/wildcard.json).
5
+
## Installation
6
+
7
+
```bash
8
+
npm install disposable-domains
9
+
```
5
10
6
-
## Examples
11
+
## Usage
12
+
13
+
This package exports an array of domains. You can check if an email domain exists in the list:
7
14
8
-
### Node.JS
9
15
```js
10
-
var domains=require('disposable-domains');
11
-
var wildcards=require('disposable-domains/wildcard.json');
2. Add your disposable domains to [contributions/index.txt](https://github.com/tompec/disposable-email-domains/blob/main/contributions/index.txt) (one domain per line, without any additional formatting)
46
+
2. Add domains to [contributions/index.txt](https://github.com/tompec/disposable-email-domains/blob/main/contributions/index.txt):
47
+
- One domain per line
48
+
- No extra formatting
30
49
31
-
3. Run the [domain manager script](https://github.com/tompec/disposable-email-domains/blob/main/scripts/domain-manager.js):
32
-
```
50
+
3. Build the list:
51
+
52
+
```bash
33
53
npm run process
34
54
```
35
-
That script will:
36
-
- Add your domains to index.json
37
-
- Validate domains using the FQDN (Fully Qualified Domain Name) standard
38
-
- Move domains to wildcard.json if they have 2 or more subdomains
39
-
- Sort and deduplicate all entries
40
-
- Run the tests to ensure everything is working correctly
55
+
56
+
This validates, sorts, and deduplicates your entries.
41
57
42
58
## License
43
59
60
+
MIT — see [LICENSE](LICENSE) for details.
61
+
44
62
```
45
63
WWWWWW||WWWWWW
46
64
W W W||W W W
@@ -53,11 +71,3 @@ WWWWWW||WWWWWW
53
71
_||_|| _||_||
54
72
(__|__|(__|__|
55
73
```
56
-
57
-
THE SOFTWARE IS PROVIDED "AS IS" AND "AS AND WHEN AVAILABLE", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
58
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
59
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
60
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
61
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
62
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
0 commit comments