mailchecker

What is mailchecker?

The mailchecker npm package is used to validate email addresses and check if they belong to disposable email providers. This can be useful for preventing users from signing up with temporary email addresses that may be used for spam or fraudulent activities.

What are mailchecker's main functionalities?

Validate Email Address

This feature allows you to check if an email address is valid and not from a disposable email provider. The `isValid` method returns a boolean indicating the validity of the email.

const mailchecker = require('mailchecker');

const email = '[e-mail]';
const isValid = mailchecker.isValid(email);
console.log(`Is the email valid? ${isValid}`);

Check Disposable Email

This feature allows you to specifically check if an email address is from a disposable email provider. The `isDisposable` method returns a boolean indicating whether the email is disposable.

const mailchecker = require('mailchecker');

const email = '[e-mail]';
const isDisposable = mailchecker.isDisposable(email);
console.log(`Is the email disposable? ${isDisposable}`);

Other packages similar to mailchecker

email-verifier

The email-verifier package provides email verification and validation services. It checks the syntax, domain, and mailbox existence. Compared to mailchecker, it offers more comprehensive email validation features, including SMTP checks.

disposable-email-domains

The disposable-email-domains package provides a list of disposable email domains. It is a simpler package compared to mailchecker, focusing solely on identifying disposable email domains without additional validation features.

email-existence

The email-existence package checks if an email address exists by connecting to the mail server. It provides a more in-depth validation compared to mailchecker, which primarily focuses on identifying disposable emails.

README

MailChecker

Cross-language email validation. Backed by a database of over 55 000 throwable email domains.

• Validate the format of your email (uses validator.js email regex underneath and FILTER_VALIDATE_EMAIL for PHP)
• Validate if the email is not a temporary mail (yopmail-like..., add your own dataset to list.txt)

This will be very helpful when you have to contact your users and you want to avoid errors causing lack of communication or want to block "spamboxes".

---

Need to provide Webhooks inside your SaaS?

• Try Hook0, an open-source self-hostable webhook micro-service

Need to embed a charts into an email?

It's over with Image-Charts, no more server-side rendering pain, 1 url = 1 chart.

https://image-charts.com/chart?
cht=lc // chart type
&chd=s:cEAELFJHHHKUju9uuXUc // chart data
&chxt=x,y // axis
&chxl=0:|0|1|2|3|4|5| // axis labels
&chs=873x200 // size

Use Image-Charts for free

---

Upgrade

From 3.x to 4.x

• PHP

# import using the fully qualified name.
use Fgribreau\MailChecker;

// ...
echo MailChecker::isValid('[e-mail]');

From 1.x to 3.x

Mailchecker public API has been normalized, here are the changes:

• NodeJS/JavaScript: MailChecker(email) -> MailChecker.isValid(email)
• PHP: MailChecker($email) -> MailChecker::isValid($email)
• Python

import MailChecker
m = MailChecker.MailChecker()
if not m.is_valid('[e-mail]'):
  # ...

became:

import MailChecker
if not MailChecker.is_valid('[e-mail]'):
  # ...

---

MailChecker currently supports:

• NodeJS (CommonJS, Instructions)
• JavaScript (Client-Side, Instructions)
• PHP (Instructions)
• Python (Instructions)
• Ruby (Instructions)
• Rust (Instructions)
• Elixir (Instructions)
• Clojure (Instructions)
• Go (Instructions)
• Easily add support for your own language with MailChecker template system and send us a pull-request!

---

Usage

NodeJS

var MailChecker = require('mailchecker');

if(!MailChecker.isValid('[e-mail]')){
  console.error('O RLY !');
  process.exit(1);
}

if(!MailChecker.isValid('myemail.com')){
  console.error('O RLY !');
  process.exit(1);
}

JavaScript

<script type="text/javascript" src="MailChecker/platform/javascript/MailChecker.js"></script>
<script type="text/javascript">
if(!MailChecker.isValid('[e-mail]')){
  console.error('O RLY !');
}

if(!MailChecker.isValid('myemail.com')){
  console.error('O RLY !');
}
</script>

PHP

use Fgribreau\MailChecker;

require __DIR__ . '/vendor/autoload.php';

if(!MailChecker::isValid('[e-mail]')){
  die('O RLY !');
}

if(!MailChecker::isValid('myemail.com')){
  die('O RLY !');
}

Python

pip install mailchecker

# no package yet; just drop in MailChecker.py where you want to use it.
from MailChecker import MailChecker

if not MailChecker.is_valid('[e-mail]'):
    print "O RLY !"

Django validator: https://github.com/jonashaag/django-indisposable

Ruby

require 'mail_checker'

unless MailChecker.valid?('[e-mail]')
  fail('O RLY!')
end

Rust

 extern crate mailchecker;

assert_eq!(true, mailchecker::is_valid("[e-mail]"));
assert_eq!(false, mailchecker::is_valid("\[e-mail]\n"));
assert_eq!(false, mailchecker::is_valid("[e-mail]"));

Elixir

Code.require_file("mail_checker.ex", "mailchecker/platform/elixir/")

unless MailChecker.valid?("[e-mail]") do
  raise "O RLY !"
end

unless MailChecker.valid?("myemail.com") do
  raise "O RLY !"
end

Clojure

; no package yet; just drop in mailchecker.clj where you want to use it.
(load-file "platform/clojure/mailchecker.clj")

(if (not (mailchecker/valid? "[e-mail]"))
  (throw (Throwable. "O RLY!")))

(if (not (mailchecker/valid? "myemail.com"))
  (throw (Throwable. "O RLY!")))

Go

package main

import (
  "log"
  
  "github.com/FGRibreau/mailchecker/platform/go"
)

if !mail_checker.IsValid('[e-mail]') {
  log.Fatal('O RLY !');
}

if !mail_checker.IsValid('myemail.com') {
  log.Fatal("O RLY !")
}

---

Installation

Go

go get https://github.com/FGRibreau/mailchecker

NodeJS/JavaScript

npm install mailchecker

Ruby

gem install ruby-mailchecker

PHP

composer require fgribreau/mailchecker

We accept pull-requests for other package manager.

Data sources

TorVPN

  $('td', 'table:last').map(function(){
    return this.innerText;
  }).toArray();

BloggingWV

  Array.prototype.slice.call(document.querySelectorAll('.entry > ul > li a')).map(function(el){return el.innerText});

... please add your own dataset to list.txt.

Regenerate libraries from list.txt

Just run (requires NodeJS):

npm run build

Development

Development environment requires docker.

# install and setup every language dependencies in parallel through docker
npm install

# run every language setup in parallel through docker
npm run setup

# run every language tests in parallel through docker
npm test

Backers

Maintainers

These amazing people are maintaining this project:

• Francois-Guillaume Ribreau

Sponsors

No sponsors yet! Will you be the first?

Contributors

These amazing people have contributed code to this project:

• Owen Stephens
• Jacob Burenstam Linder
• Herman Slatman
• trisix — view contributions
• Greenkeeper
• Dustin Clark
• Anton Zhiyanov
• Bruel Nicolas — view contributions
• Robin — view contributions
• Spir — view contributions
• Vincent Giersch
• Adrian Carolli
• Dave Powers
• Frank Phillips — view contributions
• LuckyDino — view contributions
• ven — view contributions
• Romain Gay
• Sebastian Cohnen
• Dalai — view contributions
• quaswex — view contributions
• sxyuan — view contributions
• Francois-Guillaume Ribreau
• Dusty
• larsvegas
• Zeeshan Muhammad
• kkleejoe — view contributions
• Luiz Freneda
• thorinisme — view contributions
• Liudas Šumskas — view contributions
• Alexander — view contributions
• Alex Dom￸aki￸dis
• Carlos Rios
• Jacek Bzdak — view contributions
• D — view contributions
• Jonas Haag
• ￸A￸l￸e￸x D￸o￸m￸a￸k￸i￸d￸i￸s
• Dan McGregor — view contributions
• Thiago Rodrigues
• Dilli Labs LLC
• Kieron Lawson
• Kslr
• Lint
• chadliu23 — view contributions
• milkyklim
• Sharat M R — view contributions
• Nicolas Perraud — view contributions
• tbdmainrepo — view contributions
• Kslr — view contributions
• Fabio Caccamo
• cyril souillard — view contributions
• Grégoire Pineau
• Bruno Bossola
• florian-crtl — view contributions
• mikeyzm
• Grégoire Pineau
• alonga — view contributions
• Vitalii Tverdokhlib
• Francis Chuang — view contributions
• mikeyzm — view contributions
• Pascal Vizeli
• Caroline — view contributions
• Daniel Mihai
• HWVS — view contributions
• seb's — view contributions
• Chigusa0w0
• Maki

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Changelog

License

Unless stated otherwise all works are:

• Copyright © Francois-Guillaume Ribreau

and licensed under:

• MIT License

Changelog

v6.0.13 (2024/11/27 12:09 +00:00)

• 0ba4ccb Bump version to 6.0.13Release v6.0.13. (@FGRibreau)
• 688512e feat(build): update platform Dockerfiles to use rust 1.82.0 and latest Cargo versionfeat(build): update plateform files (@FGRibreau)
• 690239a bump cargo version to 4 and rust to 6.0.12bump (@FGRibreau)
• #502 Merge pull request #502 from dimbleby/publish-wheels (@dimbleby)
• e83ad8e publish wheels (@dimbleby)
• 8542ef0 feat(cargo): updated to 6.0.12 (@FGRibreau)
• 0f41746 feat(python): updated to 6.0.12 (@FGRibreau)
• 1bef23b feat(gemspec): updated to 6.0.12 (@FGRibreau)
• 0e46d3e feat: update changelog (@FGRibreau)