| Email::Valid(3pm) | User Contributed Perl Documentation | Email::Valid(3pm) |
Email::Valid - Check validity of Internet email addresses
version 1.203
use Email::Valid;
my $address = Email::Valid->address('maurice@hevanet.com');
print ($address ? '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 <http://perldoc.perl.org/perlfaq9.html#How-do-I-check-a-valid-mail-address>).
This library should run on perls released even a long time ago. It should work on any version of perl released in the last five years.
Although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. The version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl.
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.
The following named parameters are allowed. See the individual methods below for details.
-mxcheck
-tldcheck
-fudge
-fqdn
-allow_ip
-local_rules
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.
The checking for the domain literal is stricter than the RFC and looser than checking for a valid IP address, but this is subject to change.
The default is true.
Please note! FQDN checks only occur for non-domain-literals. In other words, if you have set "allow_ip" and the address ends in a bracketed IP address, the FQDN check will not occur.
Please note! TLD checks only occur for non-domain-literals. In other words, if you have set "allow_ip" and the address ends in a bracketed IP address, the TLD check will not occur.
rfc822
localpart
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 $@;
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 <https://metacpan.org/pod/distribution/perlfaq/lib/perlfaq9.pod>
RFC822 <https://www.ietf.org/rfc/rfc0822.txt> - standard for the format of ARPA internet text messages. Superseded by RFC2822 <https://www.ietf.org/rfc/rfc2822.txt>.
Maurice Aubrey <maurice@hevanet.com>
This software is copyright (c) 1998 by Maurice Aubrey.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
| 2022-07-08 | perl v5.34.0 |