IMAPSync. Transfer mail between servers

Compiling IMAPSync.exe from source for Windows

1. Prepare tools for compilation:
   For example, we will use the path "D: \ IMAPSync \"
   
   Download the latest version of IMAPSync from github , using the example of IMAPSync v1.678
   Unpack the archive in D: \ IMAPSync \ imapsync-1.678 \ *. *
   Copy the imapsync file from D: \ IMAPSync \ imapsync-1.678 \ to D: \ IMAPSync \ imapsync-1.678 \ W \
   
   Download Strawberry-perl , on the example of the version Strawberry-perl-5.22.2.1-32bit-portable.zip
   
   Read more about different versions and problems.

   Successful installation of packages and compilation IMAPSync tested on versions:
   

   strawberry-perl-5.20.3.3-32bit-portable strawberry-perl-5.22.1.3-32bit-portable strawberry-perl-5.22.2.1-32bit-portable 

   
   Errors found on versions:
   

    strawberry-perl-5.24.0.1-32bit-portable (  ppm install Unicode::String) 

   Unpack the archive in D: \ IMAPSync \ strawberry-perl-5.22.2.1-32bit-portable \ *. *
   Run D: \ IMAPSync \ strawberry-perl-5.22.2.1-32bit-portable \ portableshell.bat
   
   The command line will appear (the perl environment variables are already configured here), in it we run
   

    ppm install Unicode::String D:\IMAPSync\imapsync-1.678\W\install_modules.bat 

   
   At this stage, the firewall (firewall) may request to open access for the application “D: \ IMAPSync \ strawberry-perl-5.22.2.1-32bit-portable \ perl \ bin \ perl.exe”
   You must enable network access to successfully install the modules.
   
   We rerun the command for visual monitoring of errors.
   

    D:\IMAPSync\imapsync-1.678\W\install_modules.bat 

   
   We are convinced that all the modules are installed, there are no errors, you can proceed to compile.
   
   
2. Run the compilation:
   

    D:\IMAPSync\imapsync-1.678\W\build_exe.bat 

   
   On exit we get imapsync.exe - we run it in the same command line window and check that it should show help:
   
   Result. Help for all parameters

     Several options are mandatory. str means string int means integer reg means regular expression cmd means command --dry : Makes imapsync doing nothing, just print what would be done without --dry. --host1 str : Source or "from" imap server. Mandatory. --port1 int : Port to connect on host1. Default is 143, 993 if --ssl1 --user1 str : User to login on host1. Mandatory. --showpasswords : Shows passwords on output instead of "MASKED". Useful to restart a complete run by just reading the log. --password1 str : Password for the user1. --host2 str : "destination" imap server. Mandatory. --port2 int : Port to connect on host2. Default is 143, 993 if --ssl2 --user2 str : User to login on host2. Mandatory. --password2 str : Password for the user2. --passfile1 str : Password file for the user1. It must contain the password on the first line. This option avoids to show the password on the command line like --password1 does. --passfile2 str : Password file for the user2. Contains the password. --ssl1 : Use a SSL connection on host1. --ssl2 : Use a SSL connection on host2. --tls1 : Use a TLS connection on host1. --tls2 : Use a TLS connection on host2. --debugssl int : SSL debug mode from 0 to 4. --timeout1 int : Connection timeout in seconds for host1. Default is 120 and 0 means no timeout at all. --timeout2 int : Connection timeout in seconds for host2. Default is 120 and 0 means no timeout at all. --authmech1 str : Auth mechanism to use with host1: PLAIN, LOGIN, CRAM-MD5 etc. Use UPPERCASE. --authmech2 str : Auth mechanism to use with host2. See --authmech1 --authuser1 str : User to auth with on host1 (admin user). Avoid using --authmech1 SOMETHING with --authuser1. --authuser2 str : User to auth with on host2 (admin user). --proxyauth1 : Use proxyauth on host1. Requires --authuser1. Required by Sun/iPlanet/Netscape IMAP servers to be able to use an administrative user. --proxyauth2 : Use proxyauth on host2. Requires --authuser2. --authmd51 : Use MD5 authentification for host1. --authmd52 : Use MD5 authentification for host2. --domain1 str : Domain on host1 (NTLM authentication). --domain2 str : Domain on host2 (NTLM authentication). --folder str : Sync this folder. --folder str : and this one, etc. --folderrec str : Sync this folder recursively. --folderrec str : and this one, etc. --folderfirst str : Sync this folder first. --folderfirst "Work" --folderfirst str : then this one, etc. --folderlast str : Sync this folder last. --folderlast "[Gmail]/All Mail" --folderlast str : then this one, etc. --nomixfolders : Do not merge folders when host1 is case sensitive while host2 is not (like Exchange). Only the first similar folder is synced (ex: Sent SENT sent -> Sent). --skipemptyfolders : Empty host1 folders are not created on host2. --include reg : Sync folders matching this regular expression --include reg : or this one, etc. in case both --include --exclude options are use, include is done before. --exclude reg : Skips folders matching this regular expression Several folders to avoid: --exclude 'fold1|fold2|f3' skips fold1, fold2 and f3. --exclude reg : or this one, etc. --subfolder2 str : Move whole host1 folders hierarchy under this host2 folder str . It does it by adding two --regextrans2 options before all others. Add --debug to see what's really going on. --automap : guesses folders mapping, for folders like "Sent", "Junk", "Drafts", "All", "Archive", "Flagged". --f1f2 str1=str2 : Force folder str1 to be synced to str2, --f1f2 overrides --automap and --regextrans2. --regextrans2 reg : Apply the whole regex to each destination folders. --regextrans2 reg : 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. Have in mind that --regextrans2 is applied after prefix and separator inversion. For examples see http://imapsync.lamiral.info/FAQ.d/FAQ.Folders_Mapping.txt --tmpdir str : Where to store temporary files and subdirectories. Will be created if it doesn't exist. Default is system specific, Unix is /tmp but it's often small and deleted at reboot. --tmpdir /var/tmp should be better. --pidfile str : The file where imapsync pid is written. --pidfilelocking : Abort if pidfile already exists. Usefull to avoid concurrent transfers on the same mailbox. --nolog : Turn off logging on file --logfile str : Change the default log filename (can be dirname/filename). --logdir str : Change the default log directory. Default is LOG_imapsync --prefix1 str : Remove prefix to all destination folders (usually INBOX. or INBOX/ or an empty string "") you have to use --prefix1 if host1 imap server does not have NAMESPACE capability, so imapsync suggests to use it. All other cases are bad. --prefix2 str : Add prefix to all host2 folders. See --prefix1 --sep1 str : Host1 separator in case NAMESPACE is not supported. --sep2 str : Host2 separator in case NAMESPACE is not supported. --skipmess reg : Skips messages maching the regex. Example: 'm/[\x80-ff]/' # to avoid 8bits messages. --skipmess is applied before --regexmess --skipmess reg : or this one, etc. --pipemess cmd : Apply this cmd command to each message content before the copy. --pipemess cmd : and this one, etc. --disarmreadreceipts : Disarms read receipts (host2 Exchange issue) --regexmess reg : Apply the whole regex to each message before transfer. Example: 's/\000/ /g' # to replace null by space. --regexmess reg : and this one, etc. --regexflag reg : Apply the whole regex to each flags list. Example: 's/"Junk"//g' # to remove "Junk" flag. --regexflag reg : and this one, etc. --delete : Deletes messages on host1 server after a successful transfer. Option --delete has the following behavior: it marks messages as deleted with the IMAP flag \Deleted, then messages are really deleted with an EXPUNGE IMAP command. --delete2 : Delete messages in host2 that are not in host1 server. Useful for backup or pre-sync. --delete2duplicates : Delete messages in host2 that are duplicates. Works only without --useuid since duplicates are detected with an header part of each message. --delete2folders : Delete folders in host2 that are not in host1 server. For safety, first try it like this (it is safe): --delete2folders --dry --justfolders --nofoldersizes --delete2foldersonly reg : Deleted only folders matching regex. Example: --delete2foldersonly "/^Junk$|^INBOX.Junk$/" --delete2foldersbutnot reg : Do not delete folders matching regex. Example: --delete2foldersbutnot "/Tasks$|Contacts$|Foo$/" --noexpunge : Do not expunge messages on host1. Expunge really deletes messages marked deleted. Expunge is made at the beginning, on host1 only. Newly transferred messages are also expunged if option --delete is given. No expunge is done on host2 account (unless --expunge2) --expunge1 : Expunge messages on host1 after messages transfer. --expunge2 : Expunge messages on host2 after messages transfer. --uidexpunge2 : uidexpunge messages on the host2 account that are not on the host1 account, requires --delete2 --nomixfolders : Avoid merging folders that are considered different on host1 but the same on destination host2 because of case sensitivities and insensitivities. --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. --maxsize int : Skip messages larger (or equal) than int bytes --minsize int : Skip messages smaller (or equal) than int bytes --maxage int : Skip messages older than int days. final stats (skipped) don't count older messages see also --minage --minage int : Skip messages newer than int 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) --search str : Selects only messages returned by this IMAP SEARCH command. Applied on both sides. --search1 str : Same as --search for selecting host1 messages only. --search2 str : Same as --search for selecting host2 messages only. --search CRIT equals --search1 CRIT --search2 CRIT --exitwhenover int : Stop syncing when total bytes transferred reached. Gmail per day allows 2500000000 = 2.5 GB downloaded from Gmail as host2 500000000 = 500 MB uploaded to Gmail as host1. --maxlinelength int : skip messages with a line length longer than int bytes. RFC 2822 says it must be no more than 1000 bytes. --useheader str : Use this header to compare messages on both sides. Ex: Message-ID or Subject or Date. --useheader str and this one, etc. --subscribed : Transfers subscribed folders. --subscribe : Subscribe to the folders transferred on the host2 that are subscribed on host1. On by default. --subscribeall : 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. --nofoldersizesatend: Do not calculate the size of each folder in bytes and message counts at the end. Default is on. --justfoldersizes : Exit after having printed the folder sizes. --syncacls : Synchronises acls (Access Control Lists). --nosyncacls : Does not synchronize acls. This is the default. Acls in IMAP are not standardized, be careful. --usecache : Use cache to speedup. --nousecache : Do not use cache. Caveat: --useuid --nousecache creates duplicates on multiple runs. --useuid : Use uid instead of header as a criterium to recognize messages. Option --usecache is then implied unless --nousecache is used. --debug : Debug mode. --debugfolders : Debug mode for the folders part only. --debugcontent : Debug content of the messages transfered. Huge ouput. --debugflags : Debug mode for flags. --debugimap1 : IMAP debug mode for host1. Very verbose. --debugimap2 : IMAP debug mode for host2. Very verbose. --debugimap : IMAP debug mode for host1 and host2. --debugmemory : Debug mode showing memory consumption after each copy. --errorsmax int : Exit when int number of errors is reached. Default is 50. --tests : Run local non-regression tests. Exit code 0 means all ok. --testslive : Run a live test with test1.lamiral.info imap server. Useful to check the basics. Needs internet connexion. --version : Print only software version. --noreleasecheck : Do not check for new imapsync release (a http request). --releasecheck : Check for new imapsync release (a http request). --noid : Do not send/receive ID command to imap servers. --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 : Do only things about folders (ignore messages). --help : print this help. Example: to synchronize imap account "test1" on "test1.lamiral.info" to imap account "test2" on "test2.lamiral.info" with test1 password "secret1" and test2 password "secret2" D:\IMAPSync\imapsync-imapsync-1.678\W\imapsync.exe ^ --host1 test1.lamiral.info --user1 test1 --password1 secret1 ^ --host2 test2.lamiral.info --user2 test2 --password2 secret2 Here is a [MSWin32] system (Windows NT Fronik 6.2 Build 9200 x86) With perl 5.22.2 Mail::IMAPClient 3.38 $Id: imapsync,v 1.678 2016/01/21 19:47:02 gilles Exp gilles $ New imapsync release 1.684 available Homepage: http://imapsync.lamiral.info/ 

   
   
   If everything is so, there are no errors, then the application is ready, you can use it.
   

