.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Catalyst::Authentication::Store::IMAP 3pm"
.TH Catalyst::Authentication::Store::IMAP 3pm "2016-09-03" "perl v5.22.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Catalyst::Authentication::Store::IMAP \- Authentication store accessing an IMAP server.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&    use Catalyst qw(
\&      Authentication
\&      );
\&
\&    _\|_PACKAGE_\|_\->config(
\&      \*(Aqauthentication\*(Aq => {
\&         default_realm => "imap",
\&         realms => {
\&           imap => {
\&             credential => {
\&               class          => "Password",
\&               password_field => "password",
\&               password_type  => "self_check",
\&             },
\&             store => {
\&               class => \*(AqIMAP\*(Aq,
\&               host  => \*(Aqlocalhost\*(Aq,
\&             },
\&           },
\&         },
\&       },
\&    );
\&
\&    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 . "!");
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This plugin implements the Catalyst::Authentication v.10 \s-1API.\s0 Read that documentation first if
you are upgrading from a previous version of this plugin.
.PP
This plugin uses \f(CW\*(C`Mail::IMAPClient\*(C'\fR to let your application authenticate against an \s-1IMAP\s0 server.
The used imap client object is stored on the stash as imapclient for use in other components.
.SH "CONFIGURATION OPTIONS"
.IX Header "CONFIGURATION OPTIONS"
.SS "host"
.IX Subsection "host"
Sets the host name (or \s-1IP\s0 address) of the \s-1IMAP\s0 server.
.SS "port"
.IX Subsection "port"
Optionally set the port to connect to, defaults to 143.
If you specify port 993, IO::Socket::SSL will be used for connecting.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "host"
.IX Subsection "host"
The host name used to connect to.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
.SS "from_session"
.IX Subsection "from_session"
.SS "find_user"
.IX Subsection "find_user"
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Catalyst::Authentication::Store::IMAP::User
Catalyst::Plugin::Authentication, 
Mail::IMAPClient
.SH "AUTHORS"
.IX Header "AUTHORS"
Stefan Seifert <nine@cpan.org>
.SH "LICENSE"
.IX Header "LICENSE"
This library is free software, you can redistribute it and/or modify
it under the same terms as Perl itself.