Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Authen::Simple::POP3(3User Contributed Perl DocumentatiAuthen::Simple::POP3(3)

NAME
       Authen::Simple::POP3 - 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
       o   new

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

	   o	   host

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

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

	   o	   port

		   Connection port, defaults to	110.

		       port => 110

	   o	   timeout

		   Connection timeout, defaults	to 60.

		       timeout => 60

	   o	   method

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

		       method => 'plain'

	   o	   log

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

		       log => Log::Log4perl->get_logger('Authen::Simple::POP3')

       o   authenticate( $username, $password )

	   Returns true	on success and false on	failure.

SEE ALSO
       Authen::Simple.

       Net::POP3.

AUTHOR
       Christian Hansen	"ch@ngmedia.com"

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

perl v5.24.1			  2017-07-03	       Authen::Simple::POP3(3)

NAME | SYNOPSIS | DESCRIPTION | METHODS | SEE ALSO | AUTHOR | COPYRIGHT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Authen::Simple::POP3&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help