1Mail::IMAPClient 2================ 3Mail::IMAPClient is a Perl module that provides an interface for 4communicating with an IMAP server as an IMAP client. 5 6DEPENDENCIES 7============ 8The following are the minimum requirements for using Mail::IMAPClient: 9 10- Perl 5.8 11 https://www.perl.org/ 12- Perl modules from CPAN: 13 https://metacpan.org/ 14 Required: 15 List::Util 16 MIME::Base64 17 Parse::RecDescent 18 Optional: 19 Authen::NTLM 20 Authen::SASL 21 Compress::Zlib 22 Digest::HMAC_MD5 23 Digest::MD5 24 IO::Socket::SSL 25- RFC 3501 (IMAP4REV1) compatible IMAP server 26 https://tools.ietf.org/html/rfc3501 27- Mail::IMAPClient (this package) 28 29INSTALLATION 30============ 311. Download Mail::IMAPClient module 32 https://metacpan.org/release/Mail-IMAPClient 33 342. Read this README 35 363. This module has a number of dependencies on other Perl modules 37 available from CPAN. If any modules are missing, appropriate 38 warnings will be generated in the following step. 39 404. Prepare to build this module and install any prerequisite modules: 41 42 perl Makefile.PL 43 445. (OPTIONAL) For extended tests during 'make test', create a file 45 'test.txt' in the top level directory of this distribution (the 46 same directory as the Makefile.PL, etc.). This file must contain 47 an IMAP server name or IP (server=...), a user account (user=...), 48 and password a (passed=...). A port (port=....) and an 49 authentication mechanism to be used (authmechanism=...) can also be 50 specified. 51 52Example: 53 54--- BEGIN: test.txt --- 55server=localhost 56user=mytestuser 57passed=mypassword 58port=143 59--- END: test.txt --- 60 61 NOTE: When testing is completed, be sure to remove test.txt (either 62 by hand or by 'make clean'). 63 646. Build, test and install this module: 65 66 make 67 make test 68 (sudo) make install 69 707. Read the documentation to become familiar with this module. 71 72Project Links 73============= 74- Bugs/tickets: 75 https://github.com/plobbes/mail-imapclient/issues 76- Source code repository (git): 77 https://github.com/plobbes/mail-imapclient/ 78 https://sourceforge.net/p/mail-imapclient/git/ 79- CPAN releases: 80 https://metacpan.org/release/Mail-IMAPClient 81 82TESTING 83======= 84Ubuntu under WSL 2.0 85 86$ sudo apt install dovecot-imapd # imap server 87$ sudo adduser imaptest # test user 88# dependencies 89$ sudo apt install make libio-socket-ssl-perl libtest-pod-perl libparse-recdescent-perl 90$ sudo /etc/init.d/rsyslog start 91$ sudo /etc/init.d/dovecot start 92 93COPYRIGHT AND LICENSE 94===================== 95Copyright (C) 1999-2003 The Kernen Group, Inc. 96Copyright (C) 2007-2009 Mark Overmeer 97Copyright (C) 2010-2021 Phil Pearl (Lobbes) 98All rights reserved. 99 100This library is free software; you can redistribute it and/or modify 101it under the same terms as Perl itself, either Perl version 5.8.0 or, 102at your option, any later version of Perl 5 you may have available. 103 104This program is distributed in the hope that it will be useful, but 105WITHOUT ANY WARRANTY; without even the implied warranty of 106MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See either the 107GNU General Public License or the Artistic License for more details. 108