# Truemail [![Gem Version](https://badge.fury.io/rb/truemail.svg)](https://badge.fury.io/rb/truemail) [![CircleCI](https://circleci.com/gh/rubygarage/truemail/tree/feature/validator-result-class.svg?style=svg)](https://circleci.com/gh/rubygarage/truemail/tree/feature/validator-result-class) The main idea of this gem is to validate emails by regex pattern, presence of domain mx-records, and real existence of email account on a current email server. ## Installation Add this line to your application's Gemfile: ```ruby gem 'truemail' ``` And then execute: $ bundle Or install it yourself as: $ gem install truemail ## Email Validation Methods Email validation is a tricky thing to do properly. There are a number of different ways to validate an email address. All checking mechanisms conform to best practices, and provide confident validation. **Syntax Checking**: This checks the email addresses via regex pattern. **Mail Server Existence Check**: This checks the availability of the email address domain using DNS MX records. **Mail Existence Check**: This checks if the email address really exists and can receive email via SMTP connections and email-sending emulation techniques. ## Usage ### Configuration features #### Set configuration To have access for Truemail.configuration and gem features you must configure it first. Just do it with block like in example below. ```ruby Truemail.configure do |config| # Required parameter. Should be an existing email on behalf of which verification will be performed config.verifier_email = 'verifier@example.com' # Optional parameter. Should be an existing domain on behalf of which verification will be performed. # By default verifier domain based on verifier email config.verifier_domain = 'somedomain.com' # Optional parameter. You can override default regex pattern config.email_pattern = /regex_pattern/ # Optional parameter. By default connection timeout is equal to 2 ms config.connection_timeout = 1 # Optional parameter. By default smtp response timeout is equal to 2 ms config.response_timeout = 1 # Optional parameter. You can to predefined which validation use for some domains # Available validation types: :regex, :mx, :smtp # This configuration will be used over current or default validation type parameter # All of validations for 'somedomain.com' will be processed with mx validation only config.validation_type_for = { 'somedomain.com' => :mx } end ``` #### Read configuration After successful configuration you can read current Truemail configuration instance anywhere in your application. ```ruby Truemail.configuration => # ``` #### Update configuration ```ruby Truemail.configuration.connection_timeout = 3 => 3 Truemail.configuration.response_timeout = 4 => 4 Truemail.configuration => # ``` #### Reset configuration Also you can reset Truemail configuration. ```ruby Truemail.reset_configuration! => nil Truemail.configuration => nil ``` ### Validation features #### Regex validation Validation with regex pattern is first validation level. You can redefine regex pattern in gem configuration. Examples of using: 1. With default regex pattern ```ruby Truemail.configure do |config| config.verifier_email = 'verifier@example.com' end Truemail.validate('email@example.com', with: :regex) => #, @validation_type=:regex> ``` 2. With custom regex pattern ```ruby Truemail.configure do |config| config.verifier_email = 'verifier@example.com' config.config.email_pattern = /regex_pattern/ end Truemail.validate('email@example.com', with: :regex) => #, @validation_type=:regex> ``` #### MX validation Validation by MX records is second validation level. It use Regex validation before run. When regex validation has completed successfully then starts itself. Example of using: ```ruby Truemail.configure do |config| config.verifier_email = 'verifier@example.com' end Truemail.validate('email@example.com', with: :mx) => #, @validation_type=:mx> ``` #### SMTP validation SMTP validation is a final, third validation level. It try to check real existence of email account on a current email server. This validation runs chain of previous validations, and if they complete successfully runs itself. ```code [Regex validation] -> [MX validation] -> [SMTP validation] ``` By default you don't need pass with-parameter to use it. Example of using: ```ruby Truemail.configure do |config| config.verifier_email = 'verifier@example.com' end Truemail.validate('email@example.com') # Successful SMTP validation => #, @validation_type=:smtp> # SMTP validation failed => #"smtp error"}, smtp_debug= [#, mailfrom=#, rcptto=false, errors={:rcptto=>"550 5.7.1 No such user!\n"}>>]>, @validation_type=:smtp> ``` ## ToDo 1. Gem compatibility with Ruby 2.3 2. Fail validations logger 3. The ability to use a proxy ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/rubygarage/truemail. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. ## License The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). ## Code of Conduct Everyone interacting in the Truemail project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/truemail/blob/master/CODE_OF_CONDUCT.md). --- RubyGarage Logo RubyGarage is a leading software development and consulting company in Eastern Europe. Our main expertise includes Ruby and Ruby on Rails, but we successfully employ other technologies to deliver the best results to our clients. [Check out our portfolio](https://rubygarage.org/portfolio) for even more exciting works!