Zimbra Migration: IMAPSync - Revision history

Whiteinge: Break "TIPS" out into own section; add a few imapsync flags helpful for working with Gmail

2019-04-01T01:30:59Z

Break "TIPS" out into own section; add a few imapsync flags helpful for working with Gmail

← Older revision		Revision as of 19:30, 31 March 2019
Line 41:		Line 41:
	--syncinternaldates --subscribe		--syncinternaldates --subscribe

	TIPS:		= TIPS =

	~~When importing to Zimbra we find that IMAPsync seems to struggle~~ with ~~flags~~.		We suggest considering the following options for use with your script.

	~~We suggest considering the following for use~~ with ~~your script~~:		When importing to Zimbra we find that IMAPsync seems to struggle with flags:

	--regexflag "s/:FLAG/_FLAG/g"		--regexflag "s/:FLAG/_FLAG/g"

			The exclusion of the Trash and Junk mail folders in particular can be quite a time saver depending on the originating server settings and your organizational requirements:

	--exclude "Emailed Contacts"		--exclude "Emailed Contacts"
	--exclude "Trash"		--exclude "Trash"
	--exclude "Junk"		--exclude "Junk"
	~~--addheader~~

	The ~~exclusion~~ of the ~~Trash~~ and ~~Junk mail~~ folders ~~in particular~~ can be quite a ~~time saver depending on~~ the ~~originating server settings~~ and your ~~organizational requirements~~.		If you retain Hangouts messages those ''may'' not transfer cleanly to an IMAP folder:

			--exclude "Chats"

			The following two options together help imapsync determine a message uniquely:

			--useheader="X-Gmail-Received"
			--useheader="Message-Id"

			Because of the way Gmail and Google Apps use labels instead of traditional imap folders it is possible for an email to be duplicated across multiple folders. This can use quite a lot of additional storage space if you make heavy use of labels. The following option will see a unique message (in conjunction with the two uniqueness options above) and only copy it only once. If you rely or prefer a message to have multiple labels omit this option, just note that you will have multiple copies of that message, one in each imap folder:

			--skipcrossduplicates

			The option above will copy the message into the folder of the corresponding label that imapsync encounters first. For that reason imapsync has several options to change what order folders/labels are processed. You will likely want the following option since Gmail will put all messages under this label and you will lose any other label:

			--folderlast "[Gmail]/All Mail"

			If you have already run your script and decide you do not want duplicate messages after all the following option will delete any duplicate messages that it finds on the "host2" host (note the "2" in the option name). This option may be dangerous without the two uniqueness options mentioned above:

			--delete2duplicates

	= Google Apps Admin Account Logins =		= Google Apps Admin Account Logins =

John: /* IMAP Admin Account Logins */

2018-12-13T18:10:11Z

IMAP Admin Account Logins

← Older revision		Revision as of 12:10, 13 December 2018
Line 50:		Line 50:
	--exclude "Emailed Contacts"		--exclude "Emailed Contacts"
	--exclude "Trash"		--exclude "Trash"
			--exclude "Junk"
	--addheader		--addheader

			The exclusion of the Trash and Junk mail folders in particular can be quite a time saver depending on the originating server settings and your organizational requirements.

	= Google Apps Admin Account Logins =		= Google Apps Admin Account Logins =

John: /* IMAP Admin Account Logins */

2018-12-13T18:02:56Z

IMAP Admin Account Logins

@@ Line 40: / Line 40: @@
   --password2 admin_account_zimbra_password \
   --syncinternaldates --subscribe
 = Google Apps Admin Account Logins =

Jab at 22:25, 25 September 2018

2018-09-25T22:25:17Z

← Older revision		Revision as of 16:25, 25 September 2018
Line 152:		Line 152:
	** We know the account works. https://support.google.com/mail/answer/14257?rd=1		** We know the account works. https://support.google.com/mail/answer/14257?rd=1
	** Likely need to allow less secure apps access https://support.google.com/accounts/answer/6010255?hl=en		** Likely need to allow less secure apps access https://support.google.com/accounts/answer/6010255?hl=en

			[[Category: Zimbra]]

John at 19:53, 5 May 2016

2016-05-05T19:53:01Z

