Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
(Perl) handle IMAP4 folders with SSL
Perl
tree: 8400198d2b

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
examples
inc/Module/Build
lib/Mail/Box/IMAP4
t
xt
Build.PL
Changes
INSTALL
LICENSE
MANIFEST
MANIFEST.SKIP
META.yml
Makefile.PL
README
Todo

README

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

VERSION
    This documentation describes version 0.03.

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

SYNOPSIS
         # standalone
         use Mail::Box::IMAP4::SSL;
 
         my $folder = new Mail::Box::IMAP4::SSL(
             username => 'johndoe',
             password => 'wbuaqbr',
             server_name => 'imap.example.com',
         );
 
         # with Mail::Box::Manager
         use Mail::Box::Manager;
 
         my $mbm = Mail::Box::Manager->new;
         $mbm->registerType( imaps => 'Mail::Box::IMAP4::SSL' );
 
         my $inbox = $mbm->open(
             folder => 'imaps://johndoe:wbuaqbr@imap.example.com/INBOX',
         );

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

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

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

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

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

BUGS
    Please report any bugs or feature requests using the CPAN Request
    Tracker. Bugs can be submitted through the web interface at
    <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 bug/feature reports to SSL-specific issues. All other
    issues should be directed to the maintainer of "Mail::Box::IMAP4".

SEE ALSO
    *   Mail::Box

    *   Mail::Box::IMAP4

AUTHOR
    David A. Golden (DAGOLDEN)

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 <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.

Something went wrong with that request. Please try again.