is_email 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 57746b49f1766781b186aa9ab5c3fd6be76c21df3e5b9555dc76e12460602bf6
+  data.tar.gz: 0a7deddacae4136f0f854a5f7045852ee9c38ab0f3cd32ce416ed62bc8bd83c0
+SHA512:
+  metadata.gz: 032d3f9a9cccad36d5506b93f6aabc8c1cc316869a4c079b9f272b2f666bf6fd8bd516ad95386d7c7b03fd09f6d2b7476f69ab15f58a660df86fba6a5d3fb02f
+  data.tar.gz: b153e65860a93daf83bcd468ce0f33c0cf3d7407f1136f491edddea17d34fbd55bee8e1629a0bbb8a1c68b624ca2813b026dfac140493d46c3502adaa22a6aa0

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.1](https://github.com/michaelherold/is_email/tree/0.1.1) - 2023-06-18
+
+- Add support for parsing email addresses according to the relevant RFCs and outputting either a boolean or a diagnosis. This is and will continue to be the default behavior of `IsEmail.email?`.
+
+## 0.1.0
+
+- An initial push that wasn't vetted thoroughly enough and missed updating the changelog with the release date. Otherwise, this was identical to 0.1.1.

data/CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contributing
+
+In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), we encourage **everyone** to help improve this project. Here are some ways _you_ can contribute:
+
+* Use alpha, beta, and pre-release versions.
+* Report bugs.
+* Suggest new features.
+* Write or edit documentation.
+* Write specifications.
+* Write code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace).
+* Refactor code.
+* Fix [issues].
+* Review patches.
+
+[issues]: https://github.com/michaelherold/is_email/issues
+
+## Submitting an Issue
+
+We use the [GitHub issue tracker][issues] to track bugs and features. Before submitting a bug report or feature request, check to make sure no one has already submitted it.
+
+When submitting a bug report, please include a `<details>` block that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system. This looks like the following:
+
+```markdown
+<details>
+<summary>A description of the details block</summary>
+
+All of the content that you want in here, perhaps with code fences. Note that
+if you only have a code fence in here, you _must_ separate it from the <summary>
+tag and the closing </details> or it won't render correctly.
+
+Notice the empty line here ↓
+
+</details>
+```
+
+Ideally, a bug report should include a pull request with failing specs.
+
+## Submitting a Pull Request
+
+1. Fork the repository.
+2. Create a topic branch.
+3. Add specs for your unimplemented feature or bug fix.
+4. Run `bundle exec rake test`. If your specs pass, return to step 3.
+5. Implement your feature or bug fix.
+6. Run `bundle exec rake`. If your specs or any of the linters fail, return to step 5.
+7. Open `coverage/index.html`. If your changes are not fully covered by your tests, return to step 3.
+8. Add documentation for your feature or bug fix.
+9. Commit and push your changes.
+10. Submit a pull request.
+
+## Tools to Help You Succeed
+
+After checking out the repository, run `bin/setup` to install dependencies. Then, run `bundle exec rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+Before committing code, run `bundle exec rake` to check that the code conforms to the style guidelines of the project, that all of the tests are green (if you're writing a feature; if you're only submitting a failing test, then it does not have to pass!), and that you sufficiently documented the changes.

data/LICENSE.md

@@ -0,0 +1,21 @@
+# The MIT License (MIT)
+
+Copyright © 2023 Michael Herold
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# IsEmail
+
+IsEmail is a no-nonsense approach for checking whether that user-supplied email address could be real. Sick of not being able to use [email address tagging](http://en.wikipedia.org/wiki/Email_address#Address_tags) to sort through your [Bacn](https://en.wiktionary.org/wiki/bacn)? We can fix that.
+
+Regular expressions are cheap to write, but often require maintenance when new top-level domains come out or don't conform to email addressing features that come back into vogue. IsEmail allows you to validate an email address — and even check the domain, if you wish — with one simple call, making your code more readable and faster to write. When you want to know why an email address doesn't validate, we even provide you with a diagnosis.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add is_email
+
+If you are not using Bundler to manage dependencies, install the gem by executing:
+
+    $ gem install is_email
+
+## Usage
+
+For the simplest usage, import and use the `IsEmail.email?` module method:
+
+```ruby
+address = "test@example.com"
+bool_result = IsEmail.email?(address)
+detailed_result = IsEmail.email?(address, diagnose: true)
+```
+
+## Contributing
+
+So you're interested in contributing to IsEmail? Check out our [contributing guidelines](CONTRIBUTING.md) for more information on how to do that.
+
+## Supported Ruby Versions
+
+This library aims to support and is [tested against](https://github.com/michaelherold/is_email/actions) the following Ruby versions:
+
+* Ruby 3.0
+* Ruby 3.1
+* Ruby 3.2
+
+If something doesn't work on one of these versions, it's a bug.
+
+This library may inadvertently work (or seem to work) on other Ruby versions, however we will only provide support for the versions listed above.
+
+If you would like this library to support another Ruby version or implementation, you may volunteer to be a maintainer. Being a maintainer entails making sure all tests run and pass on that implementation. When something breaks on your implementation, you will be responsible for providing patches in a timely fashion. If critical issues for a particular implementation exist at the time of a major release, we may drop support for that Ruby version.
+
+## Versioning
+
+This library aims to adhere to [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.html). Report violations of this scheme should as bugs. Specifically, if a minor or patch version breaks backward compatibility, that version should be immediately yanked and/or a new version should be immediately released that restores compatibility. Only new major versions will introduce breaking changes to the public API. As a result of this policy, you can (and should) specify a dependency on this gem using the [pessimistic version constraint](http://guides.rubygems.org/patterns/#pessimistic-version-constraint) with two digits of precision. For example:
+
+    spec.add_dependency "is_email", "~> 0.1"
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+We expect everyone interacting in the IsEmail project's codebases, issue trackers, chat rooms and mailing lists to follow the [code of conduct](https://github.com/michaelherold/is_email/blob/main/CODE_OF_CONDUCT.md).
+
+## Acknowledgments
+
+I based the base `Validators::Parser` off [Dominic Sayers](https://github.com/dominicsayers)'s [is_email script](https://github.com/dominicsayers/isemail). I wanted the functionality in Python, so I ported it from the original PHP. I later ported it to Ruby since it's handy to have there too.

data/is_email.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "lib/is_email/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "is_email"
+  spec.version = IsEmail::VERSION
+  spec.authors = ["Michael Herold"]
+  spec.email = ["opensource@michaeljherold.com"]
+
+  spec.summary = "is_email is a no-nonsense approach for checking whether that user-supplied email address could be real. Sick of not being able to use email address tagging to sort through your Bacn? We can fix that."
+  spec.description = spec.summary
+  spec.homepage = "https://github.com/michaelherold/is_email"
+  spec.license = "MIT"
+
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.files = %w[CHANGELOG.md CONTRIBUTING.md LICENSE.md README.md]
+  spec.files += %w[is_email.gemspec]
+  spec.files += Dir["lib/**/*.rb"]
+  spec.require_paths = ["lib"]
+
+  spec.metadata = {
+    "bug_tracker_uri" => "https://github.com/michaelherold/is_email/issues",
+    "changelog_uri" => "https://github.com/michaelherold/is_email/blob/main/CHANGELOG.md",
+    "documentation_uri" => "https://rubydoc.info/gems/is_email/#{IsEmail::VERSION}",
+    "homepage_uri" => "https://github.com/michaelherold/is_email",
+    "rubygems_mfa_required" => "true",
+    "source_code_uri" => "https://github.com/michaelherold/is_email"
+  }
+end

data/lib/is_email/diagnosis/base.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module IsEmail
+  module Diagnosis
+    # An abstract superclass for all diagnoses
+    #
+    # @api private
+    class Base
+      include Comparable
+
+      DESCRIPTION = ""
+      ERROR_CODES = {}.freeze
+      MESSAGES = {}.freeze
+      REFERENCES = {}.freeze
+
+      # @param type [String]
+      # @return [void]
+      def initialize(type)
+        @code = self.class::ERROR_CODES.fetch(type)
+        @message = self.class::MESSAGES.fetch(type, "")
+        @references = self.class::REFERENCES.fetch(type) { [] }.map { |ref| Reference.new(ref) }
+        @type = type.to_s
+      end
+
+      # @return [Integer]
+      attr_reader :code
+
+      # @return [String]
+      attr_reader :message
+
+      # @return [Array<Reference>]
+      attr_reader :references
+
+      # @return [String]
+      attr_reader :type
+
+      # Part of the [value object semantics][1] to make diagnoses equalable
+      #
+      # [1]: https://thoughtbot.com/blog/value-object-semantics-in-ruby
+      #
+      # @param other [Object]
+      # @return [Boolean]
+      def ==(other)
+        other.instance_of?(self.class) && (self <=> other).zero?
+      end
+      alias_method :eql?, :==
+
+      # Allows sorting with Numerics and other diagnoses
+      #
+      # @param other [Object]
+      # @return [-1, 0, 1, nil]
+      def <=>(other)
+        case other
+        when Base
+          code <=> other.code
+        when Numeric
+          code <=> other
+        end
+      end
+
+      # Part of the [value object semantics][1] to make diagnoses equalable
+      #
+      # [1]: https://thoughtbot.com/blog/value-object-semantics-in-ruby
+      #
+      # @return [Integer]
+      def hash
+        [self.class, type].hash
+      end
+
+      # @return [String]
+      def inspect
+        "#<#{self.class.name}: #{type}>"
+      end
+    end
+  end
+end

data/lib/is_email/diagnosis/cfws.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module IsEmail
+  module Diagnosis
+    # Indicates an address has a Comment or Folding White Space
+    #
+    # @api private
+    class CFWS < Base
+      DESCRIPTION = "Address is valid within the message but cannot be used unmodified for the envelope."
+
+      ERROR_CODES = {
+        "COMMENT" => 17,
+        "FWS" => 18
+      }.freeze
+
+      MESSAGES = {
+        "COMMENT" => "Address contains messages",
+        "FWS" => "Address contains Folding White Space"
+      }.freeze
+
+      REFERENCES = {
+        "COMMENT" => ["dot-atom"],
+        "FWS" => ["local-part"]
+      }.freeze
+    end
+  end
+end

data/lib/is_email/diagnosis/deprecated.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module IsEmail
+  module Diagnosis
+    # Indicates an address has deprecated elements but may still be usable
+    #
+    # @api private
+    class Deprecated < Base
+      DESCRIPTION = "Address contains deprecated elements but may still be valid in restricted contexts."
+
+      ERROR_CODES = {
+        "LOCALPART" => 33,
+        "FWS" => 34,
+        "QTEXT" => 35,
+        "QP" => 36,
+        "COMMENT" => 37,
+        "CTEXT" => 38,
+        "CFWS_NEAR_AT" => 49
+      }.freeze
+
+      MESSAGES = {
+        "LOCALPART" => "Address contains a local part in deprecated form.",
+        "FWS" => "Address contains Folding White Space in deprecated form.",
+        "QTEXT" => "Address contains a quoted string in deprecated form.",
+        "QP" => "Address contains a quoted pair in deprecated form.",
+        "COMMENT" => "Address contains a comment in deprecated form.",
+        "CTEXT" => "Address contains a comment with a deprecated character.",
+        "CFWS_NEAR_AT" => "Address contains a comment or Folding White Space around the @ sign."
+      }.freeze
+
+      REFERENCES = {
+        "LOCALPART" => ["obs-local-part"],
+        "FWS" => ["obs-local-part", "obs-domain"],
+        "QTEXT" => ["obs-qtext"],
+        "QP" => ["obs-qp"],
+        "COMMENT" => ["obs-local-part", "obs-domain"],
+        "CTEXT" => ["obs-ctext"],
+        "CFWS_NEAR_AT" => ["CFWS-near-at", "SHOULD-NOT"]
+      }.freeze
+    end
+  end
+end

data/lib/is_email/diagnosis/invalid.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module IsEmail
+  module Diagnosis
+    # Indicates an address is invalid for any purpose
+    #
+    # @api private
+    class Invalid < Base
+      DESCRIPTION = "Address is invalid for any purpose"
+
+      ERROR_CODES = {
+        "EXPECTING_DTEXT" => 129,
+        "NOLOCALPART" => 130,
+        "NODOMAIN" => 131,
+        "CONSECUTIVEDOTS" => 132,
+        "ATEXT_AFTER_CFWS" => 133,
+        "ATEXT_AFTER_QS" => 134,
+        "ATEXT_AFTER_DOMLIT" => 135,
+        "EXPECTING_QPAIR" => 136,
+        "EXPECTING_ATEXT" => 137,
+        "EXPECTING_QTEXT" => 138,
+        "EXPECTING_CTEXT" => 139,
+        "BACKSLASHEND" => 140,
+        "DOT_START" => 141,
+        "DOT_END" => 142,
+        "DOMAINHYPHENSTART" => 143,
+        "DOMAINHYPHENEND" => 144,
+        "UNCLOSEDQUOTEDSTR" => 145,
+        "UNCLOSEDCOMMENT" => 146,
+        "UNCLOSEDDOMLIT" => 147,
+        "FWS_CRLF_X2" => 148,
+        "FWS_CRLF_END" => 149,
+        "CR_NO_LF" => 150,
+        "BAD_PARSE" => 151
+      }
+
+      MESSAGES = {
+        "EXPECTING_DTEXT" => "Address contains a character that is not allowed in a domain literal.",
+        "NOLOCALPART" => "Address has no local part.",
+        "NODOMAIN" => "Address has no domain part.",
+        "CONSECUTIVEDOTS" => "Address contains consecutive dots.",
+        "ATEXT_AFTER_CFWS" => "Address contains text after a comment or Folding White Space.",
+        "ATEXT_AFTER_QS" => "Address contains text after a quoted string.",
+        "ATEXT_AFTER_DOMLIT" => "Address contains extra characters after the domain literal.",
+        "EXPECTING_QPAIR" => "Address contains a character that is not allowed in a quoted pair.",
+        "EXPECTING_ATEXT" => "Address contains a character that is not allowed.",
+        "EXPECTING_QTEXT" => "Address contains a character that is not allowed in a quoted string.",
+        "EXPECTING_CTEXT" => "Address contains a character that is not allowed in a comment.",
+        "BACKSLASHEND" => "Address ends in a backslash.",
+        "DOT_START" => "Address has a local part or domain that begins with a dot.",
+        "DOT_END" => "Address has a local part or domain that ends with a dot.",
+        "DOMAINHYPHENSTART" => "Address has a local part or domain that begins with a hyphen.",
+        "DOMAINHYPHENEND" => "Address has a local part or domain that ends with a hyphen.",
+        "UNCLOSEDQUOTEDSTR" => "Address contains an unclosed quoted string.",
+        "UNCLOSEDCOMMENT" => "Address contains an unclosed comment.",
+        "UNCLOSEDDOMLIT" => "Address contains a domain literal that is missing its closing bracket.",
+        "FWS_CRLF_X2" => "Address contains a Folding White Space that has consecutive CRLF sequences.",
+        "FWS_CRLF_END" => "Address contains a Folding White Space that ends with a CRLF sequence.",
+        "CR_NO_LF" => "Address contains a carriage return that is not followed by a line return.",
+        "BAD_PARSE" => "Address is malformed."
+      }
+
+      REFERENCES = {
+        "EXPECTING_DTEXT" => ["dtext"],
+        "NOLOCALPART" => ["local-part"],
+        "NODOMAIN" => ["addr-spec", "mailbox"],
+        "CONSECUTIVEDOTS" => ["local-part", "domain-RFC5322", "domain-RFC5321"],
+        "ATEXT_AFTER_CFWS" => ["local-part", "domain-RFC5322"],
+        "ATEXT_AFTER_QS" => ["local-part"],
+        "ATEXT_AFTER_DOMLIT" => ["domain-RFC5322"],
+        "EXPECTING_QPAIR" => ["quoted-pair"],
+        "EXPECTING_ATEXT" => ["atext"],
+        "EXPECTING_QTEXT" => ["qtext"],
+        "EXPECTING_CTEXT" => ["ctext"],
+        "BACKSLASHEND" => ["domain-RFC5322", "domain-RFC5321", "quoted-pair"],
+        "DOT_START" => ["local-part", "domain-RFC5322", "domain-RFC5321"],
+        "DOT_END" => ["local-part", "domain-RFC5322", "domain-RFC5321"],
+        "DOMAINHYPHENSTART" => ["sub-domain"],
+        "DOMAINHYPHENEND" => ["sub-domain"],
+        "UNCLOSEDQUOTEDSTR" => ["quoted-string"],
+        "UNCLOSEDCOMMENT" => ["CFWS"],
+        "UNCLOSEDDOMLIT" => ["domain-literal"],
+        "FWS_CRLF_X2" => ["CFWS"],
+        "FWS_CRLF_END" => ["CFWS"],
+        "CR_NO_LF" => ["CFWS", "CRLF"],
+        "BAD_PARSE" => []
+      }
+    end
+  end
+end

data/lib/is_email/diagnosis/rfc5321.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module IsEmail
+  module Diagnosis
+    # Indicates an address is valid for SMTP but is unusual
+    #
+    # @api private
+    class RFC5321 < Base
+      DESCRIPTION = "Address is valid for SMTP but has unusual elements."
+
+      ERROR_CODES = {
+        "TLD" => 9,
+        "TLDNUMERIC" => 10,
+        "QUOTEDSTRING" => 11,
+        "ADDRESSLITERAL" => 12,
+        "IPV6DEPRECATED" => 13
+      }
+
+      MESSAGES = {
+        "TLD" => "Address is valid but at a Top Level Domain.",
+        "TLDNUMERIC" => "Address is valid but the Top Level Domain begins with a number.",
+        "QUOTEDSTRING" => "Address is valid but contains a quoted string.",
+        "ADDRESSLITERAL" => "Address is valid but at a literal address, not a domain.",
+        "IPV6DEPRECATED" => "Address is valid but contains a :: that only elides one zero group."
+      }
+
+      REFERENCES = {
+        "TLD" => ["TLD"],
+        "TLDNUMERIC" => ["TLD-format"],
+        "QUOTEDSTRING" => ["quoted-string"],
+        "ADDRESSLITERAL" => ["address-literal", "address-literal-IPv4"],
+        "IPV6DEPRECATED" => ["address-literal-IPv6"]
+      }
+    end
+  end
+end

data/lib/is_email/diagnosis/rfc5322.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module IsEmail
+  module Diagnosis
+    # Indicates an address is only loosely valid by RFC5322
+    #
+    # @api private
+    class RFC5322 < Base
+      DESCRIPTION = "Address is only valid according to the broad definition of RFC5322. It is otherwise invalid."
+
+      ERROR_CODES = {
+        "DOMAIN" => 65,
+        "TOOLONG" => 66,
+        "LOCAL_TOOLONG" => 67,
+        "DOMAIN_TOOLONG" => 68,
+        "LABEL_TOOLONG" => 69,
+        "DOMAINLITERAL" => 70,
+        "DOMLIT_OBSDTEXT" => 71,
+        "IPV6_GRPCOUNT" => 72,
+        "IPV6_2X2XCOLON" => 73,
+        "IPV6_BADCHAR" => 74,
+        "IPV6_MAXGRPS" => 75,
+        "IPV6_COLONSTRT" => 76,
+        "IPV6_COLONEND" => 77
+      }
+
+      MESSAGES = {
+        "DOMAIN" => "Address is RFC5322 compliant but contains domain characters that are not allowed by DNS.",
+        "TOOLONG" => "Address is too long.",
+        "LOCAL_TOOLONG" => "Address contains a local part that is too long.",
+        "DOMAIN_TOOLONG" => "Address contains a domain that is too long.",
+        "LABEL_TOOLONG" => "Address contains a domain part with an element that is too long.",
+        "DOMAINLITERAL" => "Address contains a domain literal that is not a valid RFC5321 address literal.",
+        "DOMLIT_OBSDTEXT" => "Address contains a domain literal that is not a valid RFC5321 address literal and contains obsolete characters.",
+        "IPV6_GRPCOUNT" => "Address contains an IPv6 literal address with the wrong number of groups.",
+        "IPV6_2X2XCOLON" => "Address contains an IPv6 literal address with too many :: sequences.",
+        "IPV6_BADCHAR" => "Address contains an IPv6 literal address with an illegal group of characters.",
+        "IPV6_MAXGRPS" => "Address contains an IPv6 literal address with too many groups.",
+        "IPV6_COLONSTRT" => "Address contains an IPv6 literal address that starts with a single colon.",
+        "IPV6_COLONEND" => "Address contains an IPv6 literal address that ends with a single colon."
+      }
+
+      REFERENCES = {
+        "DOMAIN" => ["domain-RFC5322"],
+        "TOOLONG" => ["mailbox-maximum"],
+        "LOCAL_TOOLONG" => ["local-part-maximum"],
+        "DOMAIN_TOOLONG" => ["domain-maximum"],
+        "LABEL_TOOLONG" => ["label"],
+        "DOMAINLITERAL" => ["domain-literal"],
+        "DOMLIT_OBSDTEXT" => ["obs-dtext"],
+        "IPV6_GRPCOUNT" => ["address-literal-IPv6"],
+        "IPV6_2X2XCOLON" => ["address-literal-IPv6"],
+        "IPV6_BADCHAR" => ["address-literal-IPv6"],
+        "IPV6_MAXGRPS" => ["address-literal-IPv6"],
+        "IPV6_COLONSTRT" => ["address-literal-IPv6"],
+        "IPV6_COLONEND" => ["address-literal-IPv6"]
+      }
+    end
+  end
+end

data/lib/is_email/diagnosis/valid.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module IsEmail
+  module Diagnosis
+    # Indicates an address is valid
+    #
+    # @api private
+    class Valid < Base
+      DESCRIPTION = "Address is valid."
+
+      ERROR_CODES = {"VALID" => 1}.freeze
+
+      MESSAGES = {
+        "VALID" =>
+        "Address is valid. Please note that this does not mean " \
+        "the address actually exists, nor even that the domain " \
+        "actually exists. This address could be issued by the " \
+        "domain owner without breaking the rules of any RFCs."
+      }.freeze
+
+      # @param type [String]
+      # @return [void]
+      def initialize(type = "VALID")
+        super
+      end
+    end
+  end
+end

data/lib/is_email/diagnosis.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module IsEmail
+  # Contains all types of diagnoses for address invalidity
+  module Diagnosis
+    require_relative "diagnosis/base"
+    require_relative "diagnosis/cfws"
+    require_relative "diagnosis/deprecated"
+    require_relative "diagnosis/invalid"
+    require_relative "diagnosis/rfc5321"
+    require_relative "diagnosis/rfc5322"
+    require_relative "diagnosis/valid"
+
+    CATEGORIES = {
+      "VALID" => 1,
+      "DNSWARN" => 7,
+      "RFC5321" => 15,
+      "THRESHOLD" => 16,
+      "CFWS" => 31,
+      "DEPREC" => 63,
+      "RFC5322" => 127,
+      "ERR" => 255
+    }.freeze
+  end
+end