IMAP mail transfer between servers

1. We copy our application \ W \ imapsync.exe in \ examples \ imapsync.exe. In the \ examples folder we are interested in several files:
   
   • imapsync_example.bat - testing transfer settings and mail transfer for one mailbox
   • sync_loop_windows.bat and file.txt - mail transfer for mailboxes
   
   
2. Preparation, testing, transfer of one box:
   Open the imapsync_example.bat file and prescribe our details and parameters:
   

    .\imapsync.exe ^ --host1 mx.example.ru --user1 user@example.ru --password1 "Pass123" ^ --host2 imap.yandex.ru --user2 user@example.biz --password2 "Pass123" ^ --ssl1 --ssl2 --sslargs1 SSL_verify_mode=0 --sslargs2 SSL_verify_mode=1 --skipheader "^(?!Message-Id)" --automap ^ --regextrans2 "s/^INBOX\.(.+)/$1/" --justfolders --dry @PAUSE 

   A small description of the parameters

   Source server, mailbox login, mailbox password:
   --host1 mx.example.ru --user1 user --password1 "Pass123"

   Destination server, mailbox login, mailbox password:
   --host2 imap.yandex.ru --user2 user@example.biz --password2 "Pass123"

   Using SSL for the source and destination server:
   --ssl1 --ssl2

   If SSL is enabled (--ssl1 --ssl2), then it is better to immediately configure the certificate verification mode.
   Accept any certificate (= 0), or authenticate (= 1).
   --sslargs1 SSL_verify_mode=0 --sslargs2 SSL_verify_mode=1

   I noticed that if you do not specify these settings, you may receive errors when transferring some letters, or the appearance of an error of this kind:
   Use of uninitialized value $sockargs[9] in join or string at Mail/IMAPClient.pm line 360.

   Ignore all the headers in the letter, except those that contain a "Message-Id". This parameter is useful in cases where different headers are generated for a single letter on different servers, in my case they are different. Yandex added one extra line for each letter, which was why letters were duplicated with each subsequent mail transfer. If you filter the headers by "Message-Id", then each time mail is transferred, only new messages are copied.
   --skipheader "^(?!Message-Id)"

   Automatically identify and link folders on the source server to folders on the destination server. It compares the names and creates bindings, maintains folders with Cyrillic in the names. Inbox-> Inbox. Sent -> Sent ...
   --automap

   Removes from the name INBOX in all destination folders. In my case, IDECO calls all folders starting with INBOX (INBOX.Sent, INBOX.Drafts, etc.). To avoid creating duplicate names in the destination server for folders that were manually created by the user. It is worth noting that it still depends on the server.
   --regextrans2 "s/^INBOX\.(.+)/$1/"

   Perform operations only for folders. Letters are not transferable.
   --justfolders

   Emulation run. The entire work plan will be shown, but nothing is physically transferred. Convenient for testing.
   --dry

   
   
   After reading the description, we launch and check how the binding of our folders occurred. If everything is successful - great. If not, you can use the manual binding options. For example, the parameters below create a binding of the “INBOX.Junk” and “INBOX.Spam” folders to the “Deleted” folder.
   

    --f1f2 "INBOX.Junk"="&BCMENAQwBDsENQQ9BD0ESwQ1-" --f1f2 "INBOX.Spam"="&BCMENAQwBDsENQQ9BD0ESwQ1-" 

   
   Here we are faced with the encoding. To determine how the Cyrillic folders should be called, you need to look at the logs ( LOG_imapsync \ *. Txt ), which are created after each program execution.
   

    Folders mapping from --automap feature (use --f1f2 to override any mapping): [INBOX.Junk] -> [&BCEEPwQwBDw-] = [] [INBOX.Spam] -> [&BCEEPwQwBDw-] = [] [INBOX.Sent] -> [&BB4EQgQ,BEAEMAQyBDsENQQ9BD0ESwQ1-] = [] [INBOX.Drafts] -> [&BCcENQRABD0EPgQyBDgEOgQ4-] = [] [INBOX.Trash] -> [&BCMENAQwBDsENQQ9BD0ESwQ1-] = [] 

   
   Well, here everything is clear and understandable, and the program itself suggests that we create a manual binding, if necessary.
   After the run, making sure everything looks good, delete the parameter:
   

    --dry 

   
   We start, and check how folders were created on our destination server. For now we only check folders. If required, make changes to the bindings. If everything looks as we need, great, go to the letters. Delete the parameter:
   

    --justfolders 

   
   We launch and check how folders are created and letters are transferred to our destination server. Also make the necessary changes if necessary. If we needed to transfer only one box, then we’re done for this. If you need to transfer more, then go to the next item.
   
   
3. Migrate mail for multiple mailboxes.
   Open the file file.txt . This file contains a good description and a real example to demonstrate the work. With filling difficulties should arise. Let's comment out all the examples in it, and write our data below. We list all our boxes we want to transfer.
   

    mx.example.ru;user;Pass123;imap.yandex.ru;user@example.biz;Pass123 mx.example.ru;user2;Pass321;imap.yandex.ru;user2@example.biz;Pass321 

   
   Open the sync_loop_windows.bat file for editing, and after the lines:
   

    imapsync ^ --host1 %%G --user1 %%H --password1 %%I ^ --host2 %%J --user2 %%K --password2 %%L %arguments% 

   
   We add our parameters, not forgetting the “^” character at the end of the line after% arguments%, we end up with:
   

    imapsync ^ --host1 %%G --user1 %%H --password1 %%I ^ --host2 %%J --user2 %%K --password2 %%L %arguments% ^ --ssl1 --ssl2 --sslargs1 SSL_verify_mode=0 --sslargs2 SSL_verify_mode=1 --skipheader "^(?!Message-Id)" --automap ^ --regextrans2 "s/^INBOX\.(.+)/$1/" --justfolders --dry 

   
   Save and run. We check how the processing went and delete the parameters --justfolders --dry to start the real transfer of all folders and letters.
   Now it only remains to wait for the completion of the mailbox transfer and check the logs. For each mailbox will create its own log.
   

Addition

• In the \ examples \ FAQ.d folder there is an excellent FAQ with examples.
• When experimenting with headers, the "--debug" parameter will help. This mode shows the contents of all the headers of each letter.
• You can use the same server as the source and destination server, for example, to remove duplicates.