Skip to content

Document the AUTOLOAD method localpart() #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bschmalhofer wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document the AUTOLOAD method localpart() #61

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions lib/Email/Valid.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,7 @@ sub _is_domain_label {
sub address {
my $self = shift;
my %args = $self->_rearrange([qw( address fudge mxcheck tldcheck fqdn
local_rules )], \@_);
local_rules localpart)], \@_);

my $addr = $args{address} or return $self->details('rfc822');
$addr = $addr->address if (blessed($addr) && $addr->isa('Mail::Address'));
Expand Down Expand Up @@ -552,6 +552,7 @@ individual methods below for details.
-fqdn
-allow_ip
-local_rules
-localpart

=item mx ( <ADDRESS>|<DOMAIN> )

Expand Down Expand Up @@ -614,6 +615,12 @@ 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.

=item localpart

Specifies whether the local part of an address should be tested.
The test is for the existence of the local part and that its
length is less or equal to 64 characters. The default is true.

=item mxcheck ( <TRUE>|<FALSE> )

Specifies whether addresses passed to address() should be checked
Expand All @@ -628,7 +635,7 @@ for a valid top level domains. The default is false.

This is the primary method which determines whether an email
address is valid. Its behavior is modified by the values of
mxcheck(), tldcheck(), local_rules(), fqdn(), and fudge(). If the address
mxcheck(), tldcheck(), local_rules(), localpart(), fqdn(), and fudge(). If the address
passes all checks, the (possibly modified) address is returned as
a string. Otherwise, undef is returned.
In a list context, the method also returns an instance of the
Expand Down