NAME
Authen::Simple::Atheme - Simple authentication to Atheme IRC services
SYNOPSIS
use Authen::Simple::Atheme;
my $auth = Authen::Simple::Atheme->new(
host => 'services.network.tld',
port => 8080
);
if ( $auth->authenticate( $username, $password ) ) {
# successful authentication
}
DESCRIPTION
Atheme authentication
METHODS
- new
-
This method takes a hash of parameters. The following options are valid:
- host
-
Connection host, can be a hostname or IP address. Defaults to
localhost
. - port
-
Connection port, defaults to
8080
. - log
-
Any object that supports
debug
,info
,error
, andwarn
.log => Log::Log4perl->ge_logger('Authen::Simple::Atheme')
- authenticate
-
This method takes two parameters, a username and a password (In that order). Returns true on success and false on failure.
- register
-
This method takes three parameters, a username, a password, and an email address (In that order). Returns the XMLRPC hash given to it by Atheme.
SEE ALSO
AUTHOR
Alexandria M. Wolcott alyx@cpan.org
COPYRIGHT
This program is free software, you can redistribute it and/or modify it under the same terms as Perl itself.
2 POD Errors
The following errors were encountered while parsing the POD:
- Around line 114:
'=item' outside of any '=over'
- Around line 119:
You forgot a '=back' before '=head1'