developer:email:valid

Email::Valid(3) User Contributed Perl Documentation Email::Valid(3)

Email::Valid

     Email::Valid - Check validity of Internet email addresses
     perldoc Mail::Address
     yum install perl-Email-Valid  --enablerepo=epel
       use Email::Valid;
       print (Email::Valid->address('maurice@hevanet.com') ? 'yes' : 'no');
     This module determines whether an email address is well-formed, and
     optionally, whether a mail host exists for the domain.
     Please note that there is no way to determine whether an address is
     deliverable without attempting delivery (for details, see perlfaq 9).
     This module requires perl 5.004 or later and the Mail::Address module.
     Either the Net::DNS module or the nslookup utility is required for DNS
     checks.  The Net::Domain::TLD module is required to check the validity
     of top level domains.
       Every method which accepts an <ADDRESS> parameter may
       be passed either a string or an instance of the Mail::Address
       class.  All errors raise an exception.
         This method is used to construct an Email::Valid object.  It
         accepts an optional list of named parameters to control the
         behavior of the object at instantiation.
         The following named parameters are allowed.  See the individual
         methods below of details.
  1. mxcheck
  2. tldcheck
  3. fudge
  4. fqdn
  5. local_rules
         This method accepts an email address or domain name and determines
         whether a DNS record (A or MX) exists for it.
         The method returns true if a record is found and undef if not.
         Either the Net::DNS module or the nslookup utility is required for
         DNS checks.  Using Net::DNS is the preferred method since error
         handling is improved.  If Net::DNS is available, you can modify the
         behavior of the resolver (e.g. change the default tcp_timeout
         value) by manipulating the global Net::DNS::Resolver instance
         stored in $Email::Valid::Resolver.
         This method determines whether the domain part of an address is in
         a recognized top-level domain.
         This method determines whether an address conforms to the RFC822
         specification (except for nested comments).  It returns true if it
         conforms and undef if not.
         Specifies whether calls to address() should attempt to correct
         common addressing errors.  Currently, this results in the removal
         of spaces in AOL addresses, and the conversion of commas to periods
         in Compuserve addresses.  The default is false.
         Species whether addresses passed to address() must contain a fully
         qualified domain name (FQDN).  The default is true.
         Specifies whether addresses passed to address() should be tested
         for domain specific restrictions.  Currently, this is limited to
         certain AOL restrictions that I’m aware of.  The default is false.
         Specifies whether addresses passed to address() should be checked
         for a valid DNS entry.  The default is false.
         Specifies whether addresses passed to address() should be checked
         for a valid top level domains.  The default is false.
         This is the primary method which determines whether an email
         address is valid.  It’s behavior is modified by the values of
         mxcheck(), tldcheck(), local_rules(), fqdn(), and fudge().  If the
         address passes all checks, the (possibly modified) address is
         returned as a string.  Otherwise, the undefined value is returned.
         In a list context, the method also returns an instance of the
         Mail::Address class representing the email address.
         If the last call to address() returned undef, you can call this
         method to determine why it failed.  Possible values are:
          rfc822
          local_rules
          fqdn
          mxcheck
          tldcheck
         If the class is not instantiated, you can get the same information
         from the global $Email::Valid::Details.
     Let’s see if the address ’maurice@hevanet.com’ conforms to the RFC822
     specification:
       print (Email::Valid->address('maurice@hevanet.com') ? 'yes' : 'no');
     Additionally, let’s make sure there’s a mail host for it:
       print (Email::Valid->address( -address => 'maurice@hevanet.com',
                                     -mxcheck => 1 ) ? 'yes' : 'no');
     Let’s see an example of how the address may be modified:
       $addr = Email::Valid->address('Alfred Neuman <Neuman @ foo.bar>');
       print "$addr\n"; # prints Neuman@foo.bar
     Now let’s add the check for top level domains:
       $addr = Email::Valid->address( -address => 'Neuman@foo.bar',
                                      -tldcheck => 1 );
       print "$addr\n"; # doesn't print anything
     Need to determine why an address failed?
       unless(Email::Valid->address('maurice@hevanet')) {
         print "address failed $Email::Valid::Details check.\n";
       }
     If an error is encountered, an exception is raised.  This is really
     only possible when performing DNS queries.  Trap any exceptions by
     wrapping the call in an eval block:
       eval {
         $addr = Email::Valid->address( -address => 'maurice@hevanet.com',
                                        -mxcheck => 1 );
       };
       warn "an error was encountered: $@" if $@;
     Email::Valid should work with Perl for Win32.  In my experience,
     however, Net::DNS queries seem to take an extremely long time when a
     record cannot be found.
     Copyright 1998-2003, Maurice Aubrey <maurice@hevanet.com>.  All rights
     reserved.
     This module is free software; you may redistribute it and/or modify it
     under the same terms as Perl itself.
     Significant portions of this module are based on the ckaddr program
     written by Tom Christiansen and the RFC822 address pattern developed by
     Jeffrey Friedl.  Neither were involved in the construction of this
     module; all errors are mine.
     Thanks very much to the following people for their suggestions and bug
     fixes:
       Otis Gospodnetic <otis@DOMINIS.com>
       Kim Ryan <kimaryan@ozemail.com.au>
       Pete Ehlke <pde@listserv.music.sony.com>
       Lupe Christoph
       David Birnbaum
       Achim
       Elizabeth Mattijsen (liz@dijkmat.nl)
     Mail::Address, Net::DNS, Net::Domain::TLD, perlfaq9

perl v5.10.1 2010-06-10 Email::Valid(3)

  • developer/email/valid.txt
  • Last modified: 2016/03/20 11:36
  • by Jim