https://github.com/gh0stwizard/p5-eav-xs

Perl 5 bindings to libeav - Email Address Validation Library
https://github.com/gh0stwizard/p5-eav-xs

perl5 rfc-5321 rfc-5322 rfc-6531 rfc-822

Last synced: 3 months ago
JSON representation

Perl 5 bindings to libeav - Email Address Validation Library

Host: GitHub
URL: https://github.com/gh0stwizard/p5-eav-xs
Owner: gh0stwizard
License: bsd-2-clause
Created: 2017-04-21T08:28:27.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2023-07-08T09:30:35.000Z (almost 2 years ago)
Last Synced: 2025-01-01T11:27:19.876Z (5 months ago)
Topics: perl5, rfc-5321, rfc-5322, rfc-6531, rfc-822
Language: Perl
Homepage:
Size: 195 KB
Stars: 2
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README
- Changelog: Changes
- License: LICENSE

Awesome Lists containing this project

README

NAME
EAV::XS - Email Address Validator

SYNOPSIS
use EAV::XS;

my $eav = EAV::XS->new();

if ($eav->is_email ('[email protected]')) {
print "This is a valid email address.\n";
} else {
printf "The email address is not valid: %s\n",
$eav->get_error();
}

DESCRIPTION
The purpose of this module is a validation of the specified Email
Address .

The core part of the module is written in C and can be found in the
libeav directory.

The module conforms to:

* RFC 822 - allows control
characters.

* RFC 5321 - does not allow any
control characters.

* RFC 5322 - allows some control
characters and not allows SPACE and TAB characters without
quoted-pairs.

* RFC 6531 - allows
Internationalized Email Addresses encoded in UTF-8. See also RFC
3629 . The RFC 6531 is based on
the rules of the RFC 5321.

You may change the behavior of the RFC 6531 mode when building the
module and enable support of the RFC 20
and RFC 5322
. By default, neither RFC 5322 nor
RFC 20 is enabled.

The RFC 20 disallows the next characters within local-part: "`", "#",
"^", "{", "}", "~" and "|". They must be in double-quotes.

The default behavior of the module also includes the check of:

* Special and Reserved domains as mentioned in RFC 6761

* FQDN - if the domain contains only alias and it is not a special or
reserved domain, then the result is negative, that is, such an email
address is considered as invalid.

* TLD - the module checks that domain is a Top Level Domain (TLD). The
list of TLDs has been taken from IANA's Root Zone Database
. See the "TLD INFORMATION"
section below for details.

DEPENDENCIES
You have to install one of IDN libraries on your choice:

* libidn2

* libidn

* libidnkit

When run Makefile.PL, you will be asked to configure EAV::XS and at this
stage you may select the IDN library to build with.

Makefile.PL requirements:

* ExtUtils::MakeMaker 5.62 or newer

* ExtUtils::PkgConfig 1.16 or newer

INSTALLING DEPENDENCIES
On Debian 10+, Ubuntu:

# libidn2 (recommended)
sudo apt-get install libidn2-dev

# libidn (only if you really need it or there is no libidn2)
sudo apt-get install libidn11-dev

# If in doubt, try search by keyword libidn
# or idn on other systems.
#
# Then try to install XYZ-dev package, where XYZ
# is libidn2 or libidn2-0 or similar package name.
apt-cache search libidn

To install idnkit, download latest release of idnkit2. Unpack it, then
build and install:

tar xjvf idnkit-2.3.tar.bz2
cd idnkit-2.3
./configure
make
sudo make install

By default idnkit2 will be installed in the /usr/local directory. You
may change it by defining prefix at configure stage, for instance:

./configure --prefix=$HOME/local
make
make install

Please, see documentation of idnkit for details.

METHODS
* $eav = new ( [%options] )

Creates a new EAV::XS object, if something goes wrong a message will
be thrown via croak().

Possible options includes:

* rfc - use this RFC specification. Possible values are: *RFC822*,
*RFC5321*, *RFC5322* or *RFC6531*. Default is *RFC6531*.

* tld_check - enable or disable TLD check. Also, this controls
FQDN check. Enabled by default.

* allow_tld - list of TLD types which considered be good. You have
to specify this list via logical OR ("|"). Information about
possible values described below in section "TLD INFORMATION".

* setup (%options)

Updates options, see description above.

* $yes_no = is_email ( $email )

Validates the specified email. Returns true if the email is valid,
otherwise returns false.

* $error_message = get_error ()

Returns an error message for the last email address tested by
is_email() method.

* $lpart = get_lpart ()

Returns local-part of the email *after* the is_email method call. If
the email address is invalid, then get_lpart returns nothing.

* $domain = get_domain ()

Returns domain-part of the email *after* the is_email method call.
If the email address is invalid, then get_domain returns nothing.
The returned value $domain could be an IPv4 address either IPv6 one,
depending on the specified email address passed to is_email ().

* $bool = get_is_ipv4 ()

Returns whether or not the domain-part of the email contains an IPv4
address, *after* the is_email method call. If the email address is
invalid, then get_is_ipv4 returns false.

* $bool = get_is_ipv6 ()

Returns whether or not the domain-part of the email contains an IPv6
address, *after* the is_email method call. If the email address is
invalid, then get_is_ipv6 returns false.

* $bool = get_is_domain ()

Returns whether or not the domain-part of the email contains an
domain name, *after* the is_email method call. If the email address
is invalid, then get_is_domain returns false.

* $tld_type = get_tld_type ()

Returns TLD type of the email *after* the is_email method call. If
the email address is invalid or an error has been occured, then
get_tld_type returns the "EAV::XS::TLD_INVALID" value.

The TLD type is a value that you pass as the "allow_tld" option to
new method. For instance, you may compare the return value of the
get_tld_type method with the value
"EAV::XS::TLD_GENERIC_RESTRICTED".

The list of TLD types may be found in the "TLD INFORMATION" section.

TLD INFORMATION
The current list of all TLDs can be found on IANA Root Zone Database
website.

The allow_tld option accepts the next values:

* TLD_NOT_ASSIGNED - allow not assigned TLDs. On IANA website they are
listed as "Not assigned" in the "TLD Manager" field.

* TLD_COUNTRY_CODE - allow country-code TLDs.

* TLD_GENERIC - allow generic TLDs.

* TLD_GENERIC_RESTRICTED - allow generic-restricted TLDs.

* TLD_INFRASTRUCTURE - allow infrastructure TLDs.

* TLD_SPONSORED - allow sponsored TLDs.

* TLD_RETIRED - allow retired TLDs. On IANA website they are listed as
"Retired" in the "TLD Manager" field.

* TLD_TEST - allow test TLDs.

* TLD_SPECIAL - allow Special & Restricted TLDs. See RFC 2606
, RFC 6761
and RFC 7686
for details. Currently, this
includes the next TLDs: "test.", "invalid.", "localhost.",
"example.", "onion." and also Second Level Domains, such as,
"example.com.", "example.net." and "example.org.".

* TLD_ALL - all flags above OR'ed:

For instance, to allow only country-code and generic TLDs you have to
write this:

my $eav = EAV::XS->new(
allow_tld => EAV::XS::TLD_COUNTRY_CODE | EAV::XS::TLD_GENERIC
);

if (not $eav->is_email ('[email protected]')) {
print ".biz is generic-restricted TLD and not allowed.\n";
}

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/gh0stwizard/p5-eav-xs

Awesome Lists containing this project

README