← Older revision		Revision as of 13:53, 5 May 2016
Line 140:		Line 140:
	Host2 capability: IMAP4rev1 LITERAL+ ID ENABLE ACL RIGHTS=kxte QUOTA MAILBOX-REFERRALS NAMESPACE UIDPLUS NO_ATOMIC_RENAME UNSELECT CHILDREN MULTIAPPEND BINARY CATENATE CONDSTORE ESEARCH SORT SORT=MODSEQ SORT=DISPLAY THREAD=ORDEREDSUBJECT THREAD=REFERENCES ANNOTATEMORE LIST-EXTENDED WITHIN QRESYNC SCAN XLIST URLAUTH URLAUTH=BINARY LOGINDISABLED COMPRESS=DEFLATE IDLE		Host2 capability: IMAP4rev1 LITERAL+ ID ENABLE ACL RIGHTS=kxte QUOTA MAILBOX-REFERRALS NAMESPACE UIDPLUS NO_ATOMIC_RENAME UNSELECT CHILDREN MULTIAPPEND BINARY CATENATE CONDSTORE ESEARCH SORT SORT=MODSEQ SORT=DISPLAY THREAD=ORDEREDSUBJECT THREAD=REFERENCES ANNOTATEMORE LIST-EXTENDED WITHIN QRESYNC SCAN XLIST URLAUTH URLAUTH=BINARY LOGINDISABLED COMPRESS=DEFLATE IDLE
	</pre></code>		</pre></code>


			=== Troubleshooting ===

			Common errors in transitioning accounts include:

			* Incorrect email address or password
			* Gmail Account locked down to not allow IMAP access
			** Change this in user mailbox settings
			* Gmail account will allow you to login via webmail but not with other apps
			** We know the account works. https://support.google.com/mail/answer/14257?rd=1
			** Likely need to allow less secure apps access https://support.google.com/accounts/answer/6010255?hl=en

John at 17:48, 2 September 2015

2015-09-02T17:48:35Z

← Older revision		Revision as of 11:48, 2 September 2015
Line 2:		Line 2:
	<strong>		<strong>
	* Data Type(s) Migrated: Mail		* Data Type(s) Migrated: Mail
	* Recommended for: ~~xmbase~~ Zimbra customers, customers migrating from non-Exchange mail servers		* Recommended for: XMission Zimbra customers with xmbase mailboxes, or customers migrating from non-Exchange mail servers
	* Some technical proficiency required (command line-based, requires Linux, Mac OS X or cygwin)		* Some technical proficiency required (command line-based, requires Linux, Mac OS X or cygwin)
	</strong>		</strong>

	This can be the most robust method of ~~migration~~, though it's only limited to mail. IMAPSync will compare source and destination hosts, and copy any messages not on the destination server from the host server. You can run this multiple times and generally not result in any duplicate messages in the destination mailbox.		This can be the most robust method of migrating, though it's only limited to mail. IMAPSync will compare source and destination hosts, and copy any messages not on the destination server from the host server. You can run this multiple times and generally not result in any duplicate messages in the destination mailbox.

	It is a command line-based perl script, so it requires either some sort of unix-based system or cygwin (or other compatible Perl setup on Windows). Consequently, it does require some level of technical proficiency to be used.		It is a command line-based perl script, so it requires either some sort of unix-based system or cygwin (or other compatible Perl setup on Windows). Consequently, it does require some level of technical proficiency to be used.
Line 29:		Line 29:
	= IMAP Admin Account Logins =		= IMAP Admin Account Logins =

	Also note that many mail servers (including ~~our~~ Zimbra servers) support the ability for an admin account to auth as a user. This is very useful when migrating an entire domain, as it frees you from needing to know each individual user's password. IMAPSync supports this with the "authuser" command. The same example command, except using the admin account, would go something like this:		Also note that many mail servers (including XMission's Zimbra servers) support the ability for an admin account to auth as a user. This is very useful when migrating an entire domain, as it frees you from needing to know each individual user's password. IMAPSync supports this with the "authuser" command. The same example command, except using the admin account, would go something like this:

	imapsync --host1 mail.some_mail_server.com \		imapsync --host1 mail.some_mail_server.com \
Line 43:		Line 43:
	= Google Apps Admin Account Logins =		= Google Apps Admin Account Logins =

	Google Apps ~~currently supports OAuth v1 and v2~~ to ~~admin authenticate to other accounts, however OAuth v1 was deprecated on April 15th, 2015 and may stop working~~ at ~~any time~~. ~~You can use either of these to have something like a "master password" for accessing Google Apps accounts without the administrator needing to know each individual user~~'~~s password. OAuth v1 is a little easier to use, and is recommended while it is still available.~~		'''Migrating from Google Apps to Zimbra at XMission.'''

	== OAuth v1 ==		Google Apps support using OAuth v1 and v2 to admin authenticate to other accounts. (Note: OAuth v1 was deprecated by Google on April 15th, 2015 and may stop working at any time) You may use either of the processes outlined below to have something like a "master password" for accessing Google Apps accounts without the administrator needing to know each individual user's password. The OAuth v1 process is a little easier to use, and is recommended while it is still available.

			== Migrate from Google Apps to Zimbra with OAuth v1 ==

	To use OAuth1 with imapsync, either from or to Google Apps, you will need to generate an OAuth consumer key, and then use this key as the password while setting the "authmech" imapsync flag to "xoauth". Also note that gmail requires ssl over imap.		To use OAuth1 with imapsync, either from or to Google Apps, you will need to generate an OAuth consumer key, and then use this key as the password while setting the "authmech" imapsync flag to "xoauth". Also note that gmail requires ssl over imap.
Line 65:		Line 67:
	Note, once again, that OAuth1 is deprecated and support may be removed at Google's discretion.		Note, once again, that OAuth1 is deprecated and support may be removed at Google's discretion.

	== OAUTH v2 ==		== Migrate from Google Apps to Zimbra with OAUTH v2 ==

	The newest version of IMAPSync has support for OAUTH v2. The process is a little more involved.		The newest version of IMAPSync has support for OAUTH v2. The process is a little more involved.

Secretions at 22:00, 1 September 2015

2015-09-01T22:00:48Z

@@ Line 1: / Line 1: @@
 <strong>
 * Data Type(s) Migrated: Mail
@@ Line 25: / Line 26: @@
   --password2 zimbra_password \
   --syncinternaldates --subscribe

Secretions at 21:32, 1 September 2015

2015-09-01T21:32:51Z

← Older revision		Revision as of 15:32, 1 September 2015
Line 15:		Line 15:

	You will want to read the documentation and determine what commands are appropriate to your situation, but the general idea is that you provide the source host/user/password, the destination host/user/password, imapsync logs into both and transfers the mail. These are delineated as host1/user1/password1 and host2/user2/password2 in the command line options.		You will want to read the documentation and determine what commands are appropriate to your situation, but the general idea is that you provide the source host/user/password, the destination host/user/password, imapsync logs into both and transfers the mail. These are delineated as host1/user1/password1 and host2/user2/password2 in the command line options.

			Here is an example IMAPSync command:

			imapsync --host1 mail.some_mail_server.com \
			--user1 some_username \
			--password1 some_password \
			--host2 zimbra.xmission.com \
			--user2 account_on_zimbra@domain.com \
			--password2 zimbra_password \
			--syncinternaldates --subscribe

Secretions at 19:29, 31 August 2015

2015-08-31T19:29:44Z

← Older revision		Revision as of 13:29, 31 August 2015
Line 13:		Line 13:
	* IMAPSync Homepage: http://imapsync.lamiral.info/		* IMAPSync Homepage: http://imapsync.lamiral.info/
	* Open source repository: https://github.com/imapsync/imapsync		* Open source repository: https://github.com/imapsync/imapsync

			You will want to read the documentation and determine what commands are appropriate to your situation, but the general idea is that you provide the source host/user/password, the destination host/user/password, imapsync logs into both and transfers the mail. These are delineated as host1/user1/password1 and host2/user2/password2 in the command line options.

Secretions at 18:47, 31 August 2015

2015-08-31T18:47:09Z

← Older revision	Revision as of 12:47, 31 August 2015
Line 1:	Line 1:
		<strong>
		* Data Type(s) Migrated: Mail
		* Recommended for: xmbase Zimbra customers, customers migrating from non-Exchange mail servers
		* Some technical proficiency required (command line-based, requires Linux, Mac OS X or cygwin)
		</strong>

		This can be the most robust method of migration, though it's only limited to mail. IMAPSync will compare source and destination hosts, and copy any messages not on the destination server from the host server. You can run this multiple times and generally not result in any duplicate messages in the destination mailbox.

		It is a command line-based perl script, so it requires either some sort of unix-based system or cygwin (or other compatible Perl setup on Windows). Consequently, it does require some level of technical proficiency to be used.

		Previously, this was normal free OSS software, but the author has since started requiring payment for it. Yet, not only was it previously released under an open source license, but it continues to be licensed as OSS with the newer paid versions, so you can still get reasonably up-to-date versions legally. If you wish to purchase the software, you can get a windows executable. All others will want to install from the git repository.

		* IMAPSync Homepage: http://imapsync.lamiral.info/
		* Open source repository: https://github.com/imapsync/imapsync