view release on metacpan or  search on metacpan

lib/Authen/Simple/POP3.pm  view on Meta::CPAN

package Authen::Simple::POP3;

use strict;
use warnings;
use base 'Authen::Simple::Adapter';

use Net::POP3;
use Params::Validate qw[];

our $VERSION = 0.2;

__PACKAGE__->options({
    host => {
        type     => Params::Validate::SCALAR,
        default  => 'localhost',
        optional => 1
    },
    port => {
        type     => Params::Validate::SCALAR,
        default  => 110,
        optional => 1
    },
    timeout => {
        type     => Params::Validate::SCALAR,
        default  => 60,
        optional => 1
    },
    method => {
        type     => Params::Validate::SCALAR,
        default  => 'plain',
        optional => 1,
        callbacks => {
            'valid option' => sub {
                $_[0] =~ /^apop|plain|sasl$/;
            }
        }
    }    
});

sub check {
    my ( $self, $username, $password ) = @_;

    my $connection = Net::POP3->new(
        Host    => $self->host,
        Port    => $self->port,
        Timeout => $self->timeout
    );

    unless ( defined $connection ) {

        my $host   = $self->host;
        my $reason = $@ || $! || 'Unknown reason';

        $self->log->error( qq/Failed to connect to '$host'. Reason: '$reason'/ )
          if $self->log;

        return 0;
    }
    
    my $success = 0;

    if ( $self->method eq 'plain' ) {
        $success++ if $connection->login( $username, $password );
    }

    if ( $self->method eq 'sasl' ) {
        $success++ if $connection->auth( $username, $password );
    }

    if ( $self->method eq 'apop' ) {
        $success++ if $connection->apop( $username, $password );
    }
    
    unless ( $success ) {

        chomp( my $message = $connection->message || 'Unknown reason' );

        $self->log->debug( qq/Failed to authenticate user '$username'. Reason: '$message'/ )
          if $self->log;

        return 0; 
    }

    $self->log->debug( qq/Successfully authenticated user '$username'./ )
      if $self->log;

    return 1;
}

1;

__END__

=head1 NAME

Authen::Simple::POP3 - Simple POP3 authentication

=head1 SYNOPSIS

    use Authen::Simple::POP3;
    
    my $pop3 = Authen::Simple::POP3->new( 
        host => 'pop3.company.com'
    );
    
    if ( $pop3->authenticate( $username, $password ) ) {