README
1NAME
2 Dancer2::Plugin::Auth::Extensible::Provider::IMAP - IMAP authentication
3 provider for Dancer2::Plugin::Auth::Extensible
4
5DESCRIPTION
6 This class is a generic IMAP authentication provider.
7
8 See Dancer2::Plugin::Auth::Extensible for details on how to use the
9 authentication framework.
10
11ATTRIBUTES
12 host
13 IMAP server name or IP address. Required.
14
15 options
16 A hash reference of options to be passed to "new" in Net::IMAP::Simple.
17
18 Defaults to:
19
20 {
21 port => 993,
22 use_ssl => 1,
23 ssl_version => 'TLSv1',
24 }
25
26METHODS
27 authenticate_user $username, $password
28SEE ALSO
29 Dancer2, Dancer2::Plugin::Auth::Extensible, Net::IMAP::Simple.
30
31AUTHOR
32 Peter Mottram (SysPete), "<peter at sysnix.com>"
33
34BUGS
35 Please report any bugs or feature requests via the project's GitHub
36 issue tracker:
37
38 <https://github.com/SysPete/Dancer2-Plugin--Auth-Extensible-Provider-IMA
39 P/issues>
40
41 I will be notified, and then you'll automatically be notified of
42 progress on your bug as I make changes. PRs are always welcome.
43
44SUPPORT
45 You can find documentation for this module with the perldoc command.
46
47 perldoc Dancer2::Plugin::Auth::Extensible::Provider::IMAP
48
49 You can also look for information at:
50
51 * GitHub repository
52 <https://github.com/PerlDancer/Dancer2-Plugin-Auth-Extensible-Provid
53 er-IMAP>
54
55 * meta::cpan
56 <https://metacpan.org/pod/Dancer2::Plugin::Auth::Extensible::Provide
57 r::IMAP>
58
59LICENSE AND COPYRIGHT
60 Copyright 2016 Peter Mottram (SysPete).
61
62 This program is free software; you can redistribute it and/or modify it
63 under the terms of the the Artistic License (2.0). You may obtain a copy
64 of the full license at:
65
66 <http://www.perlfoundation.org/artistic_license_2_0>
67
68 Any use, modification, and distribution of the Standard or Modified
69 Versions is governed by this Artistic License. By using, modifying or
70 distributing the Package, you accept this license. Do not use, modify,
71 or distribute the Package, if you do not accept this license.
72
73 If your Modified Version has been derived from a Modified Version made
74 by someone other than you, you are nevertheless required to ensure that
75 your Modified Version complies with the requirements of this license.
76
77 This license does not grant you the right to use any trademark, service
78 mark, tradename, or logo of the Copyright Holder.
79
80 This license includes the non-exclusive, worldwide, free-of-charge
81 patent license to make, have made, use, offer to sell, sell, import and
82 otherwise transfer the Package with respect to any patent claims
83 licensable by the Copyright Holder that are necessarily infringed by the
84 Package. If you institute patent litigation (including a cross-claim or
85 counterclaim) against any party alleging that the Package constitutes
86 direct or contributory patent infringement, then this Artistic License
87 to you shall terminate on the date that such litigation is filed.
88
89 Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER
90 AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES.
91 THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
92 PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY
93 YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR
94 CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR
95 CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE,
96 EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
97
98