Authen::Simple::POP3(3) Simple POP3 authentication

SYNOPSIS


use Authen::Simple::POP3;

my $pop3 = Authen::Simple::POP3->new(
host => 'pop3.company.com'
);

if ( $pop3->authenticate( $username, $password ) ) {
# successfull authentication
}

# or as a mod_perl Authen handler

PerlModule Authen::Simple::Apache
PerlModule Authen::Simple::POP3
PerlSetVar AuthenSimplePOP3_host "pop3.company.com"
<Location /protected>
PerlAuthenHandler Authen::Simple::POP3
AuthType Basic
AuthName "Protected Area"
Require valid-user
</Location>

DESCRIPTION

Authenticate against a POP3 service.

METHODS

  • new

    This method takes a hash of parameters. The following options are valid:

  • host

    Connection host, can be a hostname or IP number. Defaults to "localhost". 

        host => 'ftp.company.com'
    host => '10.0.0.1'
  • port

    Connection port, defaults to 110. 

        port => 110
  • timeout

    Connection timeout, defaults to 60. 

        timeout => 60
  • method

    Authentication method, defaults to "plain". Valid options are "apop", "plain", "sasl". 

        method => 'plain'
  • log

    Any object that supports "debug", "info", "error" and "warn". 

        log => Log::Log4perl->get_logger('Authen::Simple::POP3')
  • authenticate( $username, $password )

    Returns true on success and false on failure.

AUTHOR

Christian Hansen "[email protected]"

COPYRIGHT

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

LAST SEARCHED