Man pages sections > man3 > Catalyst::Authentication::Store::IMAP

Catalyst::Authentication::Store::IMAP - Authentication store accessing an IMAP

Catalyst::Authentication::Store::IMAP(3pm) User Contributed Perl Documentation Catalyst::Authentication::Store::IMAP(3pm)

NAME

Catalyst::Authentication::Store::IMAP - Authentication store accessing an IMAP server.

SYNOPSIS

    use Catalyst qw(
      Authentication
      );
    __PACKAGE__->config(
      'authentication' => {
         default_realm => "imap",
         realms => {
           imap => {
             credential => {
               class          => "Password",
               password_field => "password",
               password_type  => "self_check",
             },
             store => {
               class => 'IMAP',
               host  => 'localhost',
             },
           },
         },
       },
    );
    sub login : Global {
        my ( $self, $c ) = @_;
        $c->authenticate({
                          id          => $c->req->param("login"), 
                          password    => $c->req->param("password") 
                         });
        $c->res->body("Welcome " . $c->user->username . "!");
    }

DESCRIPTION

This plugin implements the Catalyst::Authentication v.10 API. Read that documentation first if you are upgrading from a previous version of this plugin.
This plugin uses "Mail::IMAPClient" to let your application authenticate against an IMAP server. The used imap client object is stored on the stash as imapclient for use in other components.

CONFIGURATION OPTIONS

host

Sets the host name (or IP address) of the IMAP server.

port

Optionally set the port to connect to, defaults to 143. If you specify port 993, IO::Socket::SSL will be used for connecting.

ATTRIBUTES

host

The host name used to connect to.

METHODS

new

from_session

find_user

SEE ALSO

Catalyst::Authentication::Store::IMAP::User Catalyst::Plugin::Authentication, Mail::IMAPClient

AUTHORS

Stefan Seifert <nine@cpan.org>

LICENSE

This library is free software, you can redistribute it and/or modify it under the same terms as Perl itself.
2017-09-21 perl v5.26.0