mirror of
https://github.com/disposable-email-domains/disposable-email-domains.git
synced 2024-12-12 09:54:39 +08:00
77b4363b84
clarify rule for public suffixes
246 lines
8.7 KiB
Markdown
246 lines
8.7 KiB
Markdown
List of disposable email domains
|
||
========================
|
||
This repo contains a [list of disposable and temporary email address domains](disposable_email_blocklist.conf) often used to register dummy users in order to spam or abuse some services.
|
||
|
||
We cannot guarantee all of these can still be considered disposable but we do basic checking so chances are they were disposable at one point in time.
|
||
|
||
Allowlist
|
||
=========
|
||
The file [allowlist.conf](allowlist.conf) gathers email domains that are often identified as disposable but in fact are not.
|
||
|
||
Contributing
|
||
============
|
||
Feel free to create PR with additions or request removal of some domain (with reasons).
|
||
|
||
**Specifically, please cite in your PR where one can generate a disposable email address which uses that domain, so the maintainers can verify it.**
|
||
|
||
Please add new disposable domains directly into [disposable_email_blocklist.conf](disposable_email_blocklist.conf) in the same format (only second level domains on new line without @), then run [maintain.sh](maintain.sh). The shell script will help you convert uppercase to lowercase, sort, remove duplicates and remove allowlisted domains.
|
||
|
||
License
|
||
=======
|
||
You can copy, modify, distribute and use the work, even for commercial purposes, all without asking permission.
|
||
|
||
[![Licensed under CC0](https://licensebuttons.net/p/zero/1.0/88x31.png)](https://creativecommons.org/publicdomain/zero/1.0/)
|
||
|
||
Changelog
|
||
============
|
||
|
||
* 2/11/21 We created a github [org account](https://github.com/disposable-email-domains) and transferred the repository to it.
|
||
|
||
* 4/18/19 [@di](https://github.com/di) [joined](https://github.com/martenson/disposable-email-domains/issues/205) as a core maintainer of this project. Thank you!
|
||
|
||
* 7/31/17 [@deguif](https://github.com/deguif) [joined](https://github.com/martenson/disposable-email-domains/issues/106) as a core maintainer of this project. Thanks!
|
||
|
||
* 12/6/16 - Available as [PyPI module](https://pypi.org/project/disposable-email-domains) thanks to [@di](https://github.com/di)
|
||
|
||
* 7/27/16 - Converted all domains to the second level. This means that starting from [this commit](https://github.com/martenson/disposable-email-domains/commit/61ae67aacdab0b19098de2e13069d7c35b74017a) the implementers should take care of matching the second level domain names properly i.e. `@xxx.yyy.zzz` should match `yyy.zzz` in blocklist where `zzz` is a [public suffix](https://publicsuffix.org/). More info in [#46](https://github.com/martenson/disposable-email-domains/issues/46)
|
||
|
||
* 9/2/14 - First commit [393c21f5](https://github.com/disposable-email-domains/disposable-email-domains/commit/393c21f56b5186f8db7d197b11cf1d7c5490a6f9)
|
||
|
||
Example Usage
|
||
=============
|
||
|
||
TOC: [Python](#python), [PHP](#php), [Go](#go), [Ruby on Rails](#ruby-on-rails), [NodeJS](#nodejs), [C#](#c), [bash](#bash), [Java](#java), [Swift](#swift)
|
||
|
||
### Python
|
||
```Python
|
||
with open('disposable_email_blocklist.conf') as blocklist:
|
||
blocklist_content = {line.rstrip() for line in blocklist.readlines()}
|
||
if email.partition('@')[2] in blocklist_content:
|
||
message = "Please enter your permanent email address."
|
||
return (False, message)
|
||
else:
|
||
return True
|
||
```
|
||
|
||
Available as [PyPI module](https://pypi.org/project/disposable-email-domains) thanks to [@di](https://github.com/di)
|
||
```python
|
||
>>> from disposable_email_domains import blocklist
|
||
>>> 'bearsarefuzzy.com' in blocklist
|
||
True
|
||
```
|
||
|
||
### PHP
|
||
contributed by [@txt3rob](https://github.com/txt3rob), [@deguif](https://github.com/deguif), [@pjebs](https://github.com/pjebs) and [@Wruczek](https://github.com/Wruczek)
|
||
|
||
1. Make sure the passed email is valid. You can check that with [filter_var](https://secure.php.net/manual/en/function.filter-var.php)
|
||
2. Make sure you have the mbstring extension installed on your server
|
||
```php
|
||
function isDisposableEmail($email, $blocklist_path = null) {
|
||
if (!$blocklist_path) $blocklist_path = __DIR__ . '/disposable_email_blocklist.conf';
|
||
$disposable_domains = file($blocklist_path, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
|
||
$domain = mb_strtolower(explode('@', trim($email))[1]);
|
||
return in_array($domain, $disposable_domains);
|
||
}
|
||
```
|
||
|
||
Alternatively check out Composer package https://github.com/elliotjreed/disposable-emails-filter-php.
|
||
|
||
### Go
|
||
contributed by [@pjebs](https://github.com/pjebs)
|
||
|
||
```go
|
||
import ("bufio"; "os"; "strings";)
|
||
var disposableList = make(map[string]struct{}, 3500)
|
||
func init() {
|
||
f, _ := os.Open("disposable_email_blocklist.conf")
|
||
for scanner := bufio.NewScanner(f); scanner.Scan(); {
|
||
disposableList[scanner.Text()] = struct{}{}
|
||
}
|
||
f.Close()
|
||
}
|
||
|
||
func isDisposableEmail(email string) (disposable bool) {
|
||
segs := strings.Split(email, "@")
|
||
_, disposable = disposableList[strings.ToLower(segs[len(segs)-1])]
|
||
return
|
||
}
|
||
```
|
||
|
||
Alternatively check out Go package https://github.com/rocketlaunchr/anti-disposable-email.
|
||
|
||
### Ruby on Rails
|
||
contributed by [@MitsunChieh](https://github.com/MitsunChieh)
|
||
|
||
In the resource model, usually it is `user.rb`:
|
||
|
||
```Ruby
|
||
before_validation :reject_email_blocklist
|
||
|
||
def reject_email_blocklist
|
||
blocklist = File.read('config/disposable_email_blocklist.conf').split("\n")
|
||
|
||
if blocklist.include?(email.split('@')[1])
|
||
errors[:email] << 'invalid email'
|
||
return false
|
||
else
|
||
return true
|
||
end
|
||
end
|
||
```
|
||
|
||
### Node.js
|
||
contributed by [@boywithkeyboard](https://github.com/boywithkeyboard)
|
||
|
||
```js
|
||
import { readFile } from 'node:fs/promises'
|
||
|
||
let blocklist
|
||
|
||
async function isDisposable(email) {
|
||
if (!blocklist) {
|
||
const content = await readFile('disposable_email_blocklist.conf', { encoding: 'utf-8' })
|
||
|
||
blocklist = content.split('\r\n').slice(0, -1)
|
||
}
|
||
|
||
return blocklist.includes(email.split('@')[1])
|
||
}
|
||
```
|
||
|
||
Alternatively check out NPM package https://github.com/mziyut/disposable-email-domains-js.
|
||
|
||
### C#
|
||
```C#
|
||
private static readonly Lazy<HashSet<string>> _emailBlockList = new Lazy<HashSet<string>>(() =>
|
||
{
|
||
var lines = File.ReadLines("disposable_email_blocklist.conf")
|
||
.Where(line => !string.IsNullOrWhiteSpace(line) && !line.TrimStart().StartsWith("//"));
|
||
return new HashSet<string>(lines, StringComparer.OrdinalIgnoreCase);
|
||
});
|
||
|
||
private static bool IsBlocklisted(string domain) => _emailBlockList.Value.Contains(domain);
|
||
|
||
...
|
||
|
||
var addr = new MailAddress(email);
|
||
if (IsBlocklisted(addr.Host)))
|
||
throw new ApplicationException("Email is blocklisted.");
|
||
```
|
||
|
||
### Bash
|
||
|
||
```
|
||
#!/bin/bash
|
||
|
||
# This script checks if an email address is temporary.
|
||
|
||
# Read blocklist file into a bash array
|
||
mapfile -t blocklist < disposable_email_blocklist.conf
|
||
|
||
# Check if email domain is in blocklist
|
||
if [[ " ${blocklist[@]} " =~ " ${email#*@} " ]]; then
|
||
message="Please enter your permanent email address."
|
||
return_value=false
|
||
else
|
||
return_value=true
|
||
fi
|
||
|
||
# Return result
|
||
echo "$return_value"
|
||
```
|
||
|
||
### Java
|
||
|
||
Code assumes that you have added `disposable_email_blocklist.conf` next to your class as classpath resource.
|
||
|
||
```Java
|
||
private static final Set<String> DISPOSABLE_EMAIL_DOMAINS;
|
||
|
||
static {
|
||
Set<String> domains = new HashSet<>();
|
||
try (BufferedReader in = new BufferedReader(
|
||
new InputStreamReader(
|
||
EMailChecker.class.getResourceAsStream("disposable_email_blocklist.conf"), StandardCharsets.UTF_8))) {
|
||
String line;
|
||
while ((line = in.readLine()) != null) {
|
||
line = line.trim();
|
||
if (line.isEmpty()) {
|
||
continue;
|
||
}
|
||
|
||
domains.add(line);
|
||
}
|
||
} catch (IOException ex) {
|
||
LOG.error("Failed to load list of disposable email domains.", ex);
|
||
}
|
||
DISPOSABLE_EMAIL_DOMAINS = domains;
|
||
}
|
||
|
||
public static boolean isDisposable(String email) throws AddressException {
|
||
InternetAddress contact = new InternetAddress(email);
|
||
return isDisposable(contact);
|
||
}
|
||
|
||
public static boolean isDisposable(InternetAddress contact) throws AddressException {
|
||
String address = contact.getAddress();
|
||
int domainSep = address.indexOf('@');
|
||
String domain = (domainSep >= 0) ? address.substring(domainSep + 1) : address;
|
||
return DISPOSABLE_EMAIL_DOMAINS.contains(domain);
|
||
}
|
||
```
|
||
|
||
### Swift
|
||
contributed by [@1998code](https://github.com/1998code)
|
||
|
||
```swift
|
||
func checkBlockList(email: String, completion: @escaping (Bool) -> Void) {
|
||
let url = URL(string: "https://raw.githubusercontent.com/disposable-email-domains/disposable-email-domains/master/disposable_email_blocklist.conf")!
|
||
let task = URLSession.shared.dataTask(with: url) { data, response, error in
|
||
if let data = data {
|
||
if let string = String(data: data, encoding: .utf8) {
|
||
let lines = string.components(separatedBy: "\n")
|
||
for line in lines {
|
||
if email.contains(line) {
|
||
completion(true)
|
||
return
|
||
}
|
||
}
|
||
}
|
||
}
|
||
completion(false)
|
||
}
|
||
task.resume()
|
||
}
|
||
```
|