doc,email-validator: document the new NULLMX handling

[email-validator.git] / email-validator.cabal

diff --git a/email-validator.cabal b/email-validator.cabal
index c899d8c044253d5ef856bf519281a5fa5dbf9500..3e975f393b92cdbfefb234883f2640d4cf97de25 100644 (file)
--- a/email-validator.cabal
+++ b/email-validator.cabal
@@ -1,15 +1,16 @@
 cabal-version:  3.0
 name:           email-validator
 cabal-version:  3.0
 name:           email-validator

-version:        1.0.0
+version:        1.0.1

 author:         Michael Orlitzky
 maintainer:    Michael Orlitzky <michael@orlitzky.com>
 author:         Michael Orlitzky
 maintainer:    Michael Orlitzky <michael@orlitzky.com>

-homepage:       http://michael.orlitzky.com/code/email-validator.xhtml
+homepage:       https://michael.orlitzky.com/code/email-validator.xhtml

 bug-reports:    mailto:michael@orlitzky.com
 category:       Utils
 bug-reports:    mailto:michael@orlitzky.com
 category:       Utils

-license:        AGPL-3.0-only
+license:        AGPL-3.0-or-later

 license-file:   doc/LICENSE
 build-type:     Simple
 extra-source-files:
 license-file:   doc/LICENSE
 build-type:     Simple
 extra-source-files:

+  doc/COPYING

   doc/man1/email-validator.1
 synopsis:
   Perform basic syntax and deliverability checks on email addresses.
   doc/man1/email-validator.1
 synopsis:
   Perform basic syntax and deliverability checks on email addresses.


@@ -22,10 +23,13 @@ description:
     * A syntax check using a regular expression, or the full RFC 5322
       grammar (see the @--rfc5322@ option).
 
     * A syntax check using a regular expression, or the full RFC 5322
       grammar (see the @--rfc5322@ option).
 

-    * Confirmation of the existence of an @MX@ record for the domain part of
-      the address. This is not required; in fact many domains accept mail
-      via an @A@ record for e.g. example.com which is used in lieu of an @MX@
-      record. This behavior can be controlled via the @--accept-a@ flag.
+    * Confirmation of the existence of an @MX@ record for the domain
+      part of the address. NULLMX (RFC7505) records are not
+      accepted. This is not required; in fact many domains accept mail
+      via an @A@ record for (say) example.com which is used in lieu of
+      an @MX@ record. This behavior can be controlled via the
+      @--accept-a@ flag, but note that @--accept-a@ is ignored for
+      domains that have NULLMX records.

 
   These checks are performed in parallel using the number of available
   threads. To increase the number of threads, you can pass the
 
   These checks are performed in parallel using the number of available
   threads. To increase the number of threads, you can pass the


@@ -110,5 +114,5 @@ test-suite doctests
 
 source-repository head
   type: git
 
 source-repository head
   type: git

-  location: http://gitweb.michael.orlitzky.com/email-validator.git
+  location: https://gitweb.michael.orlitzky.com/email-validator.git

   branch: master
   branch: master