README
1NAME
2 Mail::Box::IMAP4::SSL - handle IMAP4 folders with SSL
3
4VERSION
5 version 0.03
6
7SYNOPSIS
8 # standalone
9 use Mail::Box::IMAP4::SSL;
10
11 my $folder = new Mail::Box::IMAP4::SSL(
12 username => 'johndoe',
13 password => 'wbuaqbr',
14 server_name => 'imap.example.com',
15 );
16
17 # with Mail::Box::Manager
18 use Mail::Box::Manager;
19
20 my $mbm = Mail::Box::Manager->new;
21 $mbm->registerType( imaps => 'Mail::Box::IMAP4::SSL' );
22
23 my $inbox = $mbm->open(
24 folder => 'imaps://johndoe:wbuaqbr@imap.example.com/INBOX',
25 );
26
27DESCRIPTION
28 This is a thin subclass of Mail::Box::IMAP4 to provide IMAP over SSL
29 (aka IMAPS). It hides the complexity of setting up Mail::Box::IMAP4 with
30 IO::Socket::SSL, Mail::IMAPClient and Mail::Transport::IMAP4.
31
32 In all other respects, it resembles Mail::Box::IMAP4. See that module
33 for documentation.
34
35INHERITANCE
36 Mail::Box::IMAP4::SSL
37 is a Mail::Box::IMAP4
38 is a Mail::Box::Net
39 is a Mail::Box
40 is a Mail::Reporter
41
42METHODS
43 "Mail::Box::IMAP4::SSL->new( %options )"
44 my $folder = new Mail::Box::IMAP4::SSL(
45 username => 'johndoe',
46 password => 'wbuaqbr',
47 server_name => 'imap.example.com',
48 %other_options
49 );
50
51 The "username", "password" and "server_name" options arguments are
52 required. The "server_port" option is automatically set to the standard
53 IMAPS port 993, but can be changed if needed. See Mail::Box::IMAP4 for
54 additional options.
55
56 Note: It is an error to provide a "transporter" options, as this class
57 exists only to create an SSL-secured "transporter" for
58 "Mail::Box::IMAP4".
59
60SEE ALSO
61 * Mail::Box
62
63 * Mail::Box::IMAP4
64
65SUPPORT
66 Bugs / Feature Requests
67 Please report any bugs or feature requests through the issue tracker at
68 <https://github.com/dagolden/Mail-Box-IMAP4-SSL/issues>. You will be
69 notified automatically of any progress on your issue.
70
71 Source Code
72 This is open source software. The code repository is available for
73 public review and contribution under the terms of the license.
74
75 <https://github.com/dagolden/Mail-Box-IMAP4-SSL>
76
77 git clone https://github.com/dagolden/Mail-Box-IMAP4-SSL.git
78
79AUTHOR
80 David Golden <dagolden@cpan.org>
81
82COPYRIGHT AND LICENSE
83 This software is Copyright (c) 2013 by David Golden.
84
85 This is free software, licensed under:
86
87 The Apache License, Version 2.0, January 2004
88
89