zydronium/imapsync
1
0
Fork 0
mirror of https://github.com/imapsync/imapsync.git synced 2025-07-26 03:48:17 +02:00
Code Issues Projects Releases Packages Wiki Activity

1.836

Browse source
This commit is contained in:
Nick Bebout 2017-09-23 16:54:48 -05:00
parent 3afeea4a16
commit 8d76e44c5e
243 changed files with 57452 additions and 10330 deletions
Download patch file Download diff file Expand all files Collapse all files

664
W/imapsync.1
View file

@ -1,4 +1,4 @@
.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" Standard preamble:
.\" ========================================================================
@ -133,21 +133,20 @@
.\" ========================================================================
.\"
.IX Title "IMAPSYNC 1"
.TH IMAPSYNC 1 "2016-08-19" "perl v5.18.2" "User Contributed Perl Documentation"
.TH IMAPSYNC 1 "2017-09-05" "perl v5.22.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
imapsync \- Email IMAP tool for syncing, copying and migrating email mailboxes.
.PP
The imapsync command synchronises mailboxes between two imap servers.
More than 69 different IMAP server softwares supported with success,
few failures.
.PP
$Revision: 1.727 $
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
imapsync \- Email IMAP tool for syncing, copying and migrating
email mailboxes between two imap servers, one way,
and without duplicates.
.SH "VERSION"
.IX Header "VERSION"
This documentation refers to Imapsync \f(CW$Revision:\fR 1.836 $
.SH "USAGE"
.IX Header "USAGE"
.Vb 5
\& To synchronize the source imap account
\& "test1" on server "test1.lamiral.info" with password "secret1"
@ -159,86 +158,104 @@ $Revision: 1.727 $
\& \-\-host1 test1.lamiral.info \-\-user1 test1 \-\-password1 secret1 \e
\& \-\-host2 test2.lamiral.info \-\-user2 test2 \-\-password2 secret2
.Ve
.SH "REQUIRED ARGUMENTS"
.IX Header "REQUIRED ARGUMENTS"
The required argmuments are the six values, three on each sides,
needed to login into the \s-1IMAP\s0 servers,
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
We sometimes need to transfer mailboxes from one imap server to
another.
.PP
Imapsync command is a tool allowing incremental and
recursive imap transfers from one mailbox to another.
.PP
By default all folders are transferred, recursively, meaning
the whole folder hierarchy is taken, all messages in them,
and all messages flags (\eSeen \eAnswered \eFlagged etc.)
are synced too.
.PP
Imapsync reduces the amount
of data transferred by not transferring a given message
if it resides already on both sides. Same specific headers
and the transfer is done only once (by default it's
\&\*(L"Message-Id:\*(R" and \*(L"Received:\*(R" lines but it can be changed with
\&\-\-useheader option).
.PP
All flags are preserved, unread will stay unread, read will stay read,
deleted will stay deleted.
.PP
You can stop the transfer at any
time and restart it later, imapsync works well with bad
connections and interruptions.
.PP
You can decide to delete the messages from the source mailbox
after a successful transfer, it can be a good feature when migrating
live mailboxes since messages will be only on one side.
In that case, use the \-\-delete1 option. Option \-\-delete1 implies
also option \-\-expunge1 so all messages marked deleted on host1
will be really deleted.
.PP
A different scenario is synchronizing a mailbox B from another mailbox A
in case you just want to keep a \*(L"live\*(R" copy of A in B.
In that case \-\-delete2 has to be used, it deletes messages in host2
folder B that are not in host1 folder A. If you also need to destroy
host2 folders that are not in host1 then use \-\-delete2folders (see also
\&\-\-delete2foldersonly and \-\-delete2foldersbutnot).
.PP
Imapsync is not adequate for maintaining two active imap accounts
in synchronization when the user plays independently on both sides.
Use offlineimap (written by John Goerzen) or mbsync (written by
Michael R. Elkins) for a 2 ways synchronization.
.SH "OPTIONS"
.IX Header "OPTIONS"
.Vb 1
\& usage: imapsync [options]
.Ve
.PP
Mandatory options are the six values, three on each sides,
needed to log in into the \s-1IMAP\s0 servers, ie,
a host, a username, and a password, two times.
.SH "INSTALL"
.IX Header "INSTALL"
.Vb 5
\& Imapsync works under any Unix with perl.
\& Imapsync works under Windows (2000, XP, Vista, Seven)
\& as a standalone binary software called imapsync.exe
\& Imapsync works under OS X as a standalone binary
\& software called imapsync_bin_Darwin.
\&
\& Purchase latest imapsync at
\& http://imapsync.lamiral.info/
\&
\& You\*(Aqll receive a link to 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.
\& As mentioned at http://imapsync.lamiral.info/#install
\& the INSTALL file can also be found at
\& http://imapsync.lamiral.info/INSTALL
\& It is now split in several files for each system
\& http://imapsync.lamiral.info/INSTALL.d/
.Ve
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
There is no specific configuration file for imapsync,
everything is specified by the command line parameteres
and the default behavior.
.SH "USAGE"
.IX Header "USAGE"
To get a description of each option just run imapsync
with no argument, like this:
.PP
.Vb 1
\& imapsync
.Ve
Conventions used:
.PP
This description of options is also available at
http://imapsync.lamiral.info/OPTIONS and is
reproduced here:
.PP
.Vb 1
\& usage: ./imapsync [options]
\&
\& Several options are mandatory.
.Vb 4
\& 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.
\&
\& \-\-dry : Makes imapsync doing nothing for real, just print what
\& would be done without \-\-dry.
.Ve
.SS "OPTIONS/credentials"
.IX Subsection "OPTIONS/credentials"
.Vb 8
\& \-\-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.
\&
\& \-\-showpasswords : Shows passwords on output instead of "MASKED".
\& Useful to restart a complete run by just reading the log,
\& or to debug passwords. It\*(Aqs not a secure practice.
\&
\& \-\-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.
.Ve
.SS "OPTIONS/encryption"
.IX Subsection "OPTIONS/encryption"
.Vb 10
\& \-\-nossl1 : Do not use a SSL connection on host1.
\& \-\-ssl1 : Use a SSL connection on host1. On by default if possible.
\& \-\-nossl2 : Do not use a SSL connection on host2.
\& \-\-ssl2 : Use a SSL connection on host2. On by default if possible.
\& \-\-notls1 : Do not use a TLS connection on host1.
\& \-\-tls1 : Use a TLS connection on host1. On by default if possible.
\& \-\-notls2 : Do not use a TLS connection on host2.
\& \-\-tls2 : Use a TLS connection on host2. On by default if possible.
\& \-\-debugssl int : SSL debug mode from 0 to 4.
\& \-\-sslargs1 str : Pass any ssl parameter for host1 ssl or tls connection. Example:
\& \-\-sslargs1 SSL_verify_mode=1 \-\-sslargs1 SSL_version=SSLv3
@ -251,7 +268,10 @@ reproduced here:
\& 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.
\&
.Ve
.SS "OPTIONS/authentication"
.IX Subsection "OPTIONS/authentication"
.Vb 3
\& \-\-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
@ -264,12 +284,14 @@ reproduced here:
\& 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.
\& \-\-authmd51 : Use MD5 authentication for host1.
\& \-\-authmd52 : Use MD5 authentication for host2.
\& \-\-domain1 str : Domain on host1 (NTLM authentication).
\& \-\-domain2 str : Domain on host2 (NTLM authentication).
\&
\&
.Ve
.SS "OPTIONS/folders"
.IX Subsection "OPTIONS/folders"
.Vb 4
\& \-\-folder str : Sync this folder.
\& \-\-folder str : and this one, etc.
\& \-\-folderrec str : Sync this folder recursively.
@ -280,17 +302,16 @@ reproduced here:
\& \-\-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
\& \-\-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.
\&
\& \-\-f1f2 str1=str2 : Force folder str1 to be synced to str2.
\& \-\-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.
\& If both \-\-include \-\-exclude options are used, then
\& include is done before.
\& \-\-exclude reg : Skips folders matching this regular expression
\& Several folders to avoid:
\& \-\-exclude \*(Aqfold1|fold2|f3\*(Aq skips fold1, fold2 and f3.
@ -301,37 +322,73 @@ reproduced here:
\& It does it by adding two \-\-regextrans2 options before
\& all others. Add \-\-debug to see what\*(Aqs 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.
\&
\& \-\-nomixfolders : Avoid merging folders that are considered different on
\& host1 but the same on destination host2 because of
\& case sensitivities and insensitivities.
\&
\& \-\-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.
\&
\& \-\-prefix1 str : Remove prefix str to all destination folders,
\& usually INBOX. or INBOX/ or an empty string "".
\& imapsync guesses the prefix if host1 imap server
\& does not have NAMESPACE capability. This option
\& should not be used, most of the time.
\& \-\-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.
\&
\& \-\-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.
\&
\& and separator inversion. For examples see
\& http://imapsync.lamiral.info/FAQ.d/FAQ.Folders_Mapping.txt
.Ve
.SS "OPTIONS/folders sizes"
.IX Subsection "OPTIONS/folders sizes"
.Vb 5
\& \-\-nofoldersizes : Do not calculate the size of each folder at the
\& beginning of the sync. Default is to calculate them.
\& \-\-nofoldersizesatend: Do not calculate the size of each folder at the
\& end of the sync. Default is to calculate them.
\& \-\-justfoldersizes : Exit after having printed the initial folder sizes.
.Ve
.SS "OPTIONS/tmp"
.IX Subsection "OPTIONS/tmp"
.Vb 10
\& \-\-tmpdir str : Where to store temporary files and subdirectories.
\& Will be created if it doesn\*(Aqt exist.
\& Default is system specific, Unix is /tmp but
\& it\*(Aqs often small and deleted at reboot.
\& /tmp is often too 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
\& \-\-pidfile str : The file where imapsync pid is written,
\& it can be dirname/filename.
\& Default name is imapsync.pid in tmpdir.
\& \-\-pidfilelocking : Abort if pidfile already exists. Useful to avoid
\& concurrent transfers on the same mailbox.
\&
.Ve
.SS "OPTIONS/log"
.IX Subsection "OPTIONS/log"
.Vb 3
\& \-\-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.
\& \-\-logdir str : Change the default log directory. Default is LOG_imapsync/
.Ve
.SS "OPTIONS/messages"
.IX Subsection "OPTIONS/messages"
.Vb 4
\& \-\-skipmess reg : Skips messages matching the regex.
\& Example: \*(Aqm/[\ex80\-ff]/\*(Aq # to avoid 8bits messages.
\& \-\-skipmess is applied before \-\-regexmess
\& \-\-skipmess reg : or this one, etc.
@ -345,16 +402,33 @@ reproduced here:
\& \-\-regexmess reg : Apply the whole regex to each message before transfer.
\& Example: \*(Aqs/\e000/ /g\*(Aq # to replace null by space.
\& \-\-regexmess reg : and this one, etc.
\&
.Ve
.SS "OPTIONS/flags"
.IX Subsection "OPTIONS/flags"
.Vb 3
\& \-\-regexflag reg : Apply the whole regex to each flags list.
\& Example: \*(Aqs/"Junk"//g\*(Aq # 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:
\& \-\-regexflag reg : then this one, etc.
.Ve
.SS "OPTIONS/deletions"
.IX Subsection "OPTIONS/deletions"
.Vb 10
\& \-\-delete1 : Deletes messages on host1 server after a successful
\& transfer. Option \-\-delete1 has the following behavior:
\& it marks messages as deleted with the IMAP flag
\& \eDeleted, then messages are really deleted with an
\& EXPUNGE IMAP command.
\& EXPUNGE IMAP command. If expunging after each message
\& slows down too much the sync then use
\& \-\-noexpungeaftereach to speed up.
\& \-\-expunge1 : Expunge messages on host1 just before syncing a folder.
\& Expunge is done per folder.
\& Expunge aims is to really delete messages marked deleted.
\& An expunge is also done after each message copied
\& if option \-\-delete1 is set.
\& \-\-noexpunge1 : Do not expunge messages on host1.
\& \-\-delete1emptyfolders : Deletes empty folders on host1, INBOX excepted.
\& Useful with \-\-delete1 since what remains on host1
\& is only what failed to be synced.
\&
\& \-\-delete2 : Delete messages in host2 that are not in
\& host1 server. Useful for backup or pre\-sync.
@ -369,26 +443,23 @@ reproduced here:
\& 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.
\&
.Ve
.SS "OPTIONS/dates"
.IX Subsection "OPTIONS/dates"
.Vb 5
\& \-\-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.
\&
.Ve
.SS "OPTIONS/message selection"
.IX Subsection "OPTIONS/message selection"
.Vb 12
\& \-\-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.
@ -408,44 +479,34 @@ reproduced here:
\& \-\-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.
\& \-\-usecache : Use cache to speed up the sync.
\& \-\-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.
\&
.Ve
.SS "OPTIONS/miscelaneous"
.IX Subsection "OPTIONS/miscelaneous"
.Vb 3
\& \-\-syncacls : Synchronizes acls (Access Control Lists).
\& \-\-nosyncacls : Does not synchronize acls. This is the default.
\& Acls in IMAP are not standardized, be careful.
.Ve
.SS "OPTIONS/debugging"
.IX Subsection "OPTIONS/debugging"
.Vb 8
\& \-\-debug : Debug mode.
\& \-\-debugfolders : Debug mode for the folders part only.
\& \-\-debugcontent : Debug content of the messages transfered. Huge ouput.
\& \-\-debugcontent : Debug content of the messages transferred. Huge output.
\& \-\-debugflags : Debug mode for flags.
\& \-\-debugimap1 : IMAP debug mode for host1. Very verbose.
\& \-\-debugimap2 : IMAP debug mode for host2. Very verbose.
@ -457,6 +518,40 @@ reproduced here:
\& \-\-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.
\& \-\-testslive6 : Run a live test with ks2ipv6.lamiral.info imap server.
\& Useful to check the ipv6 connectivity. Needs internet.
.Ve
.SS "OPTIONS/specific"
.IX Subsection "OPTIONS/specific"
.Vb 2
\& \-\-gmail1 : sets \-\-host1 to Gmail and options from FAQ.Gmail.txt
\& \-\-gmail2 : sets \-\-host2 to Gmail and options from FAQ.Gmail.txt
\&
\& \-\-office1 : sets \-\-host1 to Office365 options from FAQ.Exchange.txt
\& \-\-office2 : sets \-\-host2 to Office365 options from FAQ.Exchange.txt
\&
\& \-\-exchange1 : sets options from FAQ.Exchange.txt, account1 part
\& \-\-exchange2 : sets options from FAQ.Exchange.txt, account2 part
\&
\& \-\-domino1 : sets options from FAQ.Domino.txt, account1 part
\& \-\-domino2 : sets options from FAQ.Domino.txt, account2 part
.Ve
.SS "OPTIONS/behavior"
.IX Subsection "OPTIONS/behavior"
.Vb 1
\& \-\-maxmessagespersecond int : limits the number of messages transferred per second.
\&
\& \-\-maxbytespersecond int : limits the average transfer rate per second.
\& \-\-maxbytesafter int : starts \-\-maxbytespersecond limitation only after
\& \-\-maxbytesafter amount of data transferred.
\&
\& \-\-maxsleep int : do not sleep more than int seconds.
\& On by default, 2 seconds max, like \-\-maxsleep 2
\&
\& \-\-abort : terminates a previous call still running.
\& It uses the pidfile to know what processus to abort.
\&
\& \-\-exitwhenover int : Stop syncing when total bytes transferred reached.
\&
\& \-\-version : Print only software version.
\& \-\-noreleasecheck : Do not check for new imapsync release (a http request).
@ -470,97 +565,15 @@ reproduced here:
\&
\& \-\-help : print this help.
\&
\& Example:
\& To synchronize the source imap account
\& "test1" on server "test1.lamiral.info" with password "secret1"
\& to the destination imap account
\& "test2" on server "test2.lamiral.info" with password "secret2"
\& do:
\& 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"
\&
\& imapsync \e
\& \-\-host1 test1.lamiral.info \-\-user1 test1 \-\-password1 secret1 \e
\& \-\-host2 test2.lamiral.info \-\-user2 test2 \-\-password2 secret2
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Imapsync command is a tool allowing incremental and
recursive imap transfers from one mailbox to another.
.PP
By default all folders are transferred, recursively, all
possible flags (\eSeen \eAnswered \eFlagged etc.) are synced too.
.PP
We sometimes need to transfer mailboxes from one imap server to
another. This is called migration.
.PP
Imapsync reduces the amount
of data transferred by not transferring a given message
if it resides already on both sides. Same specific headers
and the transfer is done only once; taken into account are by default
Message-Id and Received header lines.
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 and interruptions.
.PP
You can decide to delete the messages from the source mailbox
after a successful transfer, it can be a good feature when migrating
live mailboxes since messages will be only on one side.
In that case, use the \-\-delete option. Option \-\-delete implies
also option \-\-expunge so all messages marked deleted on host1
will be really deleted.
(you can use \-\-noexpunge to avoid this but I don't see any
good real world scenario for the combination \-\-delete \-\-noexpunge).
.PP
A different scenario is synchronizing a mailbox B from another mailbox A
in case you just want to keep a \*(L"live\*(R" copy of A in B.
In that case \-\-delete2 has to be used, it deletes messages in host2
folder B that are not in host1 folder A. If you also need to destroy
host2 folders that are not in host1 then use \-\-delete2folders (see also
\&\-\-delete2foldersonly and \-\-delete2foldersbutnot).
.PP
Imapsync is not adequate for maintaining two active imap accounts
in synchronization when the user plays independently on both sides.
Use offlineimap (written by John Goerzen) or mbsync (written by
Michael R. Elkins) for 2 ways synchronizations.
.SH "OPTIONS"
.IX Header "OPTIONS"
To get a description of each option just invoke:
.PP
.Vb 1
\& imapsync
.Ve
.PP
or read the previous section named \s-1USAGE,\s0
.PP
or read http://imapsync.lamiral.info/OPTIONS
.SH "HISTORY"
.IX Header "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 its 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).
.SH "EXAMPLE"
.IX Header "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.
.PP
To synchronize the imap account \*(L"buddy\*(R" (with password \*(L"secret1\*(R")
on host \*(L"imap.src.fr\*(R" to the imap account \*(L"max\*(R" (with password \*(L"secret2\*(R")
on host \*(L"imap.dest.fr\*(R":
.PP
.Vb 2
\& imapsync \-\-host1 imap.src.fr \-\-user1 buddy \-\-password1 secret1 \e
\& \-\-host2 imap.dest.fr \-\-user2 max \-\-password2 secret2
.Ve
.PP
Then you will have max's mailbox updated from buddy's
mailbox.
.SH "SECURITY"
.IX Header "SECURITY"
You can use \-\-passfile1 instead of \-\-password1 to give the
@ -571,84 +584,42 @@ dangerous because of the 'ps auxwwwwe' command. So, saving
the password in a well protected file (600 or rw\-\-\-\-\-\-\-) is
the best solution.
.PP
imasync is not totally protected against sniffers on the
network since passwords may be transferred in plain text
if \s-1CRAM\-MD5\s0 is not supported by your imap servers. Use
\&\-\-ssl1 (or \-\-tls1) and \-\-ssl2 (or \-\-tls2) to enable
encryption on host1 and host2.
Imapsync activates ssl or tls encryption by default, if possible.
What details are under this \*(L"if possible\*(R"?
Imapsync activates ssl if the well known port imaps port (993) is open
on the imap servers. If the imaps port is closed then it open a
normal (clear) connection on port 143 but it looks for \s-1TLS\s0 support
in the \s-1CAPABILITY\s0 list of the servers. If \s-1TLS\s0 is supported
then imapsync goes to encryption.
.PP
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 \*(L"adminuser\*(R" to enable this on host1. In this
case, \-\-authmech1 \s-1PLAIN\s0 will be used by default since it
is the only way to go for now. So don't use \-\-authmech1 \s-1SOMETHING\s0
with \-\-authuser1 \*(L"adminuser\*(R", it will not work.
Same behavior with the \-\-authuser2 option.
Authenticate with an admin account must be supported by your
imap server to work with imapsync.
If the automatic ssl/tls detection fails then imapsync will
not protect against sniffing activities on the
network, especially for passwords.
.PP
When working on Sun/iPlanet/Netscape \s-1IMAP\s0 servers you must use
\&\-\-proxyauth1 to enable administrative user to masquerade as another user.
Can also be used on destination server with \-\-proxyauth2
.PP
You can authenticate with \s-1OAUTH\s0 when transfering from Google Apps.
The consumer key will be the domain part of the \-\-user, and the
\&\-\-password will be used as the consumer secret. It does not work
with Google Apps free edition.
See also the document \s-1FAQ\s0.Security.txt in the \s-1FAQ\s0.d/ directory
or at https://imapsync.lamiral.info/FAQ.d/FAQ.Security.txt
.SH "EXIT STATUS"
.IX Header "EXIT STATUS"
imapsync will exit with a 0 status (return code) if everything went good.
Imapsync will exit with a 0 status (return code) if everything went good.
Otherwise, it exits with a non-zero status.
.PP
So if you have an unreliable internet connection, you can use this loop
in a Bourne shell:
.PP
.Vb 3
\& while ! imapsync ...; do
\& echo imapsync not complete
\& done
.Ve
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
imapsync is free, open, public but not always gratis software
Imapsync is free, open, public but not always gratis software
cover by the \s-1NOLIMIT\s0 Public License.
See the \s-1LICENSE\s0 file included in the distribution or just read this
simple sentence as it is the licence text:
simple sentence as it \s-1IS\s0 the licence text:
.PP
.Vb 1
\& "No limit to do anything with this work and this license."
.Ve
.PP
In case it is not long enough I repeat:
In case it is not long enough, I repeat:
.PP
.Vb 1
\& "No limit to do anything with this work and this license."
.Ve
.SH "MAILING-LIST"
.IX Header "MAILING-LIST"
The public mailing-list may be the best way to get free support.
.PP
To write on the mailing-list, the address is:
<imapsync@linux\-france.org>
.PP
To subscribe, send any message (even empty) to:
<imapsync\-subscribe@listes.linux\-france.org>
then just reply to the confirmation message.
.PP
To unsubscribe, send a message to:
<imapsync\-unsubscribe@listes.linux\-france.org>
.PP
To contact the person in charge for the list:
<imapsync\-request@listes.linux\-france.org>
.PP
The list archives are 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.
.PP
Thank you for your participation.
https://imapsync.lamiral.info/LICENSE
.SH "AUTHOR"
.IX Header "AUTHOR"
Gilles \s-1LAMIRAL\s0 <gilles.lamiral@laposte.net>
@ -657,80 +628,22 @@ Feedback good or bad is very often welcome.
.PP
Gilles \s-1LAMIRAL\s0 earns his living by writing, installing,
configuring and teaching free, open and often gratis
softwares. It used to be \*(L"always gratis\*(R" but now it is
\&\*(L"often\*(R" because imapsync is sold by its author, a good
way to stay maintening and supporting free open public
softwares (see the license) over decades.
software. Imapsync used to be \*(L"always gratis\*(R" but now it is
only \*(L"often gratis\*(R" because imapsync is sold by its author,
a good way to maintain and support free open public
software over decades.
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
Help me to help you: follow the following guidelines.
.PP
Report any bugs or feature requests to the public mailing-list
or to the author.
.PP
Before reporting bugs, read the FAQs, the \s-1README\s0 and the
\&\s-1TODO\s0 files. http://imapsync.lamiral.info/
.PP
Upgrade to last imapsync release, maybe the bug
is already fixed.
.PP
Upgrade to last Mail-IMAPClient Perl module.
http://search.cpan.org/dist/Mail\-IMAPClient/
maybe the bug is already fixed there.
.PP
Make a good title with word \*(L"imapsync\*(R" in it (my spam filters won't filter it),
Try to write an email title with more words than just \*(L"imapsync\*(R" or \*(L"problem\*(R",
a good title is made of keywords summary, but not too long (one visible line).
.PP
Help us to help you: in your report, please include:
.PP
.Vb 1
\& \- imapsync version.
\&
\& \- output near the first failures, a few lines before is good to get the context
\& of the issue. First failures messages are often more significant than
\& the last ones.
\&
\& \- if the issue is always related to the same messages, include the output
\& with \-\-debug \-\-debugimap, near the failure point. For example,
\& Isolate a buggy message or two in a folder \*(AqBUG\*(Aq and use
\&
\& imapsync ... \-\-folder \*(AqBUG\*(Aq \-\-debug \-\-debugimap
\&
\& \- imap server softwares on both sides 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.
\&
\& \- the run context. Do you run imapsync.exe, a unix binary
\& or the perl script imapsync.
\&
\& \- operating system running imapsync.
\&
\& \- virtual software context (vmware, xen etc.)
\&
\& \- operating systems on both sides and the third side in case
\& you run imapsync on a foreign host from the both.
.Ve
.PP
Most of those values can be found as a copy/paste at the begining of the output,
so a carbon copy of the output is a very easy and very good debug report for me.
.PP
One time in your life, read the paper
\&\*(L"How To Ask Questions The Smart Way\*(R"
http://www.catb.org/~esr/faqs/smart\-questions.html
and then forget it.
.SH "IMAP SERVERS"
.IX Header "IMAP SERVERS"
See http://imapsync.lamiral.info/S/imapservers.shtml
See https://imapsync.lamiral.info/FAQ.d/FAQ.Reporting_Bugs.txt
.SH "IMAP SERVERS supported"
.IX Header "IMAP SERVERS supported"
See https://imapsync.lamiral.info/S/imapservers.shtml
.SH "HUGE MIGRATION"
.IX Header "HUGE MIGRATION"
Pay special attention to options
\&\-\-subscribed
\&\-\-subscribe
\&\-\-delete
\&\-\-delete1
\&\-\-delete2
\&\-\-delete2folders
\&\-\-maxage
@ -771,17 +684,43 @@ On Windows the batch program can be:
.Ve
.PP
The ... have to be replaced by nothing or any imapsync option.
Welcome in shell programming !
Welcome in shell or batch programming !
.PP
You will find already written scripts at
http://imapsync.lamiral.info/examples/
.SH "INSTALL"
.IX Header "INSTALL"
.Vb 5
\& Imapsync works under any Unix with perl.
\& Imapsync works under Windows (2000, XP, Vista, Seven)
\& as a standalone binary software called imapsync.exe
\& Imapsync works under OS X as a standalone binary
\& software called imapsync_bin_Darwin.
\&
\& Purchase latest imapsync at
\& http://imapsync.lamiral.info/
\&
\& You\*(Aqll receive a link to 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.
\& As mentioned at http://imapsync.lamiral.info/#install
\& the INSTALL file can also be found at
\& http://imapsync.lamiral.info/INSTALL
\& It is now split in several files for each system
\& http://imapsync.lamiral.info/INSTALL.d/
.Ve
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
There is no specific configuration file for imapsync,
everything is specified by the command line parameters
and the default behavior.
.SH "HACKING"
.IX Header "HACKING"
Feel free to hack imapsync as the \s-1NOLIMIT\s0 license permits it.
.SH "LINKS"
.IX Header "LINKS"
Entries for imapsync:
https://web.archive.org/web/20070202005121/http://www.imap.org/products/showall.php
.SH "SIMILAR SOFTWARES"
.IX Header "SIMILAR SOFTWARES"
.Vb 10
@ -803,5 +742,14 @@ https://web.archive.org/web/20070202005121/http://www.imap.org/products/showall.
.Ve
.PP
Feedback (good or bad) will often be welcome.
.PP
\&\f(CW$Id:\fR imapsync,v 1.727 2016/08/19 10:30:36 gilles Exp gilles $
.SH "HISTORY"
.IX Header "HISTORY"
I wrote imapsync because an enterprise (basystemes) paid me to install
a new imap server without losing huge old mailboxes located in 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 then delete it after a good
transfer. Imapsync started its life as a patch of the copy_folder.pl
script. The script copy_folder.pl comes from the Mail\-IMAPClient\-2.1.3 perl
module tarball source (more precisely in the examples/ directory of the
Mail-IMAPClient tarball).