mirror of
https://github.com/imapsync/imapsync.git
synced 2024-11-17 08:12:48 +01:00
97 lines
2.8 KiB
Plaintext
97 lines
2.8 KiB
Plaintext
Mail::IMAPClient
|
|
================
|
|
Mail::IMAPClient is a Perl module that provides an interface for
|
|
communicating with an IMAP server as an IMAP client.
|
|
|
|
DEPENDENCIES
|
|
============
|
|
The following are the minimum requirements for using Mail::IMAPClient:
|
|
|
|
- Perl 5.8
|
|
https://www.perl.org/
|
|
- Perl modules from CPAN:
|
|
https://metacpan.org/
|
|
Required:
|
|
List::Util
|
|
MIME::Base64
|
|
Parse::RecDescent
|
|
Optional:
|
|
Authen::NTLM
|
|
Authen::SASL
|
|
Compress::Zlib
|
|
Digest::HMAC_MD5
|
|
Digest::MD5
|
|
IO::Socket::SSL
|
|
- RFC 3501 (IMAP4REV1) compatible IMAP server
|
|
https://tools.ietf.org/html/rfc3501
|
|
- Mail::IMAPClient (this package)
|
|
|
|
INSTALLATION
|
|
============
|
|
1. Download Mail::IMAPClient module
|
|
https://metacpan.org/release/Mail-IMAPClient
|
|
|
|
2. Read this README
|
|
|
|
3. This module has a number of dependencies on other Perl modules
|
|
available from CPAN. If any modules are missing, appropriate
|
|
warnings will be generated in the following step.
|
|
|
|
4. Prepare to build this module and install any prerequisite modules:
|
|
|
|
perl Makefile.PL
|
|
|
|
5. (OPTIONAL) For extended tests during 'make test', create a file
|
|
'test.txt' in the top level directory of this distribution (the
|
|
same directory as the Makefile.PL, etc.). This file must contain
|
|
an IMAP server name or IP (server=...), a user account (user=...),
|
|
and password a (passed=...). A port (port=....) and an
|
|
authentication mechanism to be used (authmechanism=...) can also be
|
|
specified.
|
|
|
|
Example:
|
|
|
|
--- BEGIN: test.txt ---
|
|
server=localhost
|
|
user=mytestuser
|
|
passed=mypassword
|
|
port=143
|
|
--- END: test.txt ---
|
|
|
|
NOTE: When testing is completed, be sure to remove test.txt (either
|
|
by hand or by 'make clean').
|
|
|
|
6. Build, test and install this module:
|
|
|
|
make
|
|
make test
|
|
(sudo) make install
|
|
|
|
7. Read the documentation to become familiar with this module.
|
|
|
|
Project Links
|
|
=============
|
|
- Bugs/tickets:
|
|
https://rt.cpan.org/Public/Dist/Display.html?Name=Mail-IMAPClient
|
|
- Source code repository (git):
|
|
https://sourceforge.net/p/mail-imapclient/git/
|
|
https://github.com/plobbes/mail-imapclient/
|
|
- CPAN releases:
|
|
https://metacpan.org/release/Mail-IMAPClient
|
|
|
|
COPYRIGHT AND LICENSE
|
|
=====================
|
|
Copyright (C) 1999-2003 The Kernen Group, Inc.
|
|
Copyright (C) 2007-2009 Mark Overmeer
|
|
Copyright (C) 2010-2019 Phil Pearl (Lobbes)
|
|
All rights reserved.
|
|
|
|
This library is free software; you can redistribute it and/or modify
|
|
it under the same terms as Perl itself, either Perl version 5.8.0 or,
|
|
at your option, any later version of Perl 5 you may have available.
|
|
|
|
This program is distributed in the hope that it will be useful, but
|
|
WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See either the
|
|
GNU General Public License or the Artistic License for more details.
|