README.md

A RFC compliant Email validator

Migrated to https://git.sceptique.eu/Sceptique/CrystalEmail

Prelude

• What is an Email Address ?
• What is a Domain Name ?

Compliance

• Compliant to the Rfc 5322.
• Compliant to the Rfc 1123.

To do

• To do : rfc 6530.
• To do : Implement IPv6

Notes

• No ipv6 for now
• No escaped characters
• Public email validity (no raw ip, domain withour root domain, ...)

Installation

Tested with crystal 0.17 - 1.1.0

Add this to your application's shard.yml:

dependencies:
  CrystalEmail:
      git: https://git.sceptique.eu/Sceptique/CrystalEmail
      branch: master

Usage in Crystal

require "CrystalEmail"

# Pure Rfc5322
# this is what you want if you need to allow local domains
CrystalEmail::Rfc5322.validates? "toto@tata" # => true
CrystalEmail::Rfc5322.match "toto@tata" # => #<MatchData "toto@tata" local:"toto" domain:"tata">
CrystalEmail::Rfc5322.validates? "toto" # => false
CrystalEmail::Rfc5322.match "toto" # => nil

# Rfc5322 + Internet basic usage
# most of the website on internet will require a domain like "domain.thing"
CrystalEmail::Rfc5322::Public.validates? "[email protected]" # => true
CrystalEmail::Rfc5322::Public.match "[email protected]" # => #<MatchData "toto@tata" local:"toto" domain:"tata.com">

"[email protected]".is_email? # => true

Contributes !

Find a bug ? Want a new feature ? Create a clear pull request and we'll see :)

• Sceptique