File Coverage

blib/lib/HTML/FormFu/Constraint/Email.pm

Criterion	Covered	Total	%
statement	29	29	100.0
branch	10	12	83.3
condition	4	5	80.0
subroutine	5	5	100.0
pod	0	1	0.0
total	48	52	92.3

use strict;

package HTML::FormFu::Constraint::Email;
$HTML::FormFu::Constraint::Email::VERSION = '2.07';
# ABSTRACT: Email Address Constraint

use Moose;
use MooseX::Attribute::Chained;

extends 'HTML::FormFu::Constraint';

use Email::Valid;

has options => ( is => 'rw', traits => ['Chained'] );

sub constrain_value {
    my ( $self, $value ) = @_;

    return 1 if !defined $value || $value eq '';

    my %options = ( -address => $value );

    if ( defined $self->options ) {

        if ( ref $self->options eq 'ARRAY' ) {

            for my $foo ( @{ $self->options } ) {
                next if $foo eq 'address';
                $options{ '-' . $foo } = 1;
            }

        }
        elsif ( ref $self->options eq 'HASH' ) {

            for my $foo ( keys %{ $self->options } ) {
                next if $foo eq 'address';
                $options{ '-' . $foo } = $self->options->{$foo};
            }

        }
        else {

            $options{ '-' . $self->options } = 1;

        }

    }

    my $validated_address = ( Email::Valid->address(%options) // '' );
    my $ok                = $value eq $validated_address;

    return $ok;
}

__PACKAGE__->meta->make_immutable;

1;

__END__

=pod

=encoding UTF-8

=head1 NAME

HTML::FormFu::Constraint::Email - Email Address Constraint

=head1 VERSION

version 2.07

=head1 DESCRIPTION

Checks the input value is an email address according to the C<address>
method of L<Email::Valid>.

=head1 METHODS

=head2 options

Arguments: $string

Arguments: \@strings

Arguments: \%keypairs

Options are passed to L<Email::Valid>. An array or single option is
passd through with each option as 'true'. Using a hash instead, you
can pass through more specific key pair options. Remember in both
cases to omitted the leading dash that you would otherwise need if
using L<Email::Valid> directly.

  type: Email
  options:
    - macheck
    - tldcheck
    - fudge
    - fqdn
    - allow_ip
    - local_rules

=head2 SEE ALSO

Is a sub-class of, and inherits methods from L<HTML::FormFu::Constraint>

The available options are as per L<Email::Valid> but without the '-'

=head1 AUTHOR

Carl Franks C<[e-mail]>, Dean Hamstead C<[e-mail]>

=head1 LICENSE

This library is free software, you can redistribute it and/or modify it under
the same terms as Perl itself.

=head1 AUTHOR

Carl Franks <[e-mail]>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2018 by Carl Franks.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut