String::Validator::Email - Check if a string is an email address.

- VERSION
- NAME
- SYNOPSIS
- String::Validator Methods and Usage
- Methods Specific to String::Validator::Email

- Parameters to New with (default) behaviour.
- Expound

- Example
- ToDo
- AUTHOR
- BUGS
- SUPPORT
- ACKNOWLEDGEMENTS
- LICENSE AND COPYRIGHT

# VERSION

Version 0.98

# NAME

String::Validator::Email - Check if a string is an email address.

# SYNOPSIS

String::Validator::Email is part of the String Validator Collection. It will check a string against any number of email validation rules, and optionally against a second string (as in a confirmation box on a webform).

# String::Validator Methods and Usage

Provides and conforms to all of the standard String::Validator methods, please see String::Validator for general documentation, and String::Validator::Common for information on the base String::Validator Class.

# Methods Specific to String::Validator::Email

## Parameters to New with (default) behaviour.

     mxcheck     (OFF) : Perform MX Lookup for Domain Given.
     tldcheck    (ON ) : Validate TLD against a List.
     fqdn        (ON ) : Require a Fully Qualified Domain Name.
     allow_ip    (OFF) : Allow @[ip] (forces tld & fqdn off.)
     min_len     (OFF)
     max_len     (OFF)

Important notes -- SVE uses Email::Valid, however, tldcheck is defaulted to on. The choice to turn tldcheck should be obvious. The fudge and local_rules options are specific to aol and compuserve, and are not supported. Finally mxcheck is not tried if there is already an error, since Email::Valid's DNS check does not work, that is performed directly through Net::DNS.

## Expound

Email::Valid provides very terse errors, Expound provides errors more appropriate for returning to an end user.

# Example

     use String::Validator::Email ;
     my $Validator = String::Validator::Email->new() ;
     if ( $Validator->Is_Valid( 'real@address.com' ) { say "good" }
     if ( $Validator->IsNot_Valid( 'bad@address=com') { say $Validator->Errstr() }

# ToDo

The major TO DO items are to replace Email::Valid methods, return an Email::Address object and to use it to create methods for returning information from an extended mail string like: Jane Brown <jane.brown@domain.com>.

# AUTHOR

John Karr, `<brainbuz at brainbuz.org>`

# BUGS

Please report any bugs or feature requests to `bug-string-validator-email at rt.cpan.org`, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

# SUPPORT

You can find documentation for this module with the perldoc command.

        perldoc String::Validator::Email

You can also look for information at:

- RT: CPAN's request tracker (report bugs here)

  http://rt.cpan.org/NoAuth/Bugs.html

- AnnoCPAN: Annotated CPAN documentation

  http://annocpan.org/dist/String-Validator-Email

- CPAN Ratings

  http://cpanratings.perl.org/d/String-Validator-Email

- Search CPAN

  http://search.cpan.org/dist/String-Validator-Email/

# ACKNOWLEDGEMENTS

# LICENSE AND COPYRIGHT

Copyright 2012 John Karr.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; version 3 or at your option any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

A copy of the GNU General Public License is available in the source tree; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.