#!/usr/bin/perl # structure # pod documentation # pragmas # main program # global variables initialisation # default values # subroutines # IMAPClient 2.2.9 overrides # IMAPClient 2.2.9 3.xx ads =pod =head1 NAME imapsync - IMAP synchronisation, sync, copy or migration tool. Synchronise mailboxes between two imap servers. Good at IMAP migration. More than 36 different IMAP server softwares supported with success. $Revision: 1.340 $ =head1 SYNOPSIS To synchronise imap account "foo" on "imap.truc.org" to imap account "bar" on "imap.trac.org" with foo password "secret1" and bar password "secret2": imapsync \ --host1 imap.truc.org --user1 foo --password1 secret1 \ --host2 imap.trac.org --user2 bar --password2 secret2 =head1 INSTALL imapsync works fine under any Unix OS with perl. imapsync works fine under Windows (2000, XP) with ActiveState's 5.8 Perl or as a standalone binary software. imapsync is already available directly on the following distributions (at least): FreeBSD, Debian, Ubuntu, Gentoo, NetBSD, Darwin, Mandriva and OpenBSD (yeah!). Get imapsync at http://www.linux-france.org/prj/imapsync/ You'll find a compressed tarball called imapsync-x.xx.tgz where x.xx is the version number. Untar the tarball where you want (on Unix): tar xzvf imapsync-x.xx.tgz Go into the directory imapsync-x.xx and read the INSTALL file. The INSTALL file is also at http://www.linux-france.org/prj/imapsync/INSTALL The freshmeat record is at http://freshmeat.net/projects/imapsync/ =head1 USAGE imapsync [options] To get a description of each option just run imapsync like this: imapsync --help imapsync The option list: imapsync [--host1 server1] [--port1 ] [--user1 ] [--passfile1 ] [--host2 server2] [--port2 ] [--user2 ] [--passfile2 ] [--ssl1] [--ssl2] [--tls1] [--tls2] [--authmech1 ] [--authmech2 ] [--noauthmd5] [--folder --folder ...] [--folderrec --folderrec ...] [--include ] [--exclude ] [--prefix2 ] [--prefix1 ] [--regextrans2 --regextrans2 ...] [--sep1 ] [--sep2 ] [--justfolders] [--justfoldersizes] [--justconnect] [--justbanner] [--syncinternaldates] [--idatefromheader] [--buffersize ] [--syncacls] [--regexmess ] [--regexmess ] [--maxsize ] [--maxage ] [--minage ] [--skipheader ] [--useheader ] [--useheader ] [--skipsize] [--allowsizemismatch] [--delete] [--delete2] [--expunge] [--expunge1] [--expunge2] [--uidexpunge2] [--subscribed] [--subscribe] [--subscribe_all] [--nofoldersizes] [--dry] [--debug] [--debugimap][--debugimap1][--debugimap2] [--timeout ] [--fast] [--split1] [--split2] [--reconnectretry1 ] [--reconnectretry2 ] [--pidfile ] [--tmpdir ] [--version] [--help] =cut # comment =pod =head1 DESCRIPTION The command imapsync is a tool allowing incremental and recursive imap transfer from one mailbox to another. By default all folders are transferred, recursively. We sometimes need to transfer mailboxes from one imap server to another. This is called migration. imapsync is a good tool because it reduces the amount of data transferred by not transferring a given message if it is already on both sides. Same headers and the transfer is done only once. All flags are preserved, unread will stay unread, read will stay read, deleted will stay deleted. You can stop the transfer at any time and restart it later, imapsync works well with bad connections. imapsync is CPU hungry so nice and renice commands can be a good help. imapsync can be memory hungry too, especially with large messages. You can decide to delete the messages from the source mailbox after a successful transfer (it is a good feature when migrating). In that case, use the --delete --expunge1 options. You can also just synchronize a mailbox A from another mailbox B in case you just want to keep a "live" copy of B in A (--delete2 may help) =head1 OPTIONS To get a description of each option just invoke: imapsync --help =head1 HISTORY I wrote imapsync because an enterprise (basystemes) paid me to install a new imap server without losing huge old mailboxes located on a far away remote imap server accessible by a low bandwidth link. The tool imapcp (written in python) could not help me because I had to verify every mailbox was well transferred and delete it after a good transfer. imapsync started life as a copy_folder.pl patch. The tool copy_folder.pl comes from the Mail-IMAPClient-2.1.3 perl module tarball source (in the examples/ directory of the tarball). =head1 EXAMPLE While working on imapsync parameters please run imapsync in dry mode (no modification induced) with the --dry option. Nothing bad can be done this way. To synchronize the imap account "buddy" (with password "secret1") on host "imap.src.fr" to the imap account "max" (with password "secret2") on host "imap.dest.fr": imapsync --host1 imap.src.fr --user1 buddy --password1 secret1 \ --host2 imap.dest.fr --user2 max --password2 secret2 Then you will have max's mailbox updated from buddy's mailbox. =head1 SECURITY You can use --passfile1 instead of --password1 to give the password since it is safer. With --password1 option any user on your host can see the password by using the 'ps auxwwww' command. Using a variable (like $PASSWORD1) is also dangerous because of the 'ps auxwwwwe' command. So, saving the password in a well protected file (600 or rw-------) is the best solution. imasync is not totally protected against sniffers on the network since passwords may be transferred in plain text if CRAM-MD5 is not supported by your imap servers. Use --ssl1 (or --tls1) and --ssl2 (or --tls2) to enable encryption on host1 and host2. You may authenticate as one user (typically an admin user), but be authorized as someone else, which means you don't need to know every user's personal password. Specify --authuser1 "adminuser" to enable this on host1. In this case, --authmech1 PLAIN will be used by default since it is the only way to go for now. So don't use --authmech1 SOMETHING with --authuser1 "adminuser", it will not work. Same behavior with the --authuser2 option. =head1 EXIT STATUS imapsync will exit with a 0 status (return code) if everything went good. Otherwise, it exits with a non-zero status. So if you have an unreliable internet connection, you can use this loop in a Bourne shell: while ! imapsync ...; do echo imapsync not complete done =head1 LICENSE imapsync is free, gratis and open source software cover by the Do What The Fuck You Want To Public License (WTFPL). See COPYING file included in the distribution or the web site http://sam.zoy.org/wtfpl/COPYING =head1 MAILING-LIST The public mailing-list may be the best way to get support. To write on the mailing-list, the address is: To subscribe, send a message to: To unsubscribe, send a message to: To contact the person in charge for the list: The list archives may be available at: http://www.linux-france.org/prj/imapsync_list/ So consider that the list is public, anyone can see your post. Use a pseudonym or do not post to this list if you want to stay private. Thank you for your participation. =head1 AUTHOR Gilles LAMIRAL Feedback good or bad is always welcome. The newsgroup comp.mail.imap may be a good place to talk about imapsync. I read it when imapsync is concerned. A better place is the public imapsync mailing-list (see below). Gilles LAMIRAL earns his living writing, installing, configuring and teaching free, open and gratis softwares. Do not hesitate to pay him for that services. =head1 BUG REPORT GUIDELINES Help us to help you: follow the following guidelines. Report any bugs or feature requests to the public mailing-list or to the author. Before reporting bugs, read the FAQ, the README and the TODO files. http://www.linux-france.org/prj/imapsync/ Upgrade to last imapsync release, maybe the bug is already fixed. Upgrade to last Mail-IMAPClient Perl module. http://search.cpan.org/dist/Mail-IMAPClient/ maybe the bug is already fixed. Make a good title with word "imapsync" in it (my spam filter won't filter it), Don't write an email title with just "imapsync" or "problem", a good title is made of keywords summary, not too long (one visible line). Don't write imapsync in uppercase in the email title, we'll know you run windows(tm) and you haven't read the README yet. Help us to help you: in your report, please include: - imapsync version. - output given with --debug --debugimap near the failure point. Isolate a message or two in a folder 'BUG' and use imapsync ... --folder 'BUG' --debug --debugimap - imap server software on both side and their version number. - imapsync with all the options you use, the full command line you use (except the passwords of course). - IMAPClient.pm version. - operating system running imapsync. - operating systems on both sides and the third side in case you run imapsync on a foreign host from the both. - virtual software context (vmware, xen etc.) Most of those values can be found as a copy/paste at the begining of the output. One time in your life, read the paper "How To Ask Questions The Smart Way" http://www.catb.org/~esr/faqs/smart-questions.html and then forget it. =head1 IMAP SERVERS Failure stories reported with the following 4 imap servers: - MailEnable 1.54 (Proprietary) http://www.mailenable.com/ - DBMail 0.9, 2.0.7 (GPL). But DBMail 1.2.1 works. Patient and confident testers are welcome. - dkimap4 2.39 - Imail 7.04 (maybe). Success stories reported with the following 36 imap servers (software names are in alphabetic order): - 1und1 H mimap1 84498 [host1] - Archiveopteryx 2.03, 2.04, 2.09, 2.10 [host2], 3.0.0 [host2] (OSL 3.0) http://www.archiveopteryx.org/ - BincImap 1.2.3 (GPL) (http://www.bincimap.org/) - CommuniGatePro server (Redhat 8.0) (Solaris), CommuniGate Pro 5.2.17[host2] (CentOS 5.4) - Courier IMAP 1.5.1, 2.2.0, 2.1.1, 2.2.1, 3.0.8, 3.0.3, 4.1.1 (GPL) (http://www.courier-mta.org/) - Critical Path (7.0.020) - Cyrus IMAP 1.5, 1.6, 2.1, 2.1.15, 2.1.16, 2.1.18 2.2.1, 2.2.2-BETA, 2.2.10, 2.2.12, v2.2.3-Invoca-RPM-2.2.3-8, 2.3-alpha (OSI Approved), v2.2.12-Invoca-RPM-2.2.12-3.RHEL4.1, 2.2.13, v2.3.1-Invoca-RPM-2.3.1-2.7.fc5, v2.3.7, (http://asg.web.cmu.edu/cyrus/) - David Tobit V8 (proprietary Message system). - DBMail 1.2.1, 2.0.4, 2.0.9, 2.2rc1 (GPL) (http://www.dbmail.org/). 2.0.7 seems buggy. - Deerfield VisNetic MailServer 5.8.6 [host1] - Domino (Notes) 4.61[host1], 6.5, 5.0.6, 5.0.7, 7.0.2, 6.0.2CF1, 7.0.1[host1], 8.0.1[host1] - Dovecot 0.99.10.4, 0.99.14, 0.99.14-8.fc4, 1.0-0.beta2.7, 1.0.0 [dest/source] (LGPL) (http://www.dovecot.org/) - Eudora WorldMail v2 - GMX IMAP4 StreamProxy. - Groupwise IMAP (Novell) 6.x and 7.0. Buggy so see the FAQ. - iPlanet Messaging server 4.15, 5.1, 5.2 - IMail 7.15 (Ipswitch/Win2003), 8.12 - MDaemon 7.0.1, 8.0.2, 8.1, 9.5.4 (Windows server 2003 R2 platform) - Mercury 4.1 (Windows server 2000 platform) - Microsoft Exchange Server 5.5, 6.0.6249.0[host1], 6.0.6487.0[host1], 6.5.7638.1 [host2], Exchange 2007 SP1 (with Update Rollup 2), Exchange2007-EP-SP2, Exchange 2010 RTM (Release to Manufacturing) [host2] - Netscape Mail Server 3.6 (Wintel !) - Netscape Messaging Server 4.15 Patch 7 - OpenMail IMAP server B.07.00.k0 (Samsung Contact ?) - OpenWave - Qualcomm Worldmail (NT) - Rockliffe Mailsite 5.3.11, 4.5.6 - Samsung Contact IMAP server 8.5.0 - Scalix v10.1, 10.0.1.3, 11.0.0.431 - SmarterMail, Smarter Mail 5.0 Enterprise. - SunONE Messaging server 5.2, 6.0 (SUN JES - Java Enterprise System) - Sun Java(tm) System Messaging Server 6.2-2.05, 6.2-7.05 - Surgemail 3.6f5-5 - UW-imap servers (imap-2000b) rijkkramer IMAP4rev1 2000.287 (RedHat uses UW like 2003.338rh), v12.264 Solaris 5.7 (OSI Approved) (http://www.washington.edu/imap/) - UW - QMail v2.1 - Imap part of TCP/IP suite of VMS 7.3.2 - Zimbra-IMAP 3.0.1 GA 160, 3.1.0 Build 279, 4.0.5, 4.5.2, 4.5.6, 5.5. Please report to the author any success or bad story with imapsync and do not forget to mention the IMAP server software names and version on both sides. This will help future users. To help the author maintaining this section report the two lines at the begining of the output if they are useful to know the softwares. Example: Host1 software:* OK louloutte Cyrus IMAP4 v1.5.19 server ready Host2 software:* OK Courier-IMAP ready You can use option --justconnect to get those lines. Example: imapsync --host1 imap.troc.org --host2 imap.trac.org --justconnect Please rate imapsync at http://freshmeat.net/projects/imapsync/ or better give the author a book, he likes books: http://www.amazon.com/gp/registry/wishlist/1C9UNDIH3P7R7/ (or its paypal account gilles.lamiral@laposte.net) =head1 HUGE MIGRATION Pay special attention to options --subscribed --subscribe --delete --delete2 --expunge --expunge1 --expunge2 --uidexpunge2 --maxage --minage --maxsize --useheader --fast If you have many mailboxes to migrate think about a little shell program. Write a file called file.csv (for example) containing users and passwords. The separator used in this example is ';' The file.csv file contains: user0001;password0001;user0002;password0002 user0011;password0011;user0012;password0012 ... And the shell program is just: { while IFS=';' read u1 p1 u2 p2; do imapsync --user1 "$u1" --password1 "$p1" --user2 "$u2" --password2 "$p2" ... done ; } < file.csv Welcome in shell programming ! =head1 Hacking Feel free to hack imapsync as the WTFPL Licence permits it. =head1 Links Entries for imapsync: http://www.imap.org/products/showall.php =head1 SIMILAR SOFTWARES imap_tools : http://www.athensfbc.com/imap_tools offlineimap : http://software.complete.org/offlineimap mailsync : http://mailsync.sourceforge.net/ imapxfer : http://www.washington.edu/imap/ part of the imap-utils from UW. mailutil : replace imapxfer in part of the imap-utils from UW. http://www.gsp.com/cgi-bin/man.cgi?topic=mailutil imaprepl : http://www.bl0rg.net/software/ http://freshmeat.net/projects/imap-repl/ imap_migrate : http://freshmeat.net/projects/imapmigration/ imapcopy : http://home.arcor.de/armin.diehl/imapcopy/imapcopy.html migrationtool : http://sourceforge.net/projects/migrationtool/ imapmigrate : http://sourceforge.net/projects/cyrus-utils/ wonko_imapsync: http://wonko.com/article/554 see also tools/wonko_ruby_imapsync pop2imap : http://www.linux-france.org/prj/pop2imap/ Feedback (good or bad) will often be welcome. $Id: imapsync,v 1.340 2010/08/09 00:03:21 gilles Exp gilles $ =cut # pragmas use warnings; ++$|; use strict; use Carp; use Getopt::Long; use Mail::IMAPClient; use Digest::MD5 qw(md5_base64); #use Term::ReadKey; #use IO::Socket::SSL; use MIME::Base64; use English; use POSIX qw(uname); use Fcntl; use File::Spec; use File::Path qw(mkpath rmtree); use IO::Socket qw(:crlf SOL_SOCKET SO_KEEPALIVE); use Errno qw(EAGAIN EPIPE ECONNRESET); use Test::More 'no_plan'; eval { require 'usr/include/sysexits.ph' }; # global variables my( $rcs, $pidfile, $debug, $debugimap, $debugimap1, $debugimap2, $nb_errors, $host1, $host2, $port1, $port2, $user1, $user2, $password1, $password2, $passfile1, $passfile2, @folder, @include, @exclude, @folderrec, $prefix1, $prefix2, @regextrans2, @regexmess, @regexflag, $sep1, $sep2, $syncinternaldates, $idatefromheader, $usedatemanip, $syncacls, $fastio1, $fastio2, $maxsize, $maxage, $minage, $skipheader, @useheader, $skipsize, $allowsizemismatch, $foldersizes, $buffersize, $delete, $delete2, $expunge, $expunge1, $expunge2, $uidexpunge2, $dry, $justfoldersizes, $authmd5, $subscribed, $subscribe, $subscribe_all, $version, $help, $justconnect, $justfolders, $justbanner, $fast, $total_bytes_transferred, $total_bytes_skipped, $total_bytes_error, $nb_msg_transferred, $nb_msg_skipped, $nb_msg_skipped_dry_mode, $h1_nb_msg_duplicate, $h2_nb_msg_duplicate, $h1_nb_msg_noheader, $h2_nb_msg_noheader, $h1_total_bytes_duplicate, $h2_total_bytes_duplicate, $h1_nb_msg_deleted, $h2_nb_msg_deleted, $timeout, $timestart, $timeend, $timediff, $timesize, $timebefore, $ssl1, $ssl2, $tls1, $tls2, $authuser1, $authuser2, $authmech1, $authmech2, $split1, $split2, $reconnectretry1, $reconnectretry2, $tests, $test_builder, $tests_debug, $allow3xx, $justlogin, $tmpdir, ); # main program # global variables initialisation $rcs = '$Id: imapsync,v 1.340 2010/08/09 00:03:21 gilles Exp gilles $ '; $total_bytes_transferred = 0; $total_bytes_skipped = 0; $total_bytes_error = 0; $nb_msg_transferred = 0; $nb_msg_skipped = $nb_msg_skipped_dry_mode = 0; $h1_nb_msg_deleted = $h2_nb_msg_deleted = 0; $h1_nb_msg_duplicate = $h2_nb_msg_duplicate = 0; $h1_nb_msg_noheader = $h2_nb_msg_noheader = 0; $h1_total_bytes_duplicate = $h2_total_bytes_duplicate = 0; $nb_errors = 0; unless(defined(&_SYSEXITS_H)) { # 64 on my linux box. eval 'sub EX_USAGE () {64;}' unless defined(&EX_USAGE); } # @ARGV will be eat by get_options() my @argv_copy = @ARGV; get_options(); # default values $tmpdir ||= File::Spec->tmpdir(); $pidfile ||= $tmpdir . '/imapsync.pid'; # allow Mail::IMAPClient 3.0.xx by default $allow3xx = defined($allow3xx) ? $allow3xx : 1; # Does not use Date::Manip by default: buggy 5.x vs 6.x and slow $usedatemanip = defined($usedatemanip) ? $usedatemanip : 0; print banner_imapsync(@argv_copy); print "Temp directory is $tmpdir\n"; is_valid_directory($tmpdir); write_pidfile($pidfile) if ($pidfile); print "Modules version list:\n", modules_VERSION(), "\n"; check_lib_version() or die "imapsync needs perl lib Mail::IMAPClient release 2.2.9, or 3.0.25 or superior \n"; exit_clean(0) if ($justbanner); # By default, 1000 at a time, not more. $split1 ||= 1000; $split2 ||= 1000; $host1 || missing_option("--host1") ; $port1 ||= (defined $ssl1 and !defined $tls1) ? 993 : 143; $host2 || missing_option("--host2") ; $port2 ||= (defined $ssl2 && !defined $tls2) ? 993 : 143; $debugimap1 = $debugimap2 = 1 if ($debugimap); # By default, don't take size to compare $skipsize = (defined $skipsize) ? $skipsize : 1; sub connect_imap { my($host, $port, $debugimap, $ssl, $tls) = @_; my $imap = Mail::IMAPClient->new(); $imap->Server($host); $imap->Port($port); $imap->Debug($debugimap); $imap->Ssl($ssl) if ($ssl); $imap->Tls($tls) if ($tls); #$imap->connect() myconnect($imap) or die_clean("Can not open imap connection on [$host]: $@\n"); } sub localhost_info { my($infos) = join("", "Here is a [$OSNAME] system (", join(" ", uname(), ), ")\n", "With perl ", sprintf("%vd", $PERL_VERSION), " Mail::IMAPClient $Mail::IMAPClient::VERSION", ); return($infos); } if ($justconnect) { justconnect(); exit_clean(0); } $user1 || missing_option("--user1"); $user2 || missing_option("--user2"); $syncinternaldates = defined($syncinternaldates) ? $syncinternaldates : 1; if($idatefromheader) { print "Turned ON idatefromheader, ", "will set the internal dates on host2 from the 'Date:' header line.\n"; $syncinternaldates = 0; } if ($syncinternaldates) { print "Turned ON syncinternaldates, ", "will set the internal dates (arrival dates) on host2 same as host1.\n"; }else{ print "Turned OFF syncinternaldates\n"; } if ($syncinternaldates || $idatefromheader) { # Date::Manip is an ugly module: it exits (confess) for reading an unset value # I should write a bug report but I'm too lazy. no warnings 'redefine'; local *Carp::confess = sub { return undef; }; require Date::Manip; Date::Manip->import(qw(ParseDate UnixDate Date_Init Date_TimeZone)); if ($OSNAME eq "MSWin32") { # It seems that local *Carp does not work on win32 my $TZ = $ENV{TZ} || 'GMT'; Date_Init("TZ=$TZ"); print "TimeZone: [", Date_TimeZone(), "]\n"; }else{ #print "Date_init: [", join(" ",Date_Init()), "]\n"; print "TimeZone:[", Date_TimeZone(), "]\n"; if (not (Date_TimeZone())) { warn "TimeZone not defined, setting it to GMT"; Date_Init("TZ=GMT"); print "TimeZone: [", Date_TimeZone(), "]\n"; } } } if(defined($authmd5) and not($authmd5)) { $authmech1 ||= 'LOGIN'; $authmech2 ||= 'LOGIN'; } else{ $authmech1 ||= $authuser1 ? 'PLAIN' : 'CRAM-MD5'; $authmech2 ||= $authuser2 ? 'PLAIN' : 'CRAM-MD5'; } $authmech1 = uc($authmech1); $authmech2 = uc($authmech2); $authuser1 ||= $user1; $authuser2 ||= $user2; print "Will try to use $authmech1 authentication on host1\n"; print "Will try to use $authmech2 authentication on host2\n"; $syncacls = (defined($syncacls)) ? $syncacls : 0; $foldersizes = (defined($foldersizes)) ? $foldersizes : 1; $fastio1 = (defined($fastio1)) ? $fastio1 : 0; $fastio2 = (defined($fastio2)) ? $fastio2 : 0; $reconnectretry1 = (defined($reconnectretry1)) ? $reconnectretry1 : 3; $reconnectretry2 = (defined($reconnectretry2)) ? $reconnectretry2 : 3; @useheader = ("ALL") unless (@useheader); print "Host1 imap server [$host1] port [$port1] user [$user1]\n"; print "Host2 imap server [$host2] port [$port2] user [$user2]\n"; sub ask_for_password { my ($user, $host) = @_; print "What's the password for $user\@$host? "; Term::ReadKey::ReadMode(2); my $password = <>; chomp $password; printf "\n"; Term::ReadKey::ReadMode(0); return $password; } $password1 || $passfile1 || do { $password1 = ask_for_password($authuser1 || $user1, $host1); }; $password1 = (defined($passfile1)) ? firstline ($passfile1) : $password1; $password2 || $passfile2 || do { $password2 = ask_for_password($authuser2 || $user2, $host2); }; $password2 = (defined($passfile2)) ? firstline ($passfile2) : $password2; my $imap1 = (); my $imap2 = (); $timestart = time(); $timebefore = $timestart; $debugimap1 and print "Host1 connection\n"; $imap1 = login_imap($host1, $port1, $user1, $password1, $debugimap1, $timeout, $fastio1, $ssl1, $tls1, $authmech1, $authuser1, $reconnectretry1); $debugimap2 and print "Host2 connection\n"; $imap2 = login_imap($host2, $port2, $user2, $password2, $debugimap2, $timeout, $fastio2, $ssl2, $tls2, $authmech2, $authuser2, $reconnectretry2); # history $debug and print "Host1 Buffer I/O: ", $imap1->Buffer(), "\n"; $debug and print "Host2 Buffer I/O: ", $imap2->Buffer(), "\n"; sub login_imap { my($host, $port, $user, $password, $debugimap, $timeout, $fastio, $ssl, $tls, $authmech, $authuser, $reconnectretry) = @_; my ($imap); $imap = Mail::IMAPClient->new(); $imap->Ssl($ssl) if ($ssl); $imap->Tls($tls) if ($tls); $imap->Clear(5); $imap->Server($host); $imap->Port($port); $imap->Fast_io($fastio); $imap->Buffer($buffersize || 4096); $imap->Uid(1); $imap->Peek(1); $imap->Debug($debugimap); $timeout and $imap->Timeout($timeout); $imap->Reconnectretry($reconnectretry) if ($reconnectretry); #$imap->connect() myconnect($imap) or die_clean("Can not open imap connection on [$host] with user [$user]: $@\n"); print "Banner: ", server_banner($imap); if ($imap->has_capability("AUTH=$authmech") or $imap->has_capability($authmech) ) { printf("Host %s says it has CAPABILITY for AUTHENTICATE %s\n", $imap->Server, $authmech); } else { printf("Host %s says it has NO CAPABILITY for AUTHENTICATE %s\n", $imap->Server, $authmech); if ($authmech eq 'PLAIN') { print "Frequently PLAIN is only supported with SSL, ", "try --ssl1 or --ssl2 option\n"; } } $imap->Authmechanism($authmech) unless ($authmech eq 'LOGIN'); $imap->Authcallback(\&plainauth) if $authmech eq "PLAIN"; $imap->User($user); $imap->Authuser($authuser); $imap->Password($password); unless ($imap->login()) { my $info = "Error login: [$host] with user [$user] auth"; my $einfo = $imap->LastError || @{$imap->History}[-1]; chomp($einfo); my $error = "$info [$authmech]: $einfo\n"; print $error; # note: duplicating error on stdout/stderr die_clean($error) if ($authmech eq 'LOGIN' or $imap->IsUnconnected() or $authuser); print "Trying LOGIN Auth mechanism on [$host] with user [$user]\n"; $imap->Authmechanism(""); $imap->login() or die_clean("$info [LOGIN]: ", $imap->LastError, "\n"); } print "Success login on [$host] with user [$user] auth [$authmech]\n"; return($imap); } sub plainauth() { my $code = shift; my $imap = shift; my $string = sprintf("%s\x00%s\x00%s", $imap->User, $imap->Authuser, $imap->Password); return encode_base64("$string", ""); } sub server_banner { my $imap = shift; my $banner = $imap->Banner() || "No banner\n"; return $banner; } $debug and print "Host1 capability: ", join(" ", $imap1->capability()), "\n"; $debug and print "Host2 capability: ", join(" ", $imap2->capability()), "\n"; die_clean() unless $imap1->IsAuthenticated(); print "host1: state Authenticated\n"; die_clean() unless $imap2->IsAuthenticated(); print "host2: state Authenticated\n"; exit_clean(0) if ($justlogin); $split1 and $imap1->Split($split1); $split2 and $imap2->Split($split2); # # Folder stuff # my (@h1_folders, %requested_folder, @h2_folders, @h2_folders_list, %h2_folders_list, %subscribed_folder, %h2_folders); sub tests_folder_routines { ok( !give_requested_folders() ,"no requested folders" ); ok( !is_requested_folder('folder_foo') ); ok( add_to_requested_folders('folder_foo') ); ok( is_requested_folder('folder_foo') ); ok( !is_requested_folder('folder_NO_EXIST') ); ok( !remove_from_requested_folders('folder_foo'), "removed folder_foo"); ok( !is_requested_folder('folder_foo') ); my @f; ok( @f = add_to_requested_folders('folder_bar', 'folder_toto'), "add result: @f"); ok( is_requested_folder('folder_bar') ); ok( is_requested_folder('folder_toto') ); ok( remove_from_requested_folders('folder_toto') ); ok( !is_requested_folder('folder_toto') ); ok( init_requested_folders() , 'empty requested folders'); ok( !give_requested_folders() , 'no requested folders' ); } sub give_requested_folders { return(keys(%requested_folder)); } sub init_requested_folders { %requested_folder = (); return(1); } sub is_requested_folder { my ( $folder ) = @_; defined( $requested_folder{ $folder } ); } sub add_to_requested_folders { my @wanted_folders = @_; foreach my $folder ( @wanted_folders ) { ++$requested_folder{ $folder }; } return( keys( %requested_folder ) ); } sub remove_from_requested_folders { my @wanted_folders = @_; foreach my $folder (@wanted_folders) { delete $requested_folder{$folder}; } return( keys(%requested_folder) ); } # Make a hash of subscribed folders in source server. map { $subscribed_folder{$_} = 1 } $imap1->subscribed(); if (scalar(@folder) or $subscribed or scalar(@folderrec)) { # folders given by option --folder if (scalar(@folder)) { add_to_requested_folders(@folder); } # option --subscribed if ($subscribed) { add_to_requested_folders(keys (%subscribed_folder)); } # option --folderrec if (scalar(@folderrec)) { foreach my $folderrec (@folderrec) { add_to_requested_folders($imap1->folders($folderrec)); } } } else { # no include, no folder/subscribed/folderrec options => all folders if (not scalar(@include)) { my @all_source_folders = sort $imap1->folders(); add_to_requested_folders(@all_source_folders); } } # consider (optional) includes and excludes if (scalar(@include)) { my @all_source_folders = sort $imap1->folders(); foreach my $include (@include) { my @included_folders = grep /$include/, @all_source_folders; add_to_requested_folders(@included_folders); print "Including folders matching pattern '$include': @included_folders\n"; } } if (scalar(@exclude)) { foreach my $exclude (@exclude) { my @requested_folder = sort(keys(%requested_folder)); my @excluded_folders = grep /$exclude/, @requested_folder; remove_from_requested_folders(@excluded_folders); print "Excluding folders matching pattern '$exclude': @excluded_folders\n"; } } # Remove no selectable folders foreach my $folder (keys(%requested_folder)) { if ( not $imap1->selectable($folder)) { print "Warning: ignoring folder $folder because it is not selectable\n"; remove_from_requested_folders($folder); } } my @requested_folder = sort(keys(%requested_folder)); @h1_folders = @requested_folder; sub compare_lists { my ($list_1_ref, $list_2_ref) = @_; return(-1) if ((not defined($list_1_ref)) and defined($list_2_ref)); return(0) if ((not defined($list_1_ref)) and not defined($list_2_ref)); # end if no list return(1) if (not defined($list_2_ref)); # end if only one list if (not ref($list_1_ref)) {$list_1_ref = [$list_1_ref]}; if (not ref($list_2_ref)) {$list_2_ref = [$list_2_ref]}; my $last_used_indice = -1; #print "\$#$list_1_ref:", $#$list_1_ref, "\n"; #print "\$#$list_2_ref:", $#$list_2_ref, "\n"; ELEMENT: foreach my $indice ( 0 .. $#$list_1_ref ) { $last_used_indice = $indice; # End of list_2 return 1 if ($indice > $#$list_2_ref); my $element_list_1 = $list_1_ref->[$indice]; my $element_list_2 = $list_2_ref->[$indice]; my $balance = $element_list_1 cmp $element_list_2 ; next ELEMENT if ($balance == 0) ; return $balance; } # each element equal until last indice of list_1 return -1 if ($last_used_indice < $#$list_2_ref); # same size, each element equal return 0 } sub tests_compare_lists { my $empty_list_ref = []; ok( 0 == compare_lists() , 'compare_lists, no args'); ok( 0 == compare_lists(undef) , 'compare_lists, undef = nothing'); ok( 0 == compare_lists(undef, undef) , 'compare_lists, undef = undef'); ok(-1 == compare_lists(undef , []) , 'compare_lists, undef < []'); ok(-1 == compare_lists(undef , [1]) , 'compare_lists, undef < [1]'); ok(-1 == compare_lists(undef , [0]) , 'compare_lists, undef < [0]'); ok(+1 == compare_lists([]) , 'compare_lists, [] > nothing'); ok(+1 == compare_lists([], undef) , 'compare_lists, [] > undef'); ok( 0 == compare_lists([] , []) , 'compare_lists, [] = []'); ok(-1 == compare_lists([] , [1]) , 'compare_lists, [] < [1]'); ok(+1 == compare_lists([1] , []) , 'compare_lists, [1] > []'); ok( 0 == compare_lists([1], 1 ) , "compare_lists, [1] = 1 ") ; ok( 0 == compare_lists( 1 , [1]) , "compare_lists, 1 = [1]") ; ok( 0 == compare_lists( 1 , 1 ) , "compare_lists, 1 = 1 ") ; ok(-1 == compare_lists( 0 , 1 ) , "compare_lists, 0 < 1 ") ; ok(-1 == compare_lists(-1 , 0 ) , "compare_lists, -1 < 0 ") ; ok(-1 == compare_lists( 1 , 2 ) , "compare_lists, 1 < 2 ") ; ok(+1 == compare_lists( 2 , 1 ) , "compare_lists, 2 > 1 ") ; ok( 0 == compare_lists([1,2], [1,2]) , "compare_lists, [1,2] = [1,2]") ; ok(-1 == compare_lists([1], [1,2]) , "compare_lists, [1] < [1,2]") ; ok(-1 == compare_lists([1], [1,1]) , "compare_lists, [1] < [1,1]") ; ok(+1 == compare_lists([1, 1], [1]) , "compare_lists, [1, 1] > [1]") ; ok( 0 == compare_lists([1 .. 20_000] , [1 .. 20_000]) , "compare_lists, [1..20_000] = [1..20_000]") ; ok(-1 == compare_lists([1], [3]) , 'compare_lists, [1] < [3]') ; ok( 0 == compare_lists([2], [2]) , 'compare_lists, [0] = [2]') ; ok(+1 == compare_lists([3], [1]) , 'compare_lists, [3] > [1]') ; ok(-1 == compare_lists(["a"], ["b"]) , 'compare_lists, ["a"] < ["b"]') ; ok( 0 == compare_lists(["a"], ["a"]) , 'compare_lists, ["a"] = ["a"]') ; ok( 0 == compare_lists(["ab"], ["ab"]) , 'compare_lists, ["ab"] = ["ab"]') ; ok(+1 == compare_lists(["b"], ["a"]) , 'compare_lists, ["b"] > ["a"]') ; ok(-1 == compare_lists(["a"], ["aa"]) , 'compare_lists, ["a"] < ["aa"]') ; ok(-1 == compare_lists(["a"], ["a", "a"]), 'compare_lists, ["a"] < ["a", "a"]') ; ok( 0 == compare_lists([split(" ", "a b")], ["a", "b"]), 'compare_lists, split') ; ok( 0 == compare_lists([sort split(" ", "b a")], ["a", "b"]), 'compare_lists, sort split') ; } my($h1_sep,$h2_sep); # what are the private folders separators for each server ? $debug and print "Getting separators\n"; $h1_sep = get_separator($imap1, $sep1, "--sep1"); $h2_sep = get_separator($imap2, $sep2, "--sep2"); #my $h1_namespace = $imap1->namespace(); #my $h2_namespace = $imap2->namespace(); #$debug and print "Host1 namespace:\n", Data::Dumper->Dump([$h1_namespace]); #$debug and print "Host2 namespace:\n", Data::Dumper->Dump([$h2_namespace]); my($h1_prefix,$h2_prefix); $h1_prefix = get_prefix($imap1, $prefix1, "--prefix1"); $h2_prefix = get_prefix($imap2, $prefix2, "--prefix2"); sub get_prefix { my($imap, $prefix_in, $prefix_opt) = @_; my($prefix_out); $debug and print "Getting prefix namespace\n"; if (defined($prefix_in)) { print "Using [$prefix_in] given by $prefix_opt\n"; $prefix_out = $prefix_in; return($prefix_out); } $debug and print "Calling namespace capability\n"; if ($imap->has_capability("namespace")) { my $r_namespace = $imap->namespace(); $prefix_out = $r_namespace->[0][0][0]; return($prefix_out); } else{ print "No NAMESPACE capability in imap server ", $imap->Server(),"\n", "Give the prefix namespace with the $prefix_opt option\n"; exit_clean(1); } } sub get_separator { my($imap, $sep_in, $sep_opt) = @_; my($sep_out); if ($sep_in) { print "Using [$sep_in] given by $sep_opt\n"; $sep_out = $sep_in; return($sep_out); } $debug and print "Calling namespace capability\n"; if ($imap->has_capability("namespace")) { $sep_out = $imap->separator(); return($sep_out) if defined $sep_out; warn "NAMESPACE request failed for ", $imap->Server(), ": ", $imap->LastError, "\n"; exit_clean(1); } else{ warn "No NAMESPACE capability in imap server ", $imap->Server(),"\n", "Give the separator character with the $sep_opt option\n"; exit_clean(1); } } print "Host1 separator and prefix: [$h1_sep][$h1_prefix]\n"; print "Host2 separator and prefix: [$h2_sep][$h2_prefix]\n"; sub foldersizes { my ($side, $imap, $folders_r) = @_; my $tot = 0; my $tmess = 0; my @folders = @{$folders_r}; print "++++ Calculating sizes ++++\n"; foreach my $folder (@folders) { my $stot = 0; my $smess = 0; printf("$side Folder %-35s", "[$folder]"); unless($imap->exists($folder)) { print("does not exist yet\n"); next; } unless ($imap->select($folder)) { warn "$side Folder $folder: Could not select: ", $imap->LastError, "\n"; $nb_errors++; next; } if (defined($maxage) or defined($minage)) { # The pb is fetch_hash() can only be applied on ALL messages my @msgs = select_msgs($imap); $smess = scalar(@msgs); foreach my $m (@msgs) { my $s = $imap->size($m) or warn "Could not find size of message $m: $@\n"; $stot += $s; } } else{ my $hashref = {}; $smess = $imap->message_count(); unless ($smess == 0) { #$imap->Ranges(1); $imap->fetch_hash("RFC822.SIZE",$hashref) or die_clean("$@"); #$imap->Ranges(0); #print map {$hashref->{$_}->{"RFC822.SIZE"}, " "} keys %$hashref; map {$stot += $hashref->{$_}->{"RFC822.SIZE"}} keys %$hashref; } } printf(" Size: %9s", $stot); printf(" Messages: %5s\n", $smess); $tot += $stot; $tmess += $smess; } print "Total size: $tot\n"; print "Total messages: $tmess\n"; print "Time: ", timenext(), " s\n"; } foreach my $h1_fold (@h1_folders) { my $h2_fold; $h2_fold = imap2_folder_name($h1_fold); $h2_folders{$h2_fold}++; } @h2_folders = sort keys(%h2_folders); if ($foldersizes) { foldersizes("Host1", $imap1, \@h1_folders); foldersizes("Host2", $imap2, \@h2_folders); } sub timenext { my ($timenow, $timerel); # $timebefore is global, beurk ! $timenow = time; $timerel = $timenow - $timebefore; $timebefore = $timenow; return($timerel); } exit_clean(0) if ($justfoldersizes); # needed for setting flags my $imap2hasuidplus = $imap2->has_capability("UIDPLUS"); @h2_folders_list = sort @{$imap2->folders()}; foreach my $folder (@h2_folders_list) { $h2_folders_list{$folder}++; } print "++++ Listing folders ++++\n", "Host1 folders list:\n", map("[$_]\n",@h1_folders),"\n", "Host2 folders list:\n", map("[$_]\n",@h2_folders_list),"\n"; print "Host1 subscribed folders list: ", map("[$_] ", sort keys(%subscribed_folder)), "\n" if ($subscribed); sub separator_invert { # The separator we hope we'll never encounter: 00000000 my $o_sep="\000"; my($h1_fold, $h1_sep, $h2_sep) = @_; my $h2_fold = $h1_fold; $h2_fold =~ s@\Q$h2_sep@$o_sep@g; $h2_fold =~ s@\Q$h1_sep@$h2_sep@g; $h2_fold =~ s@\Q$o_sep@$h1_sep@g; return($h2_fold); } sub tests_imap2_folder_name { $h1_prefix = $h2_prefix = ''; $h1_sep = '/'; $h2_sep = '.'; $debug and print "prefix1: [$h1_prefix] prefix2: [$h2_prefix] sep1:[$h1_sep] sep2:[$h2_sep] "; ok('' eq imap2_folder_name(''), 'imap2_folder_name: empty string'); ok('blabla' eq imap2_folder_name('blabla'), 'imap2_folder_name: blabla'); ok('spam.spam' eq imap2_folder_name('spam/spam'), 'imap2_folder_name: spam/spam'); ok('spam/spam' eq imap2_folder_name('spam.spam'), 'imap2_folder_name: spam.spam'); ok('spam.spam/spam' eq imap2_folder_name('spam/spam.spam'), 'imap2_folder_name: spam/spam.spam'); @regextrans2 = ('s,/,X,g'); ok('' eq imap2_folder_name(''), 'imap2_folder_name: empty string [s,/,X,g]'); ok('blabla' eq imap2_folder_name('blabla'), 'imap2_folder_name: blabla [s,/,X,g]'); ok('spam.spam' eq imap2_folder_name('spam/spam'), 'imap2_folder_name: spam/spam [s,/,X,g]'); ok('spamXspam' eq imap2_folder_name('spam.spam'), 'imap2_folder_name: spam.spam [s,/,X,g]'); ok('spam.spamXspam' eq imap2_folder_name('spam/spam.spam'), 'imap2_folder_name: spam/spam.spam [s,/,X,g]'); @regextrans2 = ('s, ,_,g'); ok('blabla' eq imap2_folder_name('blabla'), 'imap2_folder_name: blabla [s, ,_,g]'); ok('bla_bla' eq imap2_folder_name('bla bla'), 'imap2_folder_name: blabla [s, ,_,g]'); @regextrans2 = ('s,(.*),\U$1,'); ok('BLABLA' eq imap2_folder_name('blabla'), 'imap2_folder_name: blabla [s,\U(.*)\E,$1,]'); } sub imap2_folder_name { my ($h2_fold); my ($x_fold) = @_; # first we remove the prefix $x_fold =~ s/^\Q$h1_prefix\E//; $debug and print "removed host1 prefix: [$x_fold]\n"; $h2_fold = separator_invert($x_fold,$h1_sep, $h2_sep); $debug and print "inverted separators: [$h2_fold]\n"; # Adding the prefix supplied by namespace or the --prefix2 option $h2_fold = $h2_prefix . $h2_fold unless(($h2_prefix eq "INBOX" . $h2_sep) and ($h2_fold =~ m/^INBOX$/i)); $debug and print "added host2 prefix: [$h2_fold]\n"; # Transforming the folder name by the --regextrans2 option(s) foreach my $regextrans2 (@regextrans2) { my $h2_fold_before = $h2_fold; eval("\$h2_fold =~ $regextrans2"); $debug and print "[$h2_fold_before] -> [$h2_fold] using re [$regextrans2]\n"; die_clean("error: eval regextrans2 '$regextrans2': $@\n") if $@; } return($h2_fold); } sub tests_flags_regex { my $string; ok('' eq flags_regex(''), "flags_regex, null string ''"); ok('\Seen NonJunk $Spam' eq flags_regex('\Seen NonJunk $Spam'), 'flags_regex, nothing to do'); ok('\Seen NonJunk $Spam' eq flags_regex('\Seen NonJunk $Spam'), 'flags_regex,'); @regexflag = ('s/NonJunk//g'); ok('\Seen $Spam' eq flags_regex('\Seen NonJunk $Spam'), "flags_regex, remove NonJunk: 's/NonJunk//g'"); @regexflag = ('s/\$Spam//g'); ok('\Seen NonJunk ' eq flags_regex('\Seen NonJunk $Spam'), 'flags_regex, remove $Spam: '."'s/\$Spam//g'"); @regexflag = ('s/\\\\Seen//g'); ok(' NonJunk $Spam' eq flags_regex('\Seen NonJunk $Spam'), 'flags_regex, remove \Seen: '. "'s/\\\\\\\\Seen//g'"); @regexflag = ('s/(\s|^)[^\\\\]\w+//g'); ok('\Seen \Middle \End' eq flags_regex('\Seen NonJunk \Middle $Spam \End'), 'flags_regex, only \word [' . flags_regex('\Seen NonJunk \Middle $Spam \End'.']')); ok(' \Seen \Middle \End1' eq flags_regex('Begin \Seen NonJunk \Middle $Spam \End1 End'), 'flags_regex, only \word [' . flags_regex('Begin \Seen NonJunk \Middle $Spam \End1 End'.']')); @regexflag = ('s/.*?(Keep1|Keep2|Keep3)/$1 /g'); ok('Keep1 Keep2 ReB' eq flags_regex('ReA Keep1 REM Keep2 ReB'), "Keep only regex"); #ok('Keep1 Keep2' eq flags_regex('Keep1 Keep2 Remove1'), "Keep only regex"); ok('Keep1 Keep2 ' eq flags_regex('REM REM Keep1 Keep2'), "Keep only regex"); ok('Keep1 Keep2 ' eq flags_regex('Keep1 REM REM Keep2'), "Keep only regex"); ok('Keep1 Keep2 ' eq flags_regex('REM Keep1 REM REM Keep2'), "Keep only regex"); ok('Keep1 Keep2 ' eq flags_regex('Keep1 Keep2'), "Keep only regex"); ok('Keep1 ' eq flags_regex('REM Keep1'), "Keep only regex"); @regexflag = ('s/(Keep1|Keep2|Keep3) (?!(Keep1|Keep2|Keep3)).*/$1 /g'); ok('Keep1 Keep2 ' eq flags_regex('Keep1 Keep2 ReB'), "Keep only regex"); ok('Keep1 Keep2 ' eq flags_regex('Keep1 Keep2 REM REM REM'), "Keep only regex"); ok('Keep2 ' eq flags_regex('Keep2 REM REM REM'), "Keep only regex"); #ok('' eq flags_regex('REM REM'), "Keep only regex"); @regexflag = ('s/.*?(Keep1|Keep2|Keep3)/$1 /g', 's/(Keep1|Keep2|Keep3) (?!(Keep1|Keep2|Keep3)).*/$1 /g'); ok('Keep1 Keep2 ' eq flags_regex('REM Keep1 REM Keep2 REM'), "Keep only regex"); ok('Keep1 Keep2 ' eq flags_regex('Keep1 REM Keep2 REM'), "Keep only regex"); ok('Keep1 Keep2 ' eq flags_regex('REM Keep1 Keep2 REM'), "Keep only regex"); ok('Keep1 Keep2 ' eq flags_regex('REM Keep1 REM Keep2'), "Keep only regex"); ok('Keep1 Keep2 Keep3 ' eq flags_regex('REM Keep1 REM Keep2 REM REM Keep3 REM'), "Keep only regex"); ok('Keep1 ' eq flags_regex('REM REM Keep1 REM REM REM '), "Keep only regex"); ok('Keep1 Keep3 ' eq flags_regex('RE1 Keep1 RE2 Keep3 RE3 RE4 RE5 '), "Keep only regex"); @regexflag = ('s/(.*)/$1 jrdH8u/'); ok('REM REM REM REM REM jrdH8u' eq flags_regex('REM REM REM REM REM'), "Keep only regex 's/(.*)/\$1 jrdH8u/'"); @regexflag = ('s/jrdH8u *//'); ok('REM REM REM REM REM ' eq flags_regex('REM REM REM REM REM jrdH8u'), "Keep only regex s/jrdH8u *//"); @regexflag = ( 's/(.*)/$1 jrdH8u/', 's/.*?(Keep1|Keep2|Keep3|jrdH8u)/$1 /g', 's/(Keep1|Keep2|Keep3|jrdH8u) (?!(Keep1|Keep2|Keep3|jrdH8u)).*/$1 /g', 's/jrdH8u *//' ); ok('Keep1 Keep2 ' eq flags_regex('REM Keep1 REM Keep2 REM'), "Keep only regex 'REM Keep1 REM Keep2 REM'"); ok('Keep1 Keep2 ' eq flags_regex('Keep1 REM Keep2 REM'), "Keep only regex"); ok('Keep1 Keep2 ' eq flags_regex('REM Keep1 Keep2 REM'), "Keep only regex"); ok('Keep1 Keep2 ' eq flags_regex('REM Keep1 REM Keep2'), "Keep only regex"); ok('Keep1 Keep2 Keep3 ' eq flags_regex('REM Keep1 REM Keep2 REM REM Keep3 REM'), "Keep only regex"); ok('Keep1 ' eq flags_regex('REM REM Keep1 REM REM REM '), "Keep only regex"); ok('Keep1 Keep3 ' eq flags_regex('RE1 Keep1 RE2 Keep3 RE3 RE4 RE5 '), "Keep only regex"); ok('' eq flags_regex('REM REM REM REM REM'), "Keep only regex"); @regexflag = ( 's/(.*)/$1 jrdH8u/', 's/.*?(\\\\Seen|\\\\Answered|\\\\Flagged|\\\\Deleted|\\\\Draft|jrdH8u)/$1 /g', 's/(\\\\Seen|\\\\Answered|\\\\Flagged|\\\\Deleted|\\\\Draft|jrdH8u) (?!(\\\\Seen|\\\\Answered|\\\\Flagged|\\\\Deleted|\\\\Draft|jrdH8u)).*/$1 /g', 's/jrdH8u *//' ); ok('\\Deleted \\Answered ' eq flags_regex('Blabla $Junk \\Deleted machin \\Answered truc'), "Keep only regex: Exchange case"); ok('' eq flags_regex(''), "Keep only regex: Exchange case, null string"); ok('' eq flags_regex('Blabla $Junk machin truc'), "Keep only regex: Exchange case, no accepted flags "); ok('\\Deleted \\Answered \\Draft \\Flagged ' eq flags_regex('\\Deleted \\Answered \\Draft \\Flagged '), "Keep only regex: Exchange case"); @regexflag = ( 's/.*?(?:(\\\\(?:Answered|Flagged|Deleted|Seen|Draft)\s?)|$)/defined($1)?$1:q()/eg' ); ok('\\Deleted \\Answered ' eq flags_regex('Blabla \$Junk \\Deleted machin \\Answered truc'), "Keep only regex: Exchange case (Phil)"); ok('' eq flags_regex(''), "Keep only regex: Exchange case, null string (Phil)"); ok('' eq flags_regex('Blabla $Junk machin truc'), "Keep only regex: Exchange case, no accepted flags (Phil)"); ok('\\Deleted \\Answered \\Draft \\Flagged ' eq flags_regex('\\Deleted \\Answered \\Draft \\Flagged '), "Keep only regex: Exchange case (Phil)"); } sub flags_regex { my ($h1_flags) = @_; foreach my $regexflag (@regexflag) { my $h1_flags_orig = $h1_flags; $debug and print "eval \$h1_flags =~ $regexflag\n"; eval("\$h1_flags =~ $regexflag"); die_clean("error: eval regexflag '$regexflag': $@\n") if $@; $debug and print "regexflag $regexflag [$h1_flags_orig] -> [$h1_flags]\n"; } return($h1_flags); } sub acls_sync { my($h1_fold, $h2_fold) = @_; if ($syncacls) { my $h1_hash = $imap1->getacl($h1_fold) or warn "Could not getacl for $h1_fold: $@\n"; my $h2_hash = $imap2->getacl($h2_fold) or warn "Could not getacl for $h2_fold: $@\n"; my %users = map({ ($_, 1) } (keys(%$h1_hash), keys(%$h2_hash))); foreach my $user (sort(keys(%users))) { my $acl = $h1_hash->{$user} || "none"; print "acl $user: [$acl]\n"; next if ($h1_hash->{$user} && $h2_hash->{$user} && $h1_hash->{$user} eq $h2_hash->{$user}); unless ($dry) { print "setting acl $h2_fold $user $acl\n"; $imap2->setacl($h2_fold, $user, $acl) or warn "Could not set acl: $@\n"; } } } } sub tests_permanentflags { my $string; ok('' eq permanentflags(' * OK [PERMANENTFLAGS (\* \Draft \Answered)] Limited'), 'permanentflags \*'); ok('\Draft \Answered' eq permanentflags(' * OK [PERMANENTFLAGS (\Draft \Answered)] Limited'), 'permanentflags \Draft \Answered'); ok('\Draft \Answered' eq permanentflags('Blabla', ' * OK [PERMANENTFLAGS (\Draft \Answered)] Limited', 'Blabla'), 'permanentflags \Draft \Answered' ); ok('' eq permanentflags('Blabla'), 'permanentflags nothing'); } sub permanentflags { my @lines = @_; foreach my $line (@lines) { if ($line =~ m{\[PERMANENTFLAGS \(([^)]+?)\)\]}) { #print "%%%$1%%%\n"; my $permanentflags = $1; if ($permanentflags =~ m{\\\*}) { $permanentflags = ''; } return($permanentflags); }; } } sub tests_flags_filter { ok( '\Seen' eq flags_filter('\Seen', '\Draft \Seen \Answered'), 'flags_filter ' ); ok( '' eq flags_filter('\Seen', '\Draft \Answered'), 'flags_filter ' ); ok( '\Seen' eq flags_filter('\Seen', '\Seen'), 'flags_filter ' ); ok( '\Seen' eq flags_filter('\Seen', ' \Seen '), 'flags_filter ' ); ok( '\Seen \Draft' eq flags_filter('\Seen \Draft', '\Draft \Seen \Answered'), 'flags_filter ' ); ok( '\Seen \Draft' eq flags_filter('\Seen \Draft', ' \Draft \Seen \Answered '), 'flags_filter ' ); } sub flags_filter { my($flags, $allowed_flags) = @_; my @flags = split(/\s+/, $flags); my %allowed_flags = map { $_ => 1 } split(' ', $allowed_flags ); my @flags_out = map { exists $allowed_flags{$_} ? $_ : () } @flags; my $flags_out = join(' ', @flags_out); #print "%%%$flags_out%%%\n"; return($flags_out); } print "++++ Looping on each folder ++++\n"; #sleep 10; FOLDER: foreach my $h1_fold (@h1_folders) { last FOLDER if $imap1->IsUnconnected(); last FOLDER if $imap2->IsUnconnected(); my $h2_fold; print "Host1 Folder [$h1_fold]\n"; $h2_fold = imap2_folder_name($h1_fold); print "Host2 Folder [$h2_fold]\n"; unless ($imap1->select($h1_fold)) { warn "Host1 Folder $h1_fold: Could not select: ", $imap1->LastError, "\n"; $nb_errors++; next FOLDER; } if ( ! exists($h2_folders_list{$h2_fold})) { print "Host2 folder $h2_fold does not exist\n"; print "Creating folder [$h2_fold]\n"; unless ($dry){ unless ($imap2->create($h2_fold)){ warn "Couldn't create [$h2_fold]: ", $imap2->LastError,"\n"; $nb_errors++; next FOLDER; } } else{ next FOLDER; } } acls_sync($h1_fold, $h2_fold); unless ($imap2->select($h2_fold)) { warn "Host2 folder $h2_fold: Could not select: ", $imap2->LastError, "\n"; $nb_errors++; next FOLDER; } my @select_results = $imap2->Results(); #print "%%% @select_results\n"; my $permanentflags2 = permanentflags(@select_results); if ($expunge){ print "Expunging host1 $h1_fold\n"; unless($dry) { $imap1->expunge() }; #print "Expunging host2 $h2_fold\n"; #unless($dry) { $imap2->expunge() }; } if (($subscribe and exists $subscribed_folder{$h1_fold}) or $subscribe_all) { print "Subscribing to folder $h2_fold on destination server\n"; unless($dry) { $imap2->subscribe($h2_fold) }; } next FOLDER if ($justfolders); last FOLDER if $imap1->IsUnconnected(); last FOLDER if $imap2->IsUnconnected(); my @h1_msgs = select_msgs($imap1); $debug and print "LIST Host1: ", scalar(@h1_msgs), " messages [@h1_msgs]\n"; # internal dates on host2 are after the ones on host1 # normally... my @h2_msgs = select_msgs($imap2); $debug and print "LIST Host2: ", scalar(@h2_msgs), " messages [@h2_msgs]\n"; my %h1_hash = (); my %h2_hash = (); #print "++++ Using cache ++++\n"; print "++++ Host1 [$h1_fold] parsing headers ++++\n"; last FOLDER if $imap1->IsUnconnected(); last FOLDER if $imap2->IsUnconnected(); my ($h1_heads, $h1_fir) = ({}, {}); $h1_heads = $imap1->parse_headers([@h1_msgs], @useheader) if (@h1_msgs); $debug and print "Time headers: ", timenext(), " s\n"; last FOLDER if $imap1->IsUnconnected(); $h1_fir = $imap1->fetch_hash("FLAGS", "INTERNALDATE", "RFC822.SIZE") if (@h1_msgs); $debug and print "Time fir: ", timenext(), " s\n"; unless ($h1_fir) { warn "Host1 Folder $h1_fold: Could not fetch_hash ", scalar(@h1_msgs), " msgs: ", $imap1->LastError, "\n"; $nb_errors++; next FOLDER; } last FOLDER if $imap1->IsUnconnected(); my @h1_msgs_duplicate; foreach my $m (@h1_msgs) { my $rc = parse_header_msg($imap1, $m, $h1_heads, $h1_fir, "F", \%h1_hash); if (! defined($rc)) { my $h1_size = $h1_fir->{$m}->{"RFC822.SIZE"} || 0; print "+ Skipping msg #$m:$h1_size on host1 folder $h1_fold (no header so we ignore this message)\n"; $total_bytes_skipped += $h1_size; $nb_msg_skipped += 1; $h1_nb_msg_noheader +=1; } elsif(0 == $rc) { # duplicate push(@h1_msgs_duplicate, $m); # duplicate, same id same size? my $h1_size = $h1_fir->{$m}->{"RFC822.SIZE"} || 0; $nb_msg_skipped += 1; $h1_total_bytes_duplicate += $h1_size; $h1_nb_msg_duplicate += 1; } } $debug and print "Time parsing headers on host1: ", timenext(), " s\n"; print "++++ Host2 [$h2_fold] parsing headers ++++\n"; my ($h2_heads, $h2_fir) = ({}, {}); $h2_heads = $imap2->parse_headers([@h2_msgs], @useheader) if (@h2_msgs); $debug and print "Time headers: ", timenext(), " s\n"; last FOLDER if $imap2->IsUnconnected(); $h2_fir = $imap2->fetch_hash("FLAGS", "INTERNALDATE", "RFC822.SIZE") if (@h2_msgs); $debug and print "Time fir: ", timenext(), " s\n"; last FOLDER if $imap2->IsUnconnected(); my @h2_msgs_duplicate; foreach my $m (@h2_msgs) { my $rc = parse_header_msg($imap2, $m, $h2_heads, $h2_fir, "T", \%h2_hash); if (! defined($rc)) { my $h2_size = $h2_fir->{$m}->{"RFC822.SIZE"} || 0; print "+ Skipping msg #$m:$h2_size in host2 folder $h2_fold (no header so we ignore this message)\n"; $h2_nb_msg_noheader += 1 ; } elsif(0 == $rc) { # duplicate my $h2_size = $h2_fir->{$m}->{"RFC822.SIZE"} || 0; $h2_nb_msg_duplicate += 1; $h2_total_bytes_duplicate += $h2_size; push(@h2_msgs_duplicate, $m); } } $debug and print "Time parsing headers on host2: ", timenext(), " s\n"; print "++++ Verifying [$h1_fold] -> [$h2_fold] ++++\n"; # messages in host1 that are not good in host2 my @h1_hash_keys_sorted_by_uid = sort {$h1_hash{$a}{'m'} <=> $h1_hash{$b}{'m'}} keys(%h1_hash); #print map { $h1_hash{$_}{'m'} . " "} @h1_hash_keys_sorted_by_uid; my @h2_hash_keys_sorted_by_uid = sort {$h2_hash{$a}{'m'} <=> $h2_hash{$b}{'m'}} keys(%h2_hash); if($delete2) { my @h2_expunge; foreach my $m_id (@h2_hash_keys_sorted_by_uid) { #print "$m_id "; unless (exists($h1_hash{$m_id})) { my $h2_msg = $h2_hash{$m_id}{'m'}; my $h2_flags = $h2_hash{$m_id}{'F'} || ""; my $isdel = $h2_flags =~ /\B\\Deleted\b/ ? 1 : 0; print "deleting message [$m_id] #$h2_msg in host2 folder $h2_fold\n" if ! $isdel; push(@h2_expunge, $h2_msg) if $uidexpunge2; unless ($dry or $isdel) { $imap2->delete_message($h2_msg); $h2_nb_msg_deleted += 1; } } } foreach my $h2_msg (@h2_msgs_duplicate) { print "deleting message [duplicate] #$h2_msg in host2 folder $h2_fold\n"; push(@h2_expunge, $h2_msg) if $uidexpunge2; unless ($dry) { $imap2->delete_message($h2_msg); $h2_nb_msg_deleted += 1; } } my $cnt = scalar @h2_expunge; if(@h2_expunge and !$imap2->can("uidexpunge")) { warn "uidexpunge not supported (< IMAPClient 3.17)\n"; } elsif(@h2_expunge) { print "uidexpunge $cnt message(s)\n"; $imap2->uidexpunge(\@h2_expunge) if !$dry; } } MESS: foreach my $m_id (@h1_hash_keys_sorted_by_uid) { my $h1_size = $h1_hash{$m_id}{'s'}; my $h1_msg = $h1_hash{$m_id}{'m'}; my $h1_idate = $h1_hash{$m_id}{'D'}; if (defined $maxsize and $h1_size > $maxsize) { print "+ Skipping msg #$h1_msg:$h1_size in host1 folder $h1_fold (exceeds maxsize limit $maxsize bytes)\n"; $total_bytes_skipped += $h1_size; $nb_msg_skipped += 1; next MESS; } $debug and print "+ key $m_id #$h1_msg\n"; unless (exists($h2_hash{$m_id})) { print "+ NO msg #$h1_msg [$m_id] in $h2_fold\n"; # copy print "+ Copying msg #$h1_msg:$h1_size to folder $h2_fold\n"; last FOLDER if $imap1->IsUnconnected(); last FOLDER if $imap2->IsUnconnected(); my $string; $string = $imap1->message_string($h1_msg); unless (defined($string)) { warn "Could not fetch message #$h1_msg from $h1_fold: ", $imap1->LastError, "\n"; $nb_errors++; $total_bytes_error += $h1_size; next MESS; } #my $message_file = "tmp_imapsync_$$"; #$imap1->select($h1_fold); #unlink($message_file); #$imap1->message_to_file($message_file, $h1_msg) or do { # warn "Could not put message #$h1_msg to file $message_file", # $imap1->LastError; # $nb_errors++; # $total_bytes_error += $h1_size; # next MESS; #}; #$string = file_to_string($message_file); #print "AAA1[$string]ZZZ\n"; #unlink($message_file); if (@regexmess) { $string = regexmess($string); #string_to_file($string, $message_file); } sub tests_regexmess { ok("blabla" eq regexmess("blabla"), "regexmess, no regexmess, nothing to do"); @regexmess = ('s/p/Z/g'); ok("ZoZoZo" eq regexmess("popopo"), "regexmess, s/p/Z/g"); @regexmess = 's{c}{C}gxms'; ok("H1: abC\nH2: Cde\n\nBody abC" eq regexmess("H1: abc\nH2: cde\n\nBody abc"), "regexmess, c->C"); @regexmess = 's{\AFrom\ }{From:}gxms'; ok( '' eq regexmess(''), 'From mbox 1 add colon blank'); ok( 'From:' eq regexmess('From '), 'From mbox 2 add colo'); ok( "\n" . 'From ' eq regexmess("\n" . 'From '), 'From mbox 3 add colo'); ok( "From: zzz\n" . 'From ' eq regexmess("From zzz\n" . 'From '), 'From mbox 4 add colo'); @regexmess = 's{\AFrom\ [^\n]*(\n)?}{}gxms'; ok( '' eq regexmess(''), 'From mbox 1 remove, blank'); ok( '' eq regexmess('From '), 'From mbox 2 remove'); ok( "\n" . 'From ' eq regexmess("\n" . 'From '), 'From mbox 3 remove'); #print "[", regexmess("From zzz\n" . 'From '), "]"; ok( "" . 'From ' eq regexmess("From zzz\n" . 'From '), 'From mbox 4 remove'); ok( 'Date: Sat, 10 Jul 2010 05:34:45 -0700 From: Hello, Bye.' eq regexmess( 'From zzz Date: Sat, 10 Jul 2010 05:34:45 -0700 From: Hello, Bye.' ), 'From mbox 5 remove'); } sub regexmess { my ($string) = @_; foreach my $regexmess (@regexmess) { $debug and print "eval \$string =~ $regexmess\n"; eval("\$string =~ $regexmess"); die_clean("error: eval regexmess '$regexmess': $@\n") if $@; } return($string); } $debug and print "=" x80, "\n", "F message content begin next line\n", $string, "F message content ended on previous line\n", "=" x 80, "\n"; my $d = ""; if ($syncinternaldates) { $d = $h1_idate; $debug and print "internal date from 1: [$d]\n"; $d = good_date($d); $debug and print "internal date from 1: [$d] (fixed)\n"; } if ($idatefromheader) { $d = $imap1->get_header($h1_msg,"Date"); $debug and print "header date from 1: [$d]\n"; $d = good_date($d); $debug and print "header date from 1: [$d] (fixed)\n"; } sub good_date { my ($d) = @_; return($d) if (! $usedatemanip); $d = UnixDate(ParseDate($d), "%d-%b-%Y %H:%M:%S %z"); $d = "\"$d\""; return($d); } my $h1_flags = $h1_hash{$m_id}{'F'} || ""; # RFC 2060: This flag can not be altered by any client $h1_flags =~ s@\\Recent\s?@@gi; $h1_flags = flags_regex($h1_flags) if @regexflag; $h1_flags = flags_filter($h1_flags, $permanentflags2) if ($permanentflags2); my $new_id; print "flags & date from: [$h1_flags][$d]\n"; last FOLDER if $imap1->IsUnconnected(); last FOLDER if $imap2->IsUnconnected(); $d = undef if ($d eq ""); unless ($dry) { if ($OSNAME eq "MSWin32") { $new_id = $imap2->append_string($h2_fold,$string, $h1_flags, $d); } else { # just back to append_string since append_file 3.05 does not work. #$new_id = $imap2->append_file($h2_fold, $message_file, "", $h1_flags, $d); # append_string 3.05 does not work too some times with $d unset. $new_id = $imap2->append_string($h2_fold,$string, $h1_flags, $d); } unless($new_id){ no warnings 'uninitialized'; warn "Couldn't append msg #$h1_msg (Subject:[". $imap1->subject($h1_msg)."]) to folder $h2_fold: ", $imap2->LastError, "\n"; $nb_errors++; $total_bytes_error += $h1_size; next MESS; } else{ # good # $new_id is an id if the IMAP server has the # UIDPLUS capability else just a ref print "Copied msg id [$h1_msg] to folder $h2_fold msg id [$new_id]\n"; $total_bytes_transferred += $h1_size; $nb_msg_transferred += 1; if($delete) { print "Deleting msg #$h1_msg on host1 folder $h1_fold\n"; unless($dry) { $imap1->delete_message($h1_msg); $h1_nb_msg_deleted += 1; last FOLDER if $imap1->IsUnconnected(); $imap1->expunge() if ($expunge); last FOLDER if $imap1->IsUnconnected(); } } } } else{ $nb_msg_skipped_dry_mode += 1; } #unlink($message_file); next MESS; } else{ $debug and print "Message id [$m_id] found in t:$h2_fold\n"; $total_bytes_skipped += $h1_size; $nb_msg_skipped += 1; } $fast and next MESS; #$debug and print "MESSAGE $m_id\n"; my $h2_size = $h2_hash{$m_id}{'s'}; my $h2_msg = $h2_hash{$m_id}{'m'}; # used cached flag values for efficiency my $h1_flags = $h1_hash{$m_id}{'F'} || ""; my $h2_flags = $h2_hash{$m_id}{'F'} || ""; # RFC 2060: This flag can not be altered by any client $h1_flags =~ s@\\Recent\s?@@gi; $h1_flags = flags_regex($h1_flags) if @regexflag; $h1_flags = flags_filter($h1_flags, $permanentflags2) if ($permanentflags2); # compare flags - set flags if there a difference my @h1_flags = sort split(' ', $h1_flags ); my @h2_flags = sort split(' ', $h2_flags ); my $diff = compare_lists(\@h1_flags, \@h2_flags); $diff and $debug and print "Replacing h2 flags($h2_flags) with h1 flags($h1_flags) on msg #$h2_msg in $h2_fold\n"; # This sets flags so flags can be removed with this # When you remove a \Seen flag on host1 you want to it # to be removed on host2. Just add flags is not what # we need most of the time. if (!$dry and $diff and !$imap2->store($h2_msg, "FLAGS.SILENT (@h1_flags)") ) { warn "Could not add flags @h1_flags", " on msg #$h2_msg in $h2_fold: ", $imap2->LastError, "\n"; #$nb_errors++; } last FOLDER if $imap2->IsUnconnected(); $debug and do { my @h2_flags = @{ $imap2->flags($h2_msg) || [] }; last FOLDER if $imap2->IsUnconnected(); print "host1 flags: $h1_flags\n", "host2 flags: @h2_flags\n"; print "Looking dates\n"; #my $h1_idate = $imap1->internaldate($h1_msg); #my $h2_idate = $imap2->internaldate($h2_msg); my $h1_idate = $h1_hash{$m_id}{'D'}; my $h2_idate = $h2_hash{$m_id}{'D'}; print "host1 internal date: $h1_idate\n", "host2 internal date: $h2_idate\n"; #unless ($h1_idate eq $h2_idate) { # print "!!! Dates differ !!!\n"; #} }; unless ($skipsize or ($h1_size == $h2_size)) { # Bad size print "Message $m_id SZ_BAD f:$h1_msg:$h1_size t:$h2_msg:$h2_size\n"; $nb_errors++; } else { # Good $debug and print "Message $m_id SZ_GOOD f:$h1_msg:$h1_size t:$h2_msg:$h2_size\n"; if($delete) { print "Deleting msg #$h1_msg on host1 folder $h1_fold\n"; unless($dry) { $imap1->delete_message($h1_msg); $h1_nb_msg_deleted += 1; $imap1->expunge() if ($expunge); } } } } if ($expunge1){ print "Expunging host1 folder $h1_fold\n"; unless($dry) { $imap1->expunge() }; } if ($expunge2){ print "Expunging host2 folder $h2_fold\n"; unless($dry) { $imap2->expunge() }; } print "Time: ", timenext(), " s\n"; } print "++++ End looping on each folder ++++\n"; # FOLDER loop is exited any time a connection is lost be sure to log it! # Example: # lost_connection($imap1,"host1 [$host1]"); # # can be tested with a "killall /usr/bin/imapd" (or equivalent) in command line. # sub _filter { my $str = shift or return ""; my $sz = 64; my $len = length($str); if ( ! $debug and $len > $sz*2 ) { my $beg = substr($str, 0, $sz); my $end = substr($str, -$sz, $sz); $str = $beg . "..." . $end; } $str =~ s/\012?\015$//; return "(len=$len) " . $str; } sub lost_connection { my($imap, $error_message) = @_; if ( $imap->IsUnconnected() ) { $nb_errors++; my $lcomm = $imap->LastIMAPCommand || ""; my $einfo = $imap->LastError || @{$imap->History}[-1] || ""; # if string is long try reduce to a more reasonable size $lcomm = _filter($lcomm); $einfo = _filter($einfo); warn("error: last command: $lcomm\n") if ($debug && $lcomm); warn("error: lost connection $error_message", $einfo, "\n"); return(1); }else{ return(0); } } $imap1->logout(); $imap2->logout(); my $host1_reconnect_count = $imap1->Reconnect_counter() || 0; my $host2_reconnect_count = $imap2->Reconnect_counter() || 0; $timeend = time(); $timediff = $timeend - $timestart; stats(); exit_clean(1) if($nb_errors); exit_clean(0); # END of main program # subroutines sub imapsync_version { my $rcs = '$Id: imapsync,v 1.340 2010/08/09 00:03:21 gilles Exp gilles $ '; $rcs =~ m/,v (\d+\.\d+)/; my $VERSION = ($1) ? $1: "UNKNOWN"; return($VERSION); } sub check_lib_version { $debug and print "IMAPClient $Mail::IMAPClient::VERSION\n"; if ($Mail::IMAPClient::VERSION eq '2.2.9') { override_imapclient(); return(1); } else{ # 3.x.x is no longer buggy with imapsync. if ($allow3xx) { return(1); }else{ return(0); } } } sub modules_VERSION { my @list_version; foreach my $module (qw( Mail::IMAPClient IO::Socket IO::Socket::SSL Digest::MD5 Digest::HMAC_MD5 Term::ReadKey Date::Manip)) { my $v = "?"; if (eval "require $module") { # module is here $v = eval "\$${module}::VERSION"; }else{ # no module $v = "?"; } #print ("$module ", $v, "\n"); push (@list_version, sprintf("%-20s %s\n", $module, $v)); } return(@list_version); } # Construct a command line copy with passwords replaced by MASKED. sub command_line_nopassword { my @argv_copy = @_; my @argv_nopassword; while (@argv_copy) { my $arg = shift(@argv_copy); # option name or value if ($arg =~ m/-password[12]/) { shift(@argv_copy); # password value push(@argv_nopassword, $arg, "MASKED"); # option name and fake value }else{ push(@argv_nopassword, $arg); # same option or value } } return("@argv_nopassword"); } sub tests_command_line_nopassword { ok('' eq command_line_nopassword(), 'command_line_nopassword void'); ok('--blabla' eq command_line_nopassword('--blabla'), 'command_line_nopassword --blabla'); #print command_line_nopassword((qw{ --password1 secret1 })), "\n"; ok('--password1 MASKED' eq command_line_nopassword(qw{ --password1 secret1}), 'command_line_nopassword --password1'); ok('--blabla --password1 MASKED --blibli' eq command_line_nopassword(qw{ --blabla --password1 secret1 --blibli }), 'command_line_nopassword --password1 --blibli'); } sub banner_imapsync { my @argv_copy = @_; my $banner_imapsync = join("", '$RCSfile: imapsync,v $ ', '$Revision: 1.340 $ ', '$Date: 2010/08/09 00:03:21 $ ', "\n",localhost_info(), "\n", "Command line used:\n", "$0 ", command_line_nopassword(@argv_copy), "\n", ); } sub is_valid_directory { my $dir = shift; return(1) if (-d $dir and -r _ and -w _); # Trying to create it mkpath($dir) or die "Error creating tmpdir $tmpdir : $!"; die "Error with tmpdir $tmpdir : $!" if not (-d $dir and -r _ and -w _); return(1); } sub write_pidfile { my $pidfile = shift; print "PID file is $pidfile\n"; if (-e $pidfile) { warn "$pidfile already exists, overwriting it\n"; } open(PIDFILE, ">$pidfile") or do { warn "Could not open $pidfile for writing"; return undef; }; print PIDFILE $PROCESS_ID; close PIDFILE; return($PROCESS_ID); } sub justconnect { my $imap1 = (); my $imap2 = (); $imap1 = connect_imap($host1, $port1, $debugimap1, $ssl1, $tls1); print "Host1 software: ", server_banner($imap1); print "Host1 capability: ", join(" ", $imap1->capability()), "\n"; $imap2 = connect_imap($host2, $port2, $debugimap2, $ssl2, $tls2); print "Host2 software: ", server_banner($imap2); print "Host2 capability: ", join(" ", $imap2->capability()), "\n"; $imap1->logout(); $imap2->logout(); } sub exit_clean { my $status = shift; unlink($pidfile); exit($status); } sub die_clean { unlink($pidfile); die @_; } sub missing_option { my ($option) = @_; die_clean("$option option must be used, run $0 --help for help\n"); } sub select_msgs { my ($imap) = @_; my (@msgs,@max,@min,@union,@inter); unless (defined($maxage) or defined($minage)) { @msgs = $imap->search("ALL"); return(@msgs); } if (defined($maxage)) { @max = $imap->sentsince(time - 86400 * $maxage); } if (defined($minage)) { @min = $imap->sentbefore(time - 86400 * $minage); } SWITCH: { unless(defined($minage)) {@msgs = @max; last SWITCH}; unless(defined($maxage)) {@msgs = @min; last SWITCH}; my (%union, %inter); foreach my $m (@min, @max) {$union{$m}++ && $inter{$m}++} @inter = keys(%inter); @union = keys(%union); # normal case if ($minage <= $maxage) {@msgs = @inter; last SWITCH}; # just exclude messages between if ($minage > $maxage) {@msgs = @union; last SWITCH}; } return(@msgs); } sub stats { print "++++ Statistics ++++\n"; print "Transfer time : $timediff sec\n"; print "Messages transferred : $nb_msg_transferred "; print "(could be $nb_msg_skipped_dry_mode without dry mode)" if ($dry); print "\n"; print "Messages skipped : $nb_msg_skipped\n"; print "Messages found duplicate on host1 : $h1_nb_msg_duplicate\n"; print "Messages found duplicate on host2 : $h2_nb_msg_duplicate\n"; print "Messages void (noheader) on host1 : $h1_nb_msg_noheader\n"; print "Messages void (noheader) on host2 : $h2_nb_msg_noheader\n"; print "Messages deleted on host1 : $h1_nb_msg_deleted\n"; print "Messages deleted on host2 : $h2_nb_msg_deleted\n"; print "Total bytes transferred : $total_bytes_transferred\n"; print "Total bytes duplicate host1 : $h1_total_bytes_duplicate\n"; print "Total bytes duplicate host2 : $h2_total_bytes_duplicate\n"; print "Total bytes skipped : $total_bytes_skipped\n"; print "Total bytes error : $total_bytes_error\n"; $timediff ||= 1; # No division per 0 printf ("Message rate : %.1f messages/s\n", $nb_msg_transferred / $timediff); printf ("Average bandwidth rate : %.1f KiB/s\n", $total_bytes_transferred / 1024 / $timediff); print "Reconnections to host1 : $host1_reconnect_count\n"; print "Reconnections to host2 : $host2_reconnect_count\n"; print "Detected $nb_errors errors\n\n"; print thank_author(); } sub thank_author { return(join("", "Happy with this free, open and gratis DWTFPL software?\n", "Encourage the author (Gilles LAMIRAL) by giving him a book\n", "or just money via paypal:\n", "http://www.linux-france.org/prj/imapsync/\n")); } sub get_options { my $numopt = scalar(@ARGV); my $argv = join("¤", @ARGV); $test_builder = Test::More->builder; $test_builder->no_ending(1); if($argv =~ m/-delete¤2/) { print "May be you mean --delete2 instead of --delete 2\n"; exit 1; } my $opt_ret = GetOptions( "debug!" => \$debug, "debugimap!" => \$debugimap, "debugimap1!" => \$debugimap1, "debugimap2!" => \$debugimap2, "host1=s" => \$host1, "host2=s" => \$host2, "port1=i" => \$port1, "port2=i" => \$port2, "user1=s" => \$user1, "user2=s" => \$user2, "password1=s" => \$password1, "password2=s" => \$password2, "passfile1=s" => \$passfile1, "passfile2=s" => \$passfile2, "authmd5!" => \$authmd5, "sep1=s" => \$sep1, "sep2=s" => \$sep2, "folder=s" => \@folder, "folderrec=s" => \@folderrec, "include=s" => \@include, "exclude=s" => \@exclude, "prefix1=s" => \$prefix1, "prefix2=s" => \$prefix2, "regextrans2=s" => \@regextrans2, "regexmess=s" => \@regexmess, "regexflag=s" => \@regexflag, "delete!" => \$delete, "delete2!" => \$delete2, "syncinternaldates!" => \$syncinternaldates, "idatefromheader!" => \$idatefromheader, "usedatemanip!" => \$usedatemanip, "syncacls!" => \$syncacls, "maxsize=i" => \$maxsize, "maxage=i" => \$maxage, "minage=i" => \$minage, "buffersize=i" => \$buffersize, "foldersizes!" => \$foldersizes, "dry!" => \$dry, "expunge!" => \$expunge, "expunge1!" => \$expunge1, "expunge2!" => \$expunge2, "uidexpunge2!" => \$uidexpunge2, "subscribed!" => \$subscribed, "subscribe!" => \$subscribe, "subscribe_all!" => \$subscribe_all, "justbanner!" => \$justbanner, "justconnect!"=> \$justconnect, "justfolders!"=> \$justfolders, "justfoldersizes!" => \$justfoldersizes, "fast!" => \$fast, "version" => \$version, "help" => \$help, "timeout=i" => \$timeout, "skipheader=s" => \$skipheader, "useheader=s" => \@useheader, "skipsize!" => \$skipsize, "allowsizemismatch!" => \$allowsizemismatch, "fastio1!" => \$fastio1, "fastio2!" => \$fastio2, "ssl1!" => \$ssl1, "ssl2!" => \$ssl2, "tls1!" => \$tls1, "tls2!" => \$tls2, "authmech1=s" => \$authmech1, "authmech2=s" => \$authmech2, "authuser1=s" => \$authuser1, "authuser2=s" => \$authuser2, "split1=i" => \$split1, "split2=i" => \$split2, "reconnectretry1=i" => \$reconnectretry1, "reconnectretry2=i" => \$reconnectretry2, "tests" => \$tests, "tests_debug" => \$tests_debug, "allow3xx!" => \$allow3xx, "justlogin!" => \$justlogin, "tmpdir=s" => \$tmpdir, "pidfile=s" => \$pidfile, ); $debug and print "get options: [$opt_ret]\n"; # just the version print imapsync_version(), "\n" and exit if ($version) ; if ($tests) { $test_builder->no_ending(0); tests(); exit; } if ($tests_debug) { $test_builder->no_ending(0); tests_debug(); exit; } $help = 1 if ! $numopt; load_modules(); # exit with --help option or no option at all usage() and exit if ($help or ! $numopt) ; # don't go on if options are not all known. exit(EX_USAGE()) unless ($opt_ret) ; } sub load_modules { require IO::Socket::SSL if ($ssl1 or $ssl2 or $tls1 or $tls2); require Date::Manip if ($syncinternaldates || $idatefromheader) ; require Term::ReadKey if ( ((not($password1 or $passfile1)) or (not($password2 or $passfile2))) and (not $help)); #require Data::Dumper if ($debug); } sub parse_header_msg { my ($imap, $m_uid, $s_heads, $s_fir, $s, $s_hash) = @_; my $head = $s_heads->{$m_uid}; my $headnum = scalar(keys(%$head)); $debug and print "Head NUM:", $headnum, "\n"; unless($headnum) { print "Warning: no header used or found for message $m_uid\n"; } my $headstr; foreach my $h (sort keys(%$head)){ foreach my $val (sort @{$head->{$h}}) { # no 8-bit data in headers ! $val =~ s/[\x80-\xff]/X/g; # remove the first blanks (dbmail bug ?) # and uppercase header keywords # (dbmail and dovecot) $val =~ s/^\s*(.+)$/$1/; #my $H = uc($h); my $H = "$h: $val"; # show stuff in debug mode $debug and print "${s}H $H:", $val, "\n"; if ($skipheader and $H =~ m/$skipheader/i) { $debug and print "Skipping header $H\n"; next; } #$headstr .= "$H:". $val; $headstr .= "$H"; } } #return unless ($headstr); unless ($headstr){ # taking everything is too heavy, # should take only 1 Ko #print "no header so taking everything\n"; #$headstr = $imap->message_string($m_uid); print "no header so we ignore this message\n"; return undef; } my $size = $s_fir->{$m_uid}->{"RFC822.SIZE"}; my $flags = $s_fir->{$m_uid}->{"FLAGS"}; my $idate = $s_fir->{$m_uid}->{"INTERNALDATE"}; $size = length($headstr) unless ($size); my $m_md5 = md5_base64($headstr); $debug and print "$s msg $m_uid:$m_md5:$size\n"; my $key; if ($skipsize) { $key = "$m_md5"; } else { $key = "$m_md5:$size"; } # 0 return code is used to identify duplicate message hash return 0 if exists $s_hash->{"$key"}; $s_hash->{"$key"}{'5'} = $m_md5; $s_hash->{"$key"}{'s'} = $size; $s_hash->{"$key"}{'D'} = $idate; $s_hash->{"$key"}{'F'} = $flags; $s_hash->{"$key"}{'m'} = $m_uid; } sub firstline { # extract the first line of a file (without \n) my($file) = @_; my $line = ""; open FILE, $file or die_clean("error [$file]: $! "); chomp($line = ); close FILE; $line = ($line) ? $line: "error !EMPTY! [$file]"; return $line; } sub file_to_string { my($file) = @_; my @string; open FILE, $file or die_clean("error [$file]: $! "); @string = ; close FILE; return join("", @string); } sub string_to_file { my($string, $file) = @_; sysopen(FILE, $file,O_WRONLY|O_TRUNC|O_CREAT, 0600) or die_clean("$! $file"); print FILE $string; close FILE; } sub usage { my $localhost_info = localhost_info(); my $thank = thank_author(); print < : "from" imap server. Mandatory. --port1 : port to connect on host1. Default is 143. --user1 : user to login on host1. Mandatory. --authuser1 : user to auth with on host1 (admin user). Avoid using --authmech1 SOMETHING with --authuser1. --password1 : password for the user1. Dangerous, use --passfile1 --passfile1 : password file for the user1. Contains the password. --host2 : "destination" imap server. Mandatory. --port2 : port to connect on host2. Default is 143. --user2 : user to login on host2. Mandatory. --authuser2 : user to auth with on host2 (admin user). --password2 : password for the user2. Dangerous, use --passfile2 --passfile2 : password file for the user2. Contains the password. --noauthmd5 : don't use MD5 authentification. --authmech1 : auth mechanism to use with host1: PLAIN, LOGIN, CRAM-MD5 etc. Use UPPERCASE. --authmech2 : auth mechanism to use with host2. See --authmech1 --ssl1 : use an SSL connection on host1. --ssl2 : use an SSL connection on host2. --tls1 : use an TLS connection on host1. --tls2 : use an TLS connection on host2. --folder : sync this folder. --folder : and this one, etc. --folderrec : sync this folder recursively. --folderrec : and this one, etc. --include : sync folders matching this regular expression --include : or this one, etc. in case both --include --exclude options are use, include is done before. --exclude : skips folders matching this regular expression Several folders to avoid: --exclude 'fold1|fold2|f3' skips fold1, fold2 and f3. --exclude : or this one, etc. --tmpdir : where to store temporary files and subdirectories. Will be created if it doesn't exist. Default is system specific and should be ok. --pidfile : the file where imapsync pid is written. --prefix1 : remove prefix to all destination folders (usually INBOX. for cyrus imap servers) you can use --prefix1 if your source imap server does not have NAMESPACE capability. --prefix2 : add prefix to all destination folders (usually INBOX. for cyrus imap servers) use --prefix2 if your target imap server does not have NAMESPACE capability. --regextrans2 : Apply the whole regex to each destination folders. --regextrans2 : and this one. etc. When you play with the --regextrans2 option, first add also the safe options --dry --justfolders Then, when happy, remove --dry, remove --justfolders --regexmess : Apply the whole regex to each message before transfer. Example: 's/\\000/ /g' # to replace null by space. --regexmess : and this one. --regexmess : and this one, etc. --regexflag : Apply the whole regex to each flags list. Example: 's/\"Junk"//g' # to remove "Junk" flag. --regexflag : and this one, etc. --sep1 : separator in case namespace is not supported. --sep2 : idem. --delete : delete messages on host1 server after a successful transfer. Useful in case you want to migrate from one server to another one. With imap, "delete" tags messages as deleted, they are not really deleted. See expunge. --delete2 : delete messages on host2 that are not on host1 server. --expunge : expunge messages on host1. expunge really deletes messages marked deleted. expunge is made at the beginning, on host1 only. Newly transferred messages are expunged if option --expunge is given. No expunge is done on destination account (see --expunge2) but it may change in future releases. --expunge1 : expunge messages on host1. --expunge2 : expunge messages on host2. --uidexpunge2 : uidexpunge messages on the destination imap server that are not on the source server, requires --delete2 --syncinternaldates : sets the internal dates on host2 same as host1. Turned on by default. Internal date is the date a message arrived on a host (mtime). --idatefromheader : sets the internal dates on host2 same as the "Date:" headers. --buffersize : sets the size of a block of I/O. --maxsize : skip messages larger than bytes --maxage : skip messages older than days. final stats (skipped) don't count older messages see also --minage --minage : skip messages newer than days. final stats (skipped) don't count newer messages You can do (+ are the messages selected): past|----maxage+++++++++++++++>now past|+++++++++++++++minage---->now past|----maxage+++++minage---->now (intersection) past|++++minage-----maxage++++>now (union) --skipheader : Don't take into account header keyword matching ex: --skipheader 'X.*' --useheader : Use this header to compare messages on both sides. Ex: Message-ID or Subject or Date. --useheader and this one, etc. --skipsize : Don't take message size into account to compare messages on both sides. On by default. Use --no-skipsize for using size comparaison. --allowsizemismatch : allow RFC822.SIZE != fetched msg size consider also --skipsize to avoid duplicate messages when running syncs more than one time per mailbox --dry : do nothing, just print what would be done. --subscribed : transfers subscribed folders. --subscribe : subscribe to the folders transferred on the host2 that are subscribed on host1. --subscribe_all : subscribe to the folders transferred on the host2 even if they are not subscribed on host1. --nofoldersizes : Do not calculate the size of each folder in bytes and message counts. Default is to calculate them. --justfoldersizes : exit after printed the folder sizes. --syncacls : Synchronises acls (Access Control Lists). --nosyncacls : Does not synchronise acls. This is the default. --debug : debug mode. --debugimap1 : imap debug mode for host1. imap debug is very verbose. --debugimap2 : imap debug mode for host2. --debugimap : imap debug mode for host1 and host2. --version : print software version. --justconnect : just connect to both servers and print useful information. Need only --host1 and --host2 options. --justlogin : just login to both host1 and host2 with users credentials, then exit. --justfolders : just do things about folders (ignore messages). --fast : be faster (just does not sync flags of messages already transfered). --reconnectretry1 : reconnect to host1 if connection is lost up to times per imap command (default is 3) --reconnectretry2 : same as --reconnectretry1 but for host2 --split1 : split the requests in several parts on host1. is the number of messages handled per request. default is like --split1 1000. --split2 : same thing on host2. --fastio1 : use fastio with host1. --fastio2 : use fastio with host2. --timeout : imap connect timeout. --help : print this help. Example: to synchronise imap account "foo" on "imap.truc.org" to imap account "bar" on "imap.trac.org" with foo password "secret1" and bar password "secret2" $0 \\ --host1 imap.truc.org --user1 foo --password1 secret1 \\ --host2 imap.trac.org --user2 bar --password2 secret2 $localhost_info $rcs $thank EOF } sub tests_debug { SKIP: { skip "No test in normal run" if (not $tests_debug); tests_regexmess(); } } sub tests { SKIP: { skip "No test in normal run" if (not $tests); tests_folder_routines(); tests_compare_lists(); tests_regexmess(); tests_flags_regex(); tests_permanentflags(); tests_flags_filter(); tests_imap2_folder_name(); tests_command_line_nopassword(); } } # IMAPClient 2.2.9 overrides sub override_imapclient { no warnings 'redefine'; no strict 'subs'; use constant Unconnected => 0; use constant Connected => 1; # connected; not logged in use constant Authenticated => 2; # logged in; no mailbox selected use constant Selected => 3; # mailbox selected use constant INDEX => 0; # Array index for output line number use constant TYPE => 1; # Array index for line type # (either OUTPUT, INPUT, or LITERAL) use constant DATA => 2; # Array index for output line data use constant NonFolderArg => 1; # Value to pass to Massage to # indicate non-folder argument *Mail::IMAPClient::append_file = sub { my $self = shift; my $folder = $self->Massage(shift); my $file = shift; my $control = shift || undef; my $count = $self->Count($self->Count+1); my $flags = shift || undef; my $date = shift || undef; if (defined($flags)) { $flags =~ s/^\s+//g; $flags =~ s/\s+$//g; } if (defined($date)) { $date =~ s/^\s+//g; $date =~ s/\s+$//g; } $flags = "($flags)" if $flags and $flags !~ /^\(.*\)$/ ; $date = qq/"$date"/ if $date and $date !~ /^"/ ; unless ( -f $file ) { $self->LastError("File $file not found.\n"); return undef; } my $fh = IO::File->new($file) ; unless ($fh) { $self->LastError("Unable to open $file: $!\n"); $@ = "Unable to open $file: $!" ; carp "unable to open $file: $!"; return undef; } my $bare_nl_count = scalar grep { /^\x0a$|[^\x0d]\x0a$/} <$fh>; seek($fh,0,0); my $clear = $self->Clear; $self->Clear($clear) if $self->Count >= $clear and $clear > 0; my $length = ( -s $file ) + $bare_nl_count; my $string = "$count APPEND $folder " . ( $flags ? "$flags " : "" ) . ( $date ? "$date " : "" ) . "{" . $length . "}\x0d\x0a" ; $self->_record($count,[ $self->_next_index($count), "INPUT", "$string" ] ); my $feedback = $self->_send_line("$string"); unless ($feedback) { $self->LastError("Error sending '$string' to IMAP: $!\n"); $fh->close; return undef; } my ($code, $output) = ("",""); until ( $code ) { $output = $self->_read_line or $fh->close, return undef; foreach my $o (@$output) { $self->_record($count,$o); # $o is already an array ref ($code) = $o->[DATA] =~ /(^\+|^\d+\sNO|^\d+\sBAD)/i; if ($o->[DATA] =~ /^\*\s+BYE/) { carp $o->[DATA]; $self->State(Unconnected); $fh->close; return undef ; } elsif ( $o->[DATA]=~ /^\d+\s+(NO|BAD)/i ) { carp $o->[DATA]; $fh->close; return undef; } } } { # Narrow scope # Slurp up headers: later we'll make this more efficient I guess local $/ = "\x0d\x0a\x0d\x0a"; my $text = <$fh>; $text =~ s/\x0d?\x0a/\x0d\x0a/g; $self->_record($count,[ $self->_next_index($count), "INPUT", "{From file $file}" ] ) ; $feedback = $self->_send_line($text); unless ($feedback) { $self->LastError("Error sending append msg text to IMAP: $!\n"); $fh->close; return undef; } _debug($self, "control points to $$control\n") if ref($control) and $self->Debug; $/ = ref($control) ? "\x0a" : $control ? $control : "\x0a"; while (defined($text = <$fh>)) { $text =~ s/\x0d?\x0a/\x0d\x0a/g; $self->_record( $count, [ $self->_next_index($count), "INPUT", "{from $file}\x0d\x0a" ] ); $feedback = $self->_send_line($text,1); unless ($feedback) { $self->LastError("Error sending append msg text to IMAP: $!\n"); $fh->close; return undef; } } $feedback = $self->_send_line("\x0d\x0a"); unless ($feedback) { $self->LastError("Error sending append msg text to IMAP: $!\n"); $fh->close; return undef; } } # Now for the crucial test: Did the append work or not? ($code, $output) = ("",""); my $uid = undef; until ( $code ) { $output = $self->_read_line or return undef; foreach my $o (@$output) { $self->_record($count,$o); # $o is already an array ref $self->_debug("append_file: Deciding if " . $o->[DATA] . " has the code.\n") if $self->Debug; ($code) = $o->[DATA] =~ /^\d+\s(NO|BAD|OK)/i; # try to grab new msg's uid from o/p $o->[DATA] =~ m#UID\s+\d+\s+(\d+)\]# and $uid = $1; if ($o->[DATA] =~ /^\*\s+BYE/) { carp $o->[DATA]; $self->State(Unconnected); $fh->close; return undef ; } elsif ( $o->[DATA]=~ /^\d+\s+(NO|BAD)/i ) { carp $o->[DATA]; $fh->close; return undef; } } } $fh->close; if ($code !~ /^OK/i) { return undef; } return defined($uid) ? $uid : $self; }; *Mail::IMAPClient::fetch_hash = sub { # taken from original lib, # just added split code. my $self = shift; my $hash = ref($_[-1]) ? pop @_ : {}; my @words = @_; for (@words) { s/([\( ])FAST([\) ])/${1}FLAGS INTERNALDATE RFC822\.SIZE$2/i ; s/([\( ])FULL([\) ])/${1}FLAGS INTERNALDATE RFC822\.SIZE ENVELOPE BODY$2/i ; } my $msgref_all = scalar($self->messages); my $split = $self->Split() || scalar(@$msgref_all); while(my @msgs = splice(@$msgref_all, 0, $split)) { #print "SPLIT: @msgs\n"; my $msgref = \@msgs; my $output = scalar($self->fetch($msgref,"(" . join(" ",@_) . ")")) ; # unless grep(/\b(?:FAST|FULL)\b/i,@words); my $x; for ($x = 0; $x <= $#$output ; $x++) { my $entry = {}; my $l = $output->[$x]; if ($self->Uid) { my($uid) = $l =~ /\((?:.* )?UID (\d+).*\)/i; next unless $uid; if ( exists $hash->{$uid} ) { $entry = $hash->{$uid} ; } else { $hash->{$uid} ||= $entry; } } else { my($mid) = $l =~ /^\* (\d+) FETCH/i; next unless $mid; if ( exists $hash->{$mid} ) { $entry = $hash->{$mid} ; } else { $hash->{$mid} ||= $entry; } } foreach my $w (@words) { if ( $l =~ /\Q$w\E\s*$/i ) { $entry->{$w} = $output->[$x+1]; $entry->{$w} =~ s/(?:\x0a?\x0d)+$//g; chomp $entry->{$w}; } else { $l =~ /\( # open paren followed by ... (?:.*\s)? # ...optional stuff and a space \Q$w\E\s # escaped fetch field (?:" # then: a dbl-quote (\\.| # then bslashed anychar(s) or ... [^"]+) # ... nonquote char(s) "| # then closing quote; or ... \( # ...an open paren (\\.| # then bslashed anychar or ... [^\)]*) # ... non-close-paren char \)| # then closing paren; or ... (\S+)) # unquoted string (?:\s.*)? # possibly followed by space-stuff \) # close paren /xi; $entry->{$w}=defined($1)?$1:defined($2)?$2:$3; } } } } return wantarray ? %$hash : $hash; }; *Mail::IMAPClient::login = sub { my $self = shift; return $self->authenticate($self->Authmechanism,$self->Authcallback) if $self->{Authmechanism}; my $id = $self->User; my $has_quotes = $id =~ /^".*"$/ ? 1 : 0; my $string = "Login " . ( $has_quotes ? $id : qq("$id") ) . " " . $self->Password . "\r\n"; $self->_imap_command($string) and $self->State(Authenticated); # $self->folders and $self->separator unless $self->NoAutoList; unless ( $self->IsAuthenticated) { my($carp) = $self->LastError; $carp =~ s/^[\S]+ ([^\x0d\x0a]*)\x0d?\x0a/$1/; carp $carp unless defined wantarray; return undef; }; return $self; }; *Mail::IMAPClient::get_header = sub { my($self , $msg, $header ) = @_; my $val; #eval { $val = $self->parse_headers([$msg],$header)->{$header}[0] }; my $h = $self->parse_headers([$msg],$header); #require Data::Dumper; #print Data::Dumper->Dump([$h]); #$val = $self->parse_headers([$msg],$header)->{$header}[0]; $val = $h->{$msg}{$header}[0]; return defined($val)? $val : undef; }; *Mail::IMAPClient::parse_headers = sub { my($self,$msgspec_all,@fields) = @_; my(%fieldmap) = map { ( lc($_),$_ ) } @fields; my $msg; my $string; my $field; #print ref($msgspec_all), "\n"; #if(ref($msgspec_all) eq 'HASH') { # print ref($msgspec_all), "\n"; #$msgspec_all = [$msgspec_all]; #} unless(ref($msgspec_all) eq 'ARRAY') { print "parse_headers want an ARRAY ref\n"; #exit 1; return undef; } my $headers = {}; # hash from message ids to header hash my $split = $self->Split() || scalar(@$msgspec_all); while(my @msgs = splice(@$msgspec_all, 0, $split)) { $debug and print "SPLIT: @msgs\n"; my $msgspec = \@msgs; # Make $msg a comma separated list, of messages we want $msg = $self->Range($msgspec); if ($fields[0] =~ /^[Aa][Ll]{2}$/ ) { $string = "$msg body" . # use ".peek" if Peek parameter is a) defined and true, # or b) undefined, but not if it's defined and untrue: ( defined($self->Peek) ? ( $self->Peek ? ".peek" : "" ) : ".peek" ) . "[header]" ; }else { $string = "$msg body" . # use ".peek" if Peek parameter is a) defined and true, or # b) undefined, but not if it's defined and untrue: ( defined($self->Peek) ? ( $self->Peek ? ".peek" : "" ) : ".peek" ) . "[header.fields (" . join(" ",@fields) . ')]' ; } my @raw=$self->fetch( $string ) or return undef; my $h = 0; # reference to hash of current msgid, or 0 between msgs for my $header (map { split(/(?:\x0d\x0a)/,$_) } @raw) { no warnings; if ( $header =~ /^\*\s+\d+\s+FETCH\s+\(.*BODY\[HEADER(?:\]|\.FIELDS)/i) { if ($self->Uid) { if ( my($msgid) = $header =~ /UID\s+(\d+)/ ) { $h = {}; $headers->{$msgid} = $h; } else { $h = {}; } } else { if ( my($msgid) = $header =~ /^\*\s+(\d+)/ ) { #start of new message header: $h = {}; $headers->{$msgid} = $h; } } } next if $header =~ /^\s+$/; # ( for vi if ($header =~ /^\)/) { # end of this message $h = 0; # set to be between messages next; } # check for 'UID)' # when parsing headers by UID. if ($self->Uid and my($msgid) = $header =~ /^\s*UID\s+(\d+)\s*\)/) { $headers->{$msgid} = $h; # store in results against this message $h = 0; # set to be between messages next; } if ($h != 0) { # do we expect this to be a header? my $hdr = $header; chomp $hdr; $hdr =~ s/\r$//; #print "W[$hdr]", ref($hdr), "!\n"; #next if ( ! defined($hdr)); #print "X[$hdr]\n"; if (defined($hdr) and ($hdr =~ s/^(\S+):\s*//)) { # if ($hdr =~ s/^(\S+):\s*//) { #print "X1\n"; $field = exists $fieldmap{lc($1)} ? $fieldmap{lc($1)} : $1 ; push @{$h->{$field}} , $hdr ; } elsif ($hdr =~ s/^.*FETCH\s\(.*BODY\[HEADER\.FIELDS.*\)\]\s(\S+):\s*//) { #print "X2\n"; $field = exists $fieldmap{lc($1)} ? $fieldmap{lc($1)} : $1 ; push @{$h->{$field}} , $hdr ; } elsif ( ref($h->{$field}) eq 'ARRAY') { #print "X3\n"; $hdr =~ s/^\s+/ /; $h->{$field}[-1] .= $hdr ; } } } use warnings; # my $candump = 0; # if ($self->Debug) { # eval { # require Data::Dumper; # Data::Dumper->import; # }; # $candump++ unless $@; # } } # if we asked for one message, just return its hash, # otherwise, return hash of numbers => header hash # if (ref($msgspec) eq 'ARRAY') { return $headers; }; *Mail::IMAPClient::authenticate = sub { my $self = shift; my $scheme = shift; my $response = shift; $scheme ||= $self->Authmechanism; $response ||= $self->Authcallback; my $clear = $self->Clear; $self->Clear($clear) if $self->Count >= $clear and $clear > 0; my $count = $self->Count($self->Count+1); my $string = "$count AUTHENTICATE $scheme"; $self->_record($count,[ $self->_next_index($self->Transaction), "INPUT", "$string\x0d\x0a"] ); my $feedback = $self->_send_line("$string"); unless ($feedback) { $self->LastError("Error sending '$string' to IMAP: $!\n"); return undef; } my ($code, $output); until ($code) { $output = $self->_read_line or return undef; foreach my $o (@$output) { $self->_record($count,$o); # $o is a ref ($code) = $o->[DATA] =~ /^\+(.*)$/ ; if ($o->[DATA] =~ /^\*\s+BYE/) { $self->State(Unconnected); return undef ; } if ($o->[DATA]=~ /^\d+\s+(NO|BAD)/i) { return undef ; } } } if ('CRAM-MD5' eq $scheme && ! $response) { if ($Mail::IMAPClient::_CRAM_MD5_ERR) { $self->LastError($Mail::IMAPClient::_CRAM_MD5_ERR); carp $Mail::IMAPClient::_CRAM_MD5_ERR; } else { $response = \&Mail::IMAPClient::_cram_md5; } } $feedback = $self->_send_line($response->($code, $self)); unless ($feedback) { $self->LastError("Error sending append msg text to IMAP: $!\n"); return undef; } $code = ""; # clear code until ($code) { $output = $self->_read_line or return undef; foreach my $o (@$output) { $self->_record($count,$o); # $o is a ref if ( ($code) = $o->[DATA] =~ /^\+ (.*)$/ ) { $feedback = $self->_send_line($response->($code,$self)); unless ($feedback) { $self->LastError("Error sending append msg text to IMAP: $!\n"); return undef; } $code = "" ; # Clear code; we're still not finished } else { $o->[DATA] =~ /^$count (OK|NO|BAD)/ and $code = $1; if ($o->[DATA] =~ /^\*\s+BYE/) { $self->State(Unconnected); return undef ; } } } } $code =~ /^OK/ and $self->State(Authenticated) ; return $code =~ /^OK/ ? $self : undef ; }; *Mail::IMAPClient::_cram_md5 = sub { my ($code, $client) = @_; my $hmac = Digest::HMAC_MD5::hmac_md5_hex(MIME::Base64::decode($code), $client->Password()); return MIME::Base64::encode($client->User() . " $hmac", ""); }; *Mail::IMAPClient::message_string = sub { my $self = shift; my $msg = shift; my $expected_size = $self->size($msg); return undef unless(defined $expected_size); # unable to get size my $cmd = $self->has_capability('IMAP4REV1') ? "BODY" . ( $self->Peek ? '.PEEK[]' : '[]' ) : "RFC822" . ( $self->Peek ? '.PEEK' : '' ) ; $self->fetch($msg,$cmd) or return undef; my $string = ""; foreach my $result (@{$self->{"History"}{$self->Transaction}}) { $string .= $result->[DATA] if defined($result) and $self->_is_literal($result) ; } # BUG? should probably return undef if length != expected # No bug, somme servers are buggy. if (! $self->Ignoresizeerrors ) { if ( length($string) != $expected_size ) { warn "message_string: " . "expected $expected_size bytes but received " . length($string) . "\n"; $self->LastError("message_string: expected ". "$expected_size bytes but received " . length($string)."\n"); } } return $string; }; { no warnings 'once'; *Mail::IMAPClient::Ssl = sub { my $self = shift; if (@_) { $self->{SSL} = shift } return $self->{SSL}; }; *Mail::IMAPClient::exists = sub { my ( $self, $folder ) = @_; $self->status($folder) ? $self : undef; }; *Mail::IMAPClient::Authuser = sub { my $self = shift; if (@_) { $self->{AUTHUSER} = shift } return $self->{AUTHUSER}; }; *Mail::IMAPClient::Ignoresizeerrors = sub { my $self = shift; if (@_) { $self->{IGNORESIZEERRORS} = shift } return $self->{IGNORESIZEERRORS}; }; *Mail::IMAPClient::Reconnectretry = sub { my $self = shift; if (@_) { $self->{RECONNECTRETRY} = shift } return $self->{RECONNECTRETRY}; }; *Mail::IMAPClient::reconnect = sub { my $self = shift; if ( $self->IsAuthenticated ) { $self->_debug("reconnect called but already authenticated"); return $self; } my $einfo = $self->LastError || ""; $self->_debug( "reconnecting to ", $self->Server, ", last error: $einfo" ); # reconnect and select appropriate folder $self->connect or return undef; return ( defined $self->Folder ) ? $self->select( $self->Folder ) : $self; }; # wrapper for _imap_command_do to enable retrying on lost connections *Mail::IMAPClient::_imap_command = sub { my $self = shift; my $tries = 0; my $retry = $self->Reconnectretry || 0; my ( $rc, @err ); # LastError (if set) will be overwritten masking any earlier errors while ( $tries++ <= $retry ) { # do command on the first try or if Connected (reconnect ongoing) if ( $tries == 1 or $self->IsConnected ) { #print "call @_\n"; $rc = $self->_imap_command_do(@_); push( @err, $self->LastError ) if $self->LastError; #print "call @_ done [", $rc || '', "] [$tries/$retry][" . $self->IsUnconnected . "]\n"; } if ( !defined($rc) and $retry and $self->IsUnconnected and $self->LastIMAPCommand !~ /LOGOUT/) { print "\nWarning: disconnected. "; if ( $self->reconnect ) { print "Reconnect successful on try #$tries\n"; $self->Reconnect_counter($self->Reconnect_counter() + 1); } else { print "Reconnect failed on try #$tries\n"; push( @err, $self->LastError ) if $self->LastError; } } else { last; } } unless ($rc) { my ( %seen, @keep, @info ); foreach my $str (@err) { my ( $sz, $len ) = ( 96, length($str) ); $str =~ s/$CR?$LF$/\\n/omg; if ( !$self->Debug and $len > $sz * 2 ) { my $beg = substr( $str, 0, $sz ); my $end = substr( $str, -$sz, $sz ); $str = $beg . "..." . $end; } next if $seen{$str}++; push( @keep, $str ); } foreach my $msg (@keep) { push( @info, $msg . ( $seen{$msg} > 1 ? " ($seen{$msg}x)" : "" ) ); } $self->LastError( join( "; ", @info ) ); } return $rc; }; *Mail::IMAPClient::_imap_command_do = sub { my $self = shift; my $string = shift or return undef; my $good = shift || 'GOOD'; my $qgood = quotemeta($good); my $clear = ""; $clear = $self->Clear; $self->Clear($clear) if $self->Count >= $clear and $clear > 0; my $count = $self->Count($self->Count+1); $string = "$count $string" ; $self->_record($count,[ 0, "INPUT", "$string\x0d\x0a"] ); my $feedback = $self->_send_line("$string"); unless ($feedback) { $self->LastError( "Error sending '$string' to IMAP: $!\n"); $@ = "Error sending '$string' to IMAP: $!"; carp "Error sending '$string' to IMAP: $!"; return undef; } my ($code, $output); $output = ""; READ: until ( $code) { # escape infinite loop if read_line never returns any data: $output = $self->_read_line or return undef; for my $o (@$output) { $self->_record($count,$o); # $o is a ref # $self->_debug("Received from readline: ${\($o->[DATA])}<>\n"); next unless $self->_is_output($o); if ( $good eq '+' ) { $o->[DATA] =~ /^$count (OK|BAD|NO|$qgood)|^($qgood)/mi ; $code = $1||$2 ; } else { ($code) = $o->[DATA] =~ /^$count (OK|BAD|NO|$qgood)/mi ; } if ($o->[DATA] =~ /^\*\s+BYE/im) { $self->State(Unconnected); return undef ; } } } # $self->_debug("Command $string: returned $code\n"); return $code =~ /^OK|$qgood/im ? $self : undef ; }; *Mail::IMAPClient::_read_line = sub { my $self = shift; my $sh = $self->Socket; my $literal_callback = shift; my $output_callback = shift; unless ($self->IsConnected and $self->Socket) { $self->LastError("NO Not connected.\n"); carp "Not connected" if $^W; return undef; } my $iBuffer = ""; my $oBuffer = []; my $count = 0; my $index = $self->_next_index($self->Transaction); my $rvec = my $ready = my $errors = 0; my $timeout = $self->Timeout; my $readlen = 1; my $fast_io = $self->Fast_io; # Remember setting to reduce future method calls if ( $fast_io ) { # set fcntl if necessary: exists $self->{_fcntl} or $self->Fast_io($fast_io); $readlen = $self->{Buffer}||4096; } until ( # there's stuff in output buffer: scalar(@$oBuffer) and # the last thing there has cr-lf: $oBuffer->[-1][DATA] =~ /\x0d\x0a$/ and # that thing is an output line: $oBuffer->[-1][TYPE] eq "OUTPUT" and # and the input buffer has been MT'ed: $iBuffer eq "" ) { my $transno = $self->Transaction; # used below in several places if ($timeout) { vec($rvec, fileno($self->Socket), 1) = 1; my @ready = $self->{_select}->can_read($timeout) ; unless ( @ready ) { $self->LastError("Tag $transno: " . "Timeout after $timeout seconds " . "waiting for data from server\n"); $self->_record($transno, [ $self->_next_index($transno), "ERROR", "$transno * NO Timeout after ". "$timeout seconds " . "during read from " . "server\x0d\x0a" ] ); $self->LastError( "Timeout after $timeout seconds " . "during read from server\x0d\x0a" ); return undef; } } #local($^W) = undef; # Now quiet down warnings # read "$readlen" bytes (or less): # need to check return code from $self->_sysread # in case other end has shut down!!! my $ret = $self->_sysread( $sh, \$iBuffer, $readlen, length($iBuffer)) ; # $self->_debug("Read so far: $iBuffer<>\n"); if($timeout and ! defined($ret)) { # Blocking read error... my $msg = "Error while reading data from server: $!\x0d\x0a"; $self->LastError('Error while reading data from server'); $self->State(Unconnected); print $msg; $self->_record($transno, [ $self->_next_index($transno), "ERROR", "$transno * NO $msg " ]); $@ = "$msg"; return undef; } elsif(defined($ret) and $ret == 0) { # Caught EOF... my $msg="Socket closed while reading data from server [$!]\x0d\x0a"; print "$msg"; $self->LastError('Socket closed while reading data from server'); $self->State(Unconnected); $self->_record($transno, [ $self->_next_index($transno), "ERROR", "$transno * NO $msg " ]); $@ = "$msg"; return undef; } # successfully wrote to other end, keep going... $count += $ret; LINES: while ( $iBuffer =~ s/^(.*?\x0d?\x0a)// ) { my $current_line = $1; # $self->_debug("BUFFER: pulled from buffer: ${current_line}\n" . # "and left with buffer contents of: ${iBuffer}\n"); LITERAL: if ($current_line =~ s/\{(\d+)\}\x0d\x0a$//) { # This part handles IMAP "Literals", # which according to rfc2060 look something like this: # [tag]|* BLAH BLAH {nnn}\r\n # [nnn bytes of literally transmitted stuff] # [part of line that follows literal data]\r\n # Set $len to be length of impending literal: my $len = $1 ; $self->_debug("LITERAL: received literal in line ". "$current_line of length $len; ". "attempting to ". "retrieve from the " . length($iBuffer) . " bytes in: $iBuffer\n"); # Xfer up to $len bytes from front of $iBuffer to $litstring: my $litstring = substr($iBuffer, 0, $len); $iBuffer = substr($iBuffer, length($litstring), length($iBuffer) - length($litstring) ) ; # Figure out what's left to read (i.e. what part of # literal wasn't in buffer): my $remainder_count = $len - length($litstring); my $callback_value = ""; if ( defined($literal_callback) ) { if ( $literal_callback =~ /GLOB/) { print $literal_callback $litstring ; $litstring = ""; } elsif ($literal_callback =~ /CODE/ ) { # Don't do a thing } else { $self->LastError( ref($literal_callback) . " is an invalid callback type; " . "must be a filehandle or coderef\n" ); } } if ($remainder_count > 0 and $timeout) { # If we're doing timeouts then here we set up select # and wait for data from the the IMAP socket. vec($rvec, fileno($self->Socket), 1) = 1; unless ( CORE::select( $ready = $rvec, undef, $errors = $rvec, $timeout) ) { # Select failed; that means bad news. # Better tell someone. $self->LastError("Tag " . $transno . ": Timeout waiting for literal data " . "from server\n"); carp "Tag " . $transno . ": Timeout waiting for literal data " . "from server\n" if $self->Debug or $^W; return undef; } } fcntl($sh, F_SETFL, $self->{_fcntl}) if $fast_io and defined($self->{_fcntl}); while ( $remainder_count > 0 ) { # As long as not done, $self->_debug("Still need $remainder_count to " . "complete literal string\n"); my $ret = $self->_sysread( # bytes read $sh, # IMAP handle \$litstring, # place to read into $remainder_count, # bytes left to read length($litstring) # offset to read into ) ; $self->_debug("Received ret=$ret and buffer = " . "\n$litstring\nwhile processing LITERAL\n"); if ( $timeout and !defined($ret)) { # possible timeout $self->_record($transno, [ $self->_next_index($transno), "ERROR", "$transno * NO Error reading data " . "from server: $!\n" ] ); return undef; } elsif ( $ret == 0 and eof($sh) ) { $self->_record($transno, [ $self->_next_index($transno), "ERROR", "$transno * ". "BYE Server unexpectedly " . "closed connection: $!\n" ] ); $self->State(Unconnected); return undef; } # decrement remaining bytes by amt read: $remainder_count -= $ret; if ( length($litstring) > $len ) { # copy the extra struff into the iBuffer: $iBuffer = substr( $litstring, $len, length($litstring) - $len ); $litstring = substr($litstring, 0, $len) ; } if ( defined($literal_callback) ) { if ( $literal_callback =~ /GLOB/ ) { print $literal_callback $litstring; $litstring = ""; } } } $literal_callback->($litstring) if defined($litstring) and defined($literal_callback) and $literal_callback =~ /CODE/; $self->Fast_io($fast_io) if $fast_io; # Now let's make sure there are no IMAP server output lines # (i.e. [tag|*] BAD|NO|OK Text) embedded in the literal string # (There shouldn't be but I've seen it done!), but only if # EnableServerResponseInLiteral is set to true my $embedded_output = 0; my $lastline = ( split(/\x0d?\x0a/,$litstring))[-1] if $litstring; if ( $self->EnableServerResponseInLiteral and $lastline and $lastline =~ /^(?:\*|(\d+))\s(BAD|NO|OK)/i ) { $litstring =~ s/\Q$lastline\E\x0d?\x0a//; $embedded_output++; $self->_debug("Got server output mixed in " . "with literal: $lastline\n" ) if $self->Debug; } # Finally, we need to stuff the literal onto the # end of the oBuffer: push @$oBuffer, [ $index++, "OUTPUT" , $current_line], [ $index++, "LITERAL", $litstring ]; push @$oBuffer, [ $index++, "OUTPUT", $lastline ] if $embedded_output; } else { push @$oBuffer, [ $index++, "OUTPUT" , $current_line ]; } } #$self->_debug("iBuffer is now: $iBuffer<>\n"); } # _debug $self, "Buffer is now $buffer\n"; _debug $self, "Read: " . join("",map {$_->[DATA]} @$oBuffer) ."\n" if $self->Debug; return scalar(@$oBuffer) ? $oBuffer : undef ; }; } # End of sub override_imapclient (yes, very bad indentation) } sub myconnect { my $self = shift; $debug and print "Entering myconnect\n"; %$self = (%$self, @_); my $sock = (($self->Ssl) ? IO::Socket::SSL->new : IO::Socket::INET->new); my $dp = ($self->Ssl ? 'imaps(993)' : 'imap(143)'); $debug and print "Calling configure\n"; my $ret = $sock->configure({ PeerAddr => $self->Server , PeerPort => $self->Port||$dp , Proto => 'tcp' , Timeout => $self->Timeout||0 , Debug => $self->Debug , }); unless ( defined($ret) ) { $self->LastError( "$@\n"); $@ = "$@"; carp "$@" unless defined wantarray; return undef; } $sock->autoflush(1); my $banner = $sock->getline(); $debug and print "Read: $banner"; $self->Banner($banner); $self->RawSocket2($sock); $self->State(Connected); if ($self->Tls) { $debug and print "Calling starttls\n"; my $banner = starttls($self); $debug and print "End starttls: $banner\n"; } $self->Ignoresizeerrors($allowsizemismatch); if ($self->User and $self->Password) { $debug and print "Calling login\n"; return $self->login ; } else { return $self; } } sub starttls { my $self = shift; my $socket = $self->RawSocket2(); $debug and print "Entering starttls\n"; my $banner = $self->Banner(); $debug and print $banner; unless ($banner =~ /^\* OK \[CAPABILITY.*STARTTLS.*\]/) { die_clean( "No STARTTLS capability: $banner" ); } print $socket, "\n"; print $socket "z00 STARTTLS\015\012"; my $txt = $socket->getline(); $debug and print "Read: $txt"; unless($txt =~ /^z00 OK/){ die_clean( "Invalid response for STARTTLS: $txt\n" ); } $debug and print "Calling start_SSL\n"; unless(IO::Socket::SSL->start_SSL($socket, { SSL_version => "TLSV1", SSL_startHandshake => 1, SSL_verify_depth => 1, })) { die_clean( "Couldn't start TLS: ".IO::Socket::SSL::errstr()."\n"); } if (ref($socket) ne "IO::Socket::SSL") { die_clean( "Socket has NOT been converted to SSL"); }else{ $debug and print "Socket successfuly converted to SSL\n"; } $banner; } # IMAPClient 2.2.9 3.xx ads package Mail::IMAPClient; sub Split { my $self = shift; if (@_) { $self->{SPLIT} = shift; $self->{Maxcommandlength} = 10 * $self->{SPLIT}; } return $self->{SPLIT}; } sub Tls { my $self = shift; if (@_) { $self->{TLS} = shift } return $self->{TLS}; } sub Reconnect_counter { my $self = shift; if (@_) { $self->{Reconnect_counter} = shift } return $self->{Reconnect_counter}; } sub Banner { my $self = shift; if (@_) { $self->{BANNER} = shift } return $self->{BANNER}; } sub RawSocket2 { my ( $self, $sock ) = @_; defined $sock or return $self->{Socket}; $self->{Socket} = $sock; $self->{_select} = IO::Select->new($sock); delete $self->{_fcntl}; #$self->Fast_io( $self->Fast_io ); $sock; }