Add syntax checking for mail addresses.

[mail/checkmail.git] / checkmail.pl

diff --git a/checkmail.pl b/checkmail.pl
index 7ded360..c8f9e91 100644 (file)
--- a/checkmail.pl
+++ b/checkmail.pl
@@ -1,6 +1,6 @@
 #! /usr/bin/perl -W
 #
 #! /usr/bin/perl -W
 #

-# checkmail Version 0.3 by Thomas Hochstein
+# checkmail Version 0.5 by Thomas Hochstein

 #
 # This script tries to verify the deliverability of (a) mail address(es).
 # 
 #
 # This script tries to verify the deliverability of (a) mail address(es).
 # 


@@ -9,7 +9,7 @@
 # It can be redistributed and/or modified under the same terms under 
 # which Perl itself is published.
 
 # It can be redistributed and/or modified under the same terms under 
 # which Perl itself is published.
 

-our $VERSION = "0.3";
+our $VERSION = "0.5";

 
 ################################# Configuration ################################
 # Please fill in a working configuration!
 
 ################################# Configuration ################################
 # Please fill in a working configuration!


@@ -35,7 +35,7 @@ my $myself = basename($0);
 
 # read commandline options
 my %options;
 
 # read commandline options
 my %options;

-getopts('Vhqlrf:m:', \%options);
+getopts('Vhqlrf:m:s:e:', \%options);

 
 # -V: display version
 if ($options{'V'}) {
 
 # -V: display version
 if ($options{'V'}) {


@@ -52,18 +52,24 @@ if ($options{'h'}) {
 
 # display usage information if neither -f nor an address are present
 if (!$options{'f'} and !$ARGV[0]) {
 
 # display usage information if neither -f nor an address are present
 if (!$options{'f'} and !$ARGV[0]) {

-  print "Usage: $myself [-hqlr] [-m <host>] <address>|-f <file>\n";
+  print "Usage: $myself [-hqlr] [-m <host>] [-s <from>] [-e <EHLO>] <address>|-f <file>\n";

   print "Options: -V  display copyright and version\n";
   print "         -h  show documentation\n";
   print "         -q  quiet (no output, just exit with 0/1/2/3)\n";
   print "         -l  extended logging\n";
   print "         -r  test random address to verify verification\n";
   print "  -m <host>  no DNS lookup, just test this host\n";
   print "Options: -V  display copyright and version\n";
   print "         -h  show documentation\n";
   print "         -q  quiet (no output, just exit with 0/1/2/3)\n";
   print "         -l  extended logging\n";
   print "         -r  test random address to verify verification\n";
   print "  -m <host>  no DNS lookup, just test this host\n";

+  print "  -s <from>  override configured value for MAIL FROM\n";
+  print "  -e <EHLO>  override configured value for EHLO\n";

   print "  <address>  mail address to check\n\n";
   print "  -f <file>  parse file (one address per line)\n";
   exit(100);
 };
 
   print "  <address>  mail address to check\n\n";
   print "  -f <file>  parse file (one address per line)\n";
   exit(100);
 };
 

+# -s / -e: override configuration
+$config{'from'} = $options{'s'} if $options{'s'};
+$config{'helo'} = $options{'e'} if $options{'e'};
+

 # -f: open file and read addresses to @adresses
 my @addresses;
 if ($options{'f'}) {
 # -f: open file and read addresses to @adresses
 my @addresses;
 if ($options{'f'}) {


@@ -86,28 +92,35 @@ if ($options{'f'}) {
 my (%targets,$curstat,$status,$log,$message);
 foreach (@addresses) {
   my $address = $_;
 my (%targets,$curstat,$status,$log,$message);
 foreach (@addresses) {
   my $address = $_;

-  my $domain = Mail::Address->new('',$address)->host;
-  printf("  * Testing %s ...\n",$address) if !($options{'q'});
-  $log .=  "\n===== BEGIN $address =====\n";
-  # get list of target hosts or take host forced via -m
-  if (!$options{'m'}) {
-         %targets = %{gettargets($domain,\$log)};
-  } else {
-    $message = sprintf("Connection to %s forced by -m.\n",$options{'m'});
-    $log .= $message;
-    print "    $message" if !($options{'q'});
-    # just one target host with preference 0
-    $targets{$options{'m'}} = 0;
-  };
-  if (%targets) {
-    $curstat = checkaddress($address,\%targets,\$log);
-  } else {
+  # regexp taken from http://www.regular-expressions.info/email.html
+  # and escaping of "/" added two times
+  if ($address !~ /^(?:[a-z0-9!#$%&'*+\/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+\/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$/i) {
+    printf("  > Address <%s> is syntactically INVALID.\n",$address) if !($options{'q'});

     $curstat = 2;
     $curstat = 2;

-    $message = 'DNS lookup failure';
-    printf("  > Address is INVALID (%s).\n",$message) if !($options{'q'});
-    $log .= $message . '.';
+  } else {
+    my $domain = Mail::Address->new('',$address)->host;
+    printf("  * Testing %s ...\n",$address) if !($options{'q'});
+    $log .=  "\n===== BEGIN $address =====\n";
+    # get list of target hosts or take host forced via -m
+    if (!$options{'m'}) {
+           %targets = %{gettargets($domain,\$log)};
+    } else {
+      $message = sprintf("Connection to %s forced by -m.\n",$options{'m'});
+      $log .= $message;
+      print "    $message" if !($options{'q'});
+      # just one target host with preference 0
+      $targets{$options{'m'}} = 0;
+    };
+    if (%targets) {
+      $curstat = checkaddress($address,\%targets,\$log);
+    } else {
+      $curstat = 2;
+      $message = 'DNS lookup failure';
+      printf("  > Address is INVALID (%s).\n",$message) if !($options{'q'});
+      $log .= $message . '.';
+    };
+    $log   .=  "====== END $address ======\n";

   };
   };

-  $log   .=  "====== END $address ======\n";

   $status = $curstat if (!defined($status) or $curstat > $status);
 };
 
   $status = $curstat if (!defined($status) or $curstat > $status);
 };
 


@@ -369,7 +382,7 @@ checkmail - check deliverability of a mail address
 
 =head1 SYNOPSIS
 
 
 =head1 SYNOPSIS
 

-B<checkmail> [B<-Vhqlr>] [B<-m> I<host>] I<address>|B<-f> I<file>
+B<checkmail> [B<-Vhqlr>] [B<-m> I<host>]  [-s I<sender>] [-e I<EHLO>] I<address>|B<-f> I<file>

 
 =head1 REQUIREMENTS
 
 
 =head1 REQUIREMENTS
 


@@ -426,13 +439,17 @@ The sender address to be used for I<MAIL FROM> while testing.
 
 =back
 
 
 =back
 

+You may override that configuration by using the B<-e> and B<-s>
+command line options.
+

 =head2 Usage
 
 After configuring the script you may run your first test with
 
     checkmail user@example.org
 
 =head2 Usage
 
 After configuring the script you may run your first test with
 
     checkmail user@example.org
 

-B<checkmail> will try to determine the mail exchanger(s) (MX)
+B<checkmail> will check the address for syntactic validity. If the
+address is valid, it will try to determine the mail exchanger(s) (MX)

 responsible for I<example.org> by querying the DNS for the respective
 MX records and then try to connect via SMTP (on port 25) to each of
 them in order of precedence (if necessary). It will run through the
 responsible for I<example.org> by querying the DNS for the respective
 MX records and then try to connect via SMTP (on port 25) to each of
 them in order of precedence (if necessary). It will run through the


@@ -505,6 +522,9 @@ B<Please note:> You shouldn't try to validate addresses while working
 from a dial-up or blacklisted host. If in doubt, use the B<-l> option
 to have a closer look on the SMTP dialog yourself.
 
 from a dial-up or blacklisted host. If in doubt, use the B<-l> option
 to have a closer look on the SMTP dialog yourself.
 

+B<Please note:> To avoid shell expansion on addresses you submit to
+B<checkmail>, use B<batch processing>.
+

 =head1 OPTIONS
 
 =over 3
 =head1 OPTIONS
 
 =over 3


@@ -537,6 +557,14 @@ particular host irrespective of DNS entries. For example:
 
     checkmail -m test.host.example user@domain.example
 
 
     checkmail -m test.host.example user@domain.example
 

+=item B<-s> I<sender> (value for MAIL FROM)
+
+Override configuration and use I<sender> for MAIL FROM.
+
+=item B<-e> I<EHLO> (value for EHLO)
+
+Override configuration and use I<EHLO> for EHLO.
+

 =item B<-f> I<file> (file)
 
 Process all addresses from I<file> (one on each line).
 =item B<-f> I<file> (file)
 
 Process all addresses from I<file> (one on each line).