README.md in truemail-1.4.2 vs README.md in truemail-1.5.0

- old
+ new

@@ -1,10 +1,10 @@ -# <img src='https://repository-images.githubusercontent.com/173723932/6dffee00-e88e-11e9-94b6-c97aacc0df00' height='250' alt='Truemail - configurable plain Ruby email validator' /> +# <img src='https://repository-images.githubusercontent.com/173723932/6dffee00-e88e-11e9-94b6-c97aacc0df00' height='250' alt='Truemail - configurable framework agnostic plain Ruby email validator' /> [![Maintainability](https://api.codeclimate.com/v1/badges/657aa241399927dcd2e2/maintainability)](https://codeclimate.com/github/rubygarage/truemail/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/657aa241399927dcd2e2/test_coverage)](https://codeclimate.com/github/rubygarage/truemail/test_coverage) [![CircleCI](https://circleci.com/gh/rubygarage/truemail/tree/master.svg?style=svg)](https://circleci.com/gh/rubygarage/truemail/tree/master) [![Gem Version](https://badge.fury.io/rb/truemail.svg)](https://badge.fury.io/rb/truemail) [![Downloads](https://img.shields.io/gem/dt/truemail.svg?colorA=004d99&colorB=0073e6)](https://rubygems.org/gems/truemail) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md) -The Truemail gem helps you validate emails via regex pattern, presence of DNS records, and real existence of email account on a current email server. Also Truemail gem allows performing an audit of the host in which runs. +Configurable framework agnostic plain Ruby email validator. Verify email via Regex, DNS and SMTP. Be sure that email address valid and exists. ## Table of Contents - [Synopsis](#synopsis) - [Features](#features) @@ -15,11 +15,11 @@ - [Read global configuration](#read-global-configuration) - [Update global configuration](#update-global-configuration) - [Reset global configuration](#reset-global-configuration) - [Using custom independent configuration](#using-custom-independent-configuration) - [Validation features](#validation-features) - - [Whitelist/Blacklist check](#whitelist-blacklist-check) + - [Whitelist/Blacklist check](#whitelistblacklist-check) - [Whitelist case](#whitelist-case) - [Whitelist validation case](#whitelist-validation-case) - [Blacklist case](#blacklist-case) - [Duplication case](#duplication-case) - [Regex validation](#regex-validation) @@ -39,27 +39,31 @@ - [Test environment](#test-environment) - [Truemail family](#truemail-family) - [Contributing](#contributing) - [License](#license) - [Code of Conduct](#code-of-conduct) +- [Credits](#credits) - [Versioning](#versioning) - [Changelog](CHANGELOG.md) ## Synopsis -Email validation is a tricky thing. There are a number of different ways to validate an email address and all mechanisms must conform with the best practices and provide proper validation. You can get more information about email validation techniques in our [blog](https://rubygarage.org/blog/how-to-validate-emails). +Email validation is a tricky thing. There are a number of different ways to validate an email address and all mechanisms must conform with the best practices and provide proper validation. You can get more information about email validation techniques in our [blog](https://rubygarage.org/blog/how-to-validate-emails). The Truemail gem helps you validate emails via regex pattern, presence of DNS records, and real existence of email account on a current email server. **Syntax Checking**: Checks the email addresses via regex pattern. **Mail Server Existence Check**: Checks the availability of the email address domain using DNS records. **Mail Existence Check**: Checks if the email address really exists and can receive email via SMTP connections and email-sending emulation techniques. +Also Truemail gem allows performing an audit of the host in which runs. + ## Features - Configurable validator, validate only what you need -- Zero runtime dependencies +- Minimal runtime dependencies +- Supporting of internationalized emails (EAI) - Whitelist/blacklist validation layers - Simple SMTP debugger - Event logger - JSON serializer @@ -99,11 +103,10 @@ - blacklisted domains - SMTP safe check - event logger - JSON serializer - #### Setting global configuration To have an access for ```Truemail.configuration``` and gem configuration features, you must configure it first as in the example below: ```ruby @@ -299,11 +302,11 @@ configuration=#<Truemail::Configuration:0x00005629f801bd28 @blacklisted_domains=["black-domain.com", "somedomain.com"], @connection_attempts=2, @connection_timeout=2, @default_validation_type=:smtp, - @email_pattern=/(?=\A.{6,255}\z)(\A([a-zA-Z0-9]+[\w|\-|\.|\+]*)@((?i-mx:[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,63}))\z)/, + @email_pattern=/(?=\A.{6,255}\z)(\A([\p{L}0-9]+[\w|\-|\.|\+]*)@((?i-mx:[\p{L}0-9]+([\-\.]{1}[\p{L}0-9]+)*\.[\p{L}]{2,63}))\z)/, @response_timeout=2, @smtp_error_body_pattern=/(?=.*550)(?=.*(user|account|customer|mailbox)).*/i, @smtp_safe_check=false, @validation_type_by_domain={"somedomain.com"=>:mx}, @verifier_domain="example.com", @@ -345,11 +348,11 @@ #<Truemail::Configuration:0x0000563f0d2605c8 @blacklisted_domains=[], @connection_attempts=2, @connection_timeout=2, @default_validation_type=:smtp, - @email_pattern=/(?=\A.{6,255}\z)(\A([a-zA-Z0-9]+[\w|\-|\.|\+]*)@((?i-mx:[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,63}))\z)/, + @email_pattern=/(?=\A.{6,255}\z)(\A([\p{L}0-9]+[\w|\-|\.|\+]*)@((?i-mx:[\p{L}0-9]+([\-\.]{1}[\p{L}0-9]+)*\.[\p{L}]{2,63}))\z)/, @response_timeout=2, @smtp_error_body_pattern=/(?=.*550)(?=.*(user|account|customer|mailbox)).*/i, @smtp_safe_check=false, @validation_type_by_domain={}, @verifier_domain="example.com", @@ -376,11 +379,11 @@ #<Truemail::Configuration:0x0000563f0cd82ab0 @blacklisted_domains=[], @connection_attempts=2, @connection_timeout=2, @default_validation_type=:smtp, - @email_pattern=/(?=\A.{6,255}\z)(\A([a-zA-Z0-9]+[\w|\-|\.|\+]*)@((?i-mx:[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,63}))\z)/, + @email_pattern=/(?=\A.{6,255}\z)(\A([\p{L}0-9]+[\w|\-|\.|\+]*)@((?i-mx:[\p{L}0-9]+([\-\.]{1}[\p{L}0-9]+)*\.[\p{L}]{2,63}))\z)/, @response_timeout=2, @smtp_error_body_pattern=/(?=.*550)(?=.*(user|account|customer|mailbox)).*/i, @smtp_safe_check=false, @validation_type_by_domain={}, @verifier_domain="example.com", @@ -409,11 +412,11 @@ #<Truemail::Configuration:0x0000563f0d36f4f0 @blacklisted_domains=[], @connection_attempts=2, @connection_timeout=2, @default_validation_type=:smtp, - @email_pattern=/(?=\A.{6,255}\z)(\A([a-zA-Z0-9]+[\w|\-|\.|\+]*)@((?i-mx:[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,63}))\z)/, + @email_pattern=/(?=\A.{6,255}\z)(\A([\p{L}0-9]+[\w|\-|\.|\+]*)@((?i-mx:[\p{L}0-9]+([\-\.]{1}[\p{L}0-9]+)*\.[\p{L}]{2,63}))\z)/, @response_timeout=2, @smtp_error_body_pattern=/(?=.*550)(?=.*(user|account|customer|mailbox)).*/i, @smtp_safe_check=false, @validation_type_by_domain={}, @verifier_domain="example.com", @@ -442,11 +445,11 @@ #<Truemail::Configuration:0x0000563f0d3f8fc0 @blacklisted_domains=[], @connection_attempts=2, @connection_timeout=2, @default_validation_type=:smtp, - @email_pattern=/(?=\A.{6,255}\z)(\A([a-zA-Z0-9]+[\w|\-|\.|\+]*)@((?i-mx:[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,63}))\z)/, + @email_pattern=/(?=\A.{6,255}\z)(\A([\p{L}0-9]+[\w|\-|\.|\+]*)@((?i-mx:[\p{L}0-9]+([\-\.]{1}[\p{L}0-9]+)*\.[\p{L}]{2,63}))\z)/, @response_timeout=2, @smtp_error_body_pattern=/(?=.*550)(?=.*(user|account|customer|mailbox)).*/i, @smtp_safe_check=false, @validation_type_by_domain={}, @verifier_domain="example.com", @@ -491,11 +494,11 @@ #<Truemail::Configuration:0x000055aa56a54d48 @blacklisted_domains=[], @connection_attempts=2, @connection_timeout=2, @default_validation_type=:smtp, - @email_pattern=/(?=\A.{6,255}\z)(\A([a-zA-Z0-9]+[\w|\-|\.|\+]*)@((?i-mx:[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,63}))\z)/, + @email_pattern=/(?=\A.{6,255}\z)(\A([\p{L}0-9]+[\w|\-|\.|\+]*)@((?i-mx:[\p{L}0-9]+([\-\.]{1}[\p{L}0-9]+)*\.[\p{L}]{2,63}))\z)/, @response_timeout=2, @smtp_error_body_pattern=/(?=.*550)(?=.*(user|account|customer|mailbox)).*/i, @smtp_safe_check=false, @validation_type_by_domain={}, @verifier_domain="example.com", @@ -580,11 +583,11 @@ #<Truemail::Configuration:0x0000559b6e44af70 @blacklisted_domains=[], @connection_attempts=2, @connection_timeout=2, @default_validation_type=:smtp, - @email_pattern=/(?=\A.{6,255}\z)(\A([a-zA-Z0-9]+[\w|\-|\.|\+]*)@((?i-mx:[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,63}))\z)/, + @email_pattern=/(?=\A.{6,255}\z)(\A([\p{L}0-9]+[\w|\-|\.|\+]*)@((?i-mx:[\p{L}0-9]+([\-\.]{1}[\p{L}0-9]+)*\.[\p{L}]{2,63}))\z)/, @response_timeout=2, @smtp_error_body_pattern=/(?=.*550)(?=.*(user|account|customer|mailbox)).*/i, @smtp_safe_check=false, @validation_type_by_domain={}, @verifier_domain="example.com", @@ -633,11 +636,11 @@ #<Truemail::Configuration:0x00005615e87b9298 @blacklisted_domains=[], @connection_attempts=2, @connection_timeout=2, @default_validation_type=:smtp, - @email_pattern=/(?=\A.{6,255}\z)(\A([a-zA-Z0-9]+[\w|\-|\.|\+]*)@((?i-mx:[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,63}))\z)/, + @email_pattern=/(?=\A.{6,255}\z)(\A([\p{L}0-9]+[\w|\-|\.|\+]*)@((?i-mx:[\p{L}0-9]+([\-\.]{1}[\p{L}0-9]+)*\.[\p{L}]{2,63}))\z)/, @response_timeout=2, @smtp_error_body_pattern=/(?=.*550)(?=.*(user|account|customer|mailbox)).*/i, @smtp_safe_check=false, @validation_type_by_domain={}, @verifier_domain="example.com", @@ -684,11 +687,11 @@ #<Truemail::Configuration:0x00005615e87b9298 @blacklisted_domains=[], @connection_attempts=2, @connection_timeout=2, @default_validation_type=:smtp, - @email_pattern=/(?=\A.{6,255}\z)(\A([a-zA-Z0-9]+[\w|\-|\.|\+]*)@((?i-mx:[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,63}))\z)/, + @email_pattern=/(?=\A.{6,255}\z)(\A([\p{L}0-9]+[\w|\-|\.|\+]*)@((?i-mx:[\p{L}0-9]+([\-\.]{1}[\p{L}0-9]+)*\.[\p{L}]{2,63}))\z)/, @response_timeout=2, @smtp_error_body_pattern=/(?=.*550)(?=.*(user|account|customer|mailbox)).*/i, @smtp_safe_check=false, @validation_type_by_domain={}, @verifier_domain="example.com", @@ -748,11 +751,11 @@ #<Truemail::Configuration:0x00005615e87b9298 @blacklisted_domains=[], @connection_attempts=2, @connection_timeout=2, @default_validation_type=:smtp, - @email_pattern=/(?=\A.{6,255}\z)(\A([a-zA-Z0-9]+[\w|\-|\.|\+]*)@((?i-mx:[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,63}))\z)/, + @email_pattern=/(?=\A.{6,255}\z)(\A([\p{L}0-9]+[\w|\-|\.|\+]*)@((?i-mx:[\p{L}0-9]+([\-\.]{1}[\p{L}0-9]+)*\.[\p{L}]{2,63}))\z)/, @response_timeout=2, @smtp_error_body_pattern=/(?=.*550)(?=.*(user|account|customer|mailbox)).*/i, @smtp_safe_check=false, @validation_type_by_domain={}, @verifier_domain="example.com", @@ -796,11 +799,11 @@ #<Truemail::Configuration:0x00005615e87b9298 @blacklisted_domains=[], @connection_attempts=2, @connection_timeout=2, @default_validation_type=:smtp, - @email_pattern=/(?=\A.{6,255}\z)(\A([a-zA-Z0-9]+[\w|\-|\.|\+]*)@((?i-mx:[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,63}))\z)/, + @email_pattern=/(?=\A.{6,255}\z)(\A([\p{L}0-9]+[\w|\-|\.|\+]*)@((?i-mx:[\p{L}0-9]+([\-\.]{1}[\p{L}0-9]+)*\.[\p{L}]{2,63}))\z)/, @response_timeout=2, @smtp_error_body_pattern=/(?=.*550)(?=.*(user|account|customer|mailbox)).*/i, @smtp_safe_check=false, @validation_type_by_domain={}, @verifier_domain="example.com", @@ -885,11 +888,11 @@ #<Truemail::Configuration:0x00005615e86327a8 @blacklisted_domains=[], @connection_attempts=2, @connection_timeout=2, @default_validation_type=:smtp, - @email_pattern=/(?=\A.{6,255}\z)(\A([a-zA-Z0-9]+[\w|\-|\.|\+]*)@((?i-mx:[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,63}))\z)/, + @email_pattern=/(?=\A.{6,255}\z)(\A([\p{L}0-9]+[\w|\-|\.|\+]*)@((?i-mx:[\p{L}0-9]+([\-\.]{1}[\p{L}0-9]+)*\.[\p{L}]{2,63}))\z)/, @response_timeout=2, @smtp_error_body_pattern=/(?=.*550)(?=.*(user|account|customer|mailbox)).*/i, @smtp_safe_check=false, @validation_type_by_domain={}, @verifier_domain="example.com", @@ -907,11 +910,11 @@ #<Truemail::Configuration:0x00005615e86327a8 @blacklisted_domains=[], @connection_attempts=2, @connection_timeout=2, @default_validation_type=:smtp, - @email_pattern=/(?=\A.{6,255}\z)(\A([a-zA-Z0-9]+[\w|\-|\.|\+]*)@((?i-mx:[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,63}))\z)/, + @email_pattern=/(?=\A.{6,255}\z)(\A([\p{L}0-9]+[\w|\-|\.|\+]*)@((?i-mx:[\p{L}0-9]+([\-\.]{1}[\p{L}0-9]+)*\.[\p{L}]{2,63}))\z)/, @response_timeout=2, @smtp_error_body_pattern=/(?=.*550)(?=.*(user|account|customer|mailbox)).*/i, @smtp_safe_check=false, @validation_type_by_domain={}, @verifier_domain="example.com", @@ -966,9 +969,14 @@ 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](CODE_OF_CONDUCT.md). + +## Credits + +- [The Contributors](https://github.com/rubygarage/truemail/graphs/contributors) for code and awesome suggestions +- [The Stargazers](https://github.com/rubygarage/truemail/stargazers) for showing their support ## Versioning Truemail uses [Semantic Versioning 2.0.0](https://semver.org)