# Generated by Pod::WikiDoc version 0.18

=pod

=head1 NAME

Mail::Box::IMAP4::SSL - handle IMAP4 folders with SSL

=head1 VERSION

This documentation describes version 0.02.

=head1 INHERITANCE

     Mail::Box::IMAP4::SSL
       is a Mail::Box::IMAP4
       is a Mail::Box::Net
       is a Mail::Box
       is a Mail::Reporter

=head1 SYNOPSIS

     use Mail::Box::IMAP4::SSL;
     my $folder = new Mail::Box::IMAP4::SSL(
         username => 'johndoe',
         password => 'x_marks_the_spot',
         server_name => 'imap.example.com',
     );

=head1 DESCRIPTION

This is a thin subclass of L<Mail::Box::IMAP4> to provide IMAP over SSL (aka
IMAPS).  It hides the complexity of setting up Mail::Box::IMAP4 with
L<IO::Socket::SSL>, L<Mail::IMAPClient> and L<Mail::Transport::IMAP4>.

In all other respects, it resembles L<Mail::Box::IMAP4>.  See that module
for documentation.

=head1 METHODS

=head2 C<<< Mail::Box::IMAP4::SSL->new( %options ) >>>

     my $folder = new Mail::Box::IMAP4::SSL(
         username => 'johndoe',
         password => 'x_marks_the_spot',
         server_name => 'imap.example.com',
         %other_options
     );

The C<<< username >>>, C<<< password >>> and C<<< server_name >>> options arguments are required.
The C<<< server_port >>> option is automatically set to the standard IMAPS port 993,
but can be changed if needed. See L<Mail::Box::IMAP4> for additional options.

Note: It is an error to provide a C<<< transporter >>> options, as this class exists
only to create an SSL-secured C<<< transporter >>> for C<<< Mail::Box::IMAP4 >>>.

=head1 BUGS

Please report any bugs or feature requests using the CPAN Request Tracker.  
Bugs can be submitted through the web interface at 
L<http://rt.cpan.org/Dist/Display.html?Queue=Mail::Box::IMAP4::SSL>

When submitting a bug or request, please include a test-file or a patch to an
existing test-file that illustrates the bug or desired feature.

Please limit your bugE<sol>feature reports to SSL-specific issues.  All other
issues should be directed to the maintainer of C<<< Mail::Box::IMAP4 >>>.

=head1 SEE ALSO

=over

=item *

L<Mail::Box>

=item *

L<Mail::Box::IMAP4>

=back

=head1 AUTHOR

David A. Golden (DAGOLDEN)

=head1 COPYRIGHT AND LICENSE

Copyright (c) 2007 by David A. Golden

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at 
L<http://www.apache.org/licenses/LICENSE-2.0>

Files produced as output though the use of this software, shall not be
considered Derivative Works, but shall be considered the original work of the
Licensor.

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.