habibzain Just husband, father and enthusiastic men about System Administration. Love to write short article about it. Perhaps can help and be useful for others.

Zimbra Open Source Server Migration and Account Transfer

9 min read

Zimbra Server Migration and Account Transfer Perfect Method

Friend, I repost this article because it’s just for personal documentation, the steps for zimbra server migration. Worried about the source website of the article being broken or expired. Source article on the end of this post. This article for zimbra open source or community edition migrate from one server to another server.

1. Introduction

Zimbra project doesn’t have a cross migration or proper account transfer documentation. All they tell is to do copy the folder /opt/zimbra to your new servers. But if any of those files infected with a rootkit or other malicious scripts , then your new server also will be compromised. So never sync or copy the entire directory of your zimbra installation. Zimbra also tell you to upgrade your production server to the latest version before migration. But improper upgrade may result in entire data lose. With this procedure you can do:

  • Migrate zimbra from one Operating System To another.
  • Migrate zimbra account between any hardware and Operating systems configurations.
  • No interruption on production server like software upgrade or service disable.
  • Migrate zimbra from old version to a new version server
  • Zimbra cross migrations without copying entire directories.

2. Requirement

You need an old server with zmibra account and a new fresh server with the Os you wish. Dont’ create or make any custom configuration or setting in you new server. Please make sure to set your new servers hostname same as the old one.

  • Old server
    • Need ssh root login
    • Need zimbra admin logins
    • Enough HDD space to store backups
  • New server
    • Must be installed with latest stable zimbra
    • Need ssh root logins
    • Need zimbra admin logins
    • Enough HDD space to store backups

3. Presetup

You need to setup an ssh key from the new server’s root account to the old server’s root account. Reduce the TTL of MX records of your domain to 500 seconds . So that you can easily switch the domain’s IP after migration. Please remember to schedule the migration task on non peek hours.

Create a directory in both new and old server into which we store all required files and data for doing the migration

[root@zimbra ~]# mkdir /backups/zmigrate
[root@zimbra ~]# chown zimbra.zimbra /backups/zmigrate
[root@zimbra ~]# su - zimbra

All operation in your Zimbra server must be performed as Zimbra user itself, otherwise you will get permission and ownership issues in your zimbra server

4. Backup all data from Old server

We are going to copy all data from old server without interrupting the services.

4.1 Find all domains

You need to find all the domains from your old server. We will store the domain list in a file called domains.txt. You need to back all the domains list as follows,

zimbra@zimbra:~$ cd /backups/zmigrate
zimbra@zimbra:/backups/zmigrate$ zmprov gad > domains.txt
zimbra@zimbra:/backups/zmigrate$ cat domains.txt

Now remove all domains and subdomains related with the main hostname of your server foo.com , from this list (domains.txt) because it was already created in your new server. So there is no need to create a new domain with the same name.

See also  PFDel Script Delete Mail Queue Postfix and Zimbra

4.2 Find all admin accounts

Most of these servers will have only one admin. But some servers have multiple admins. So it will be good to find all admin accounts. We will store the admins list in admins.txt

zimbra@zimbra:/backups/zmigrate$ zmprov gaaa > admins.txt
zimbra@zimbra:/backups/zmigrate$ cat admins.txt
[email protected]

4.3 Find all email accounts

Next step is to find all the email accounts hosted in your old server. Get a list of your email accounts and save in the file emails.txt . So from this file we can see how many accounts that need to migrate.

zimbra@zimbra:/backups/zmigrate$ zmprov -l gaa >emails.txt
zimbra@zimbra:/backups/zmigrate$ cat emails.txt
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]

Please remove all the email accounts from the file /backups/zmigrate/emails.txt with a starting words like spam, virus, ham, galsync . There is no need to restore these accounts. Even if you still need to restore , you can do it. I don’t like spam and virus emails.

4.4 Get all distribution lists

You need to get all the distributions list and store it in a file called distributinlist.txt.

zimbra@zimbra:~$ zmprov gadl > /backups/zmigrate/distributinlist.txt
zimbra@zimbra:~$ cat /backups/zmigrate/distributinlist.txt
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]

4.5 Get all members in distribution lists

In this step we are going to collect all members in each of these distributions. We will create a folder called distributinlist_members and create a file under this folder named distributinlist.txt , then store all the distributions members.

zimbra@zimbra:~$ mkdir /backups/zmigrate/distributinlist_members
zimbra@zimbra:~$ for i in `cat /backups/zmigrate/distributinlist.txt`; do zmprov gdlm $i > /backups/zmigrate/distributinlist_members/$i.txt ;echo "$i"; done
[email protected]
[email protected]
[email protected]

4.6 Find all email account’s passwords

Now need to find the encrypted password of all of your old email accounts and store it under a folder named userpass/ as follows:

zimbra@zimbra:/backups/zmigrate$ mkdir userpass
zimbra@zimbra:/backups/zmigrate$ for i in `cat emails.txt`; do zmprov  -l ga $i userPassword | grep userPassword: | awk '{ print $2}' > userpass/$i.shadow; done

4.7 Find All Mail Forwarding zimbraPrefMailForwardingAddress

We can backup all account forwarding address.

zimbra@zimbra:/backups/zmigrate$ mkdir forwarding
zimbra@zimbra:/backups/zmigrate$ for i in `cat emails.txt`; do zmprov  -l ga $i zimbraPrefMailForwardingAddress | grep zimbraPrefMailForwardingAddress: | awk '{ print $2}' > forwarding/$i.forward; done 

Maybe some of your email accounts don’t have mail forwarding. So the above created files may be an empty file. Remove those empty files as follows.

zimbra@zimbra:/backups/zmigrate$ find forwarding/ -type f -empty | xargs -n1 rm -v

4.8 Backup all user names, Display names and Given Names

Zimbra will accept a Names and Disaplay names in email accounts during account creation. So we need to restore those data too. We will create a directory called userdata/ which contains these details of each of those email accounts.

zimbra@zimbra:/backups/zmigrate$ mkdir userdata
zimbra@zimbra:/backups/zmigrate$ for i in `cat emails.txt`; do zmprov ga $i  | grep -i Name: > userdata/$i.txt ; done

4.9 Now backup all email account

This will take some time to take backup of all email accounts. So you can run this command behind “screen”. A tgz file will be created with each emails name. We will use this files to transfer email accounts.

zimbra@zimbra:/backups/zmigrate$ for email in `cat /backups/zmigrate/emails.txt`; do  zmmailbox -z -m $email getRestURL '/?fmt=tgz' > $email.tgz ;  echo $email ; done
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]

This tgz files contains

  • Mail
  • Contacts
  • Calendars
  • Briefcase
  • Tasks
  • Searches
  • Tags
  • Folders All subfolders are included, except Junk and Trash. There is no way to include these in the big dump, but they can be exported separately:
See also  Preparation Before Install Zimbra 8.8.15 in Ubuntu 20.04 (Part 1)

4.10 Now backup alias

Some times your server may have email aliases for certain accounts. So you need to copy those aliases too. We will create a sub folder called alias/ for storing the backup of Alias.

zimbra@zimbra:/backups/zmigrate$ mkdir -p alias/
zimbra@zimbra:/backups/zmigrate$ for i in `cat emails.txt`; do zmprov ga  $i | grep zimbraMailAlias |awk '{print $2}' > alias/$i.txt ;echo $i ;done
[email protected]
[email protected]

Some of your email accounts don’t have alias. So the above created files may be an empty file. Remove those empty files as follows.

zimbra@zimbra:/backups/zmigrate$ find alias/ -type f -empty | xargs -n1 rm -v 

4.11 Now Backup all email signatures

Please use the following script to backup all signatures of email accounts. Special thanks for Antonio Díaz Meneses for giving the inputs.


mkdir signature
for i in `cat emails.txt`; do
    zmprov ga $i zimbraPrefMailSignatureHTML > /tmp/signature;
    sed -i -e "1d" /tmp/signature ;
    sed 's/zimbraPrefMailSignatureHTML: //g' /tmp/signature > signatures/$i.signature ;
    rm -rf /tmp/signature;
    `zmprov ga $i zimbraSignatureName > /tmp/name` ;
    sed -i -e "1d" /tmp/name ;
    sed 's/zimbraSignatureName: //g' /tmp/name > signatures/$i.name ;
    rm -rf /tmp/name ;

4.12 Backup all email account filters

The email backup doesn’t have the email filters. So it need to be backed up manually. To download all email accounts filters. Please use the following scripts

# Backup filters of all email accounts
mkdir filter/
for i in `cat emails.txt`; do
    zmprov ga $i zimbraMailSieveScript > /tmp/filter
    sed -i -e "1d" /tmp/filter
    sed 's/zimbraMailSieveScript: //g' /tmp/filter  > filter/$i.filter
    rm -f /tmp/filter
    echo "Filter  downloaded for .... $i"

4.13 Rsync folder to new server

Now we have all the required data to do the migration process. As a summery :

  • /backups/zmigrate – Have all the backups stored
  • /backups/zmigrate/domains.txt – Contains the domains names
  • /backups/zmigrate/emails.txt – Contains the list of email accounts
  • /backups/zmigrate/distributinlist.txt – Contains the distribution lists
  • /backups/zmigrate/distributinlist_members – Contains the members in each of your distributions
  • /backups/zmigrate/userpass – Contains the encrypted password of your email accounts
  • /backups/zmigrate/userdata – containts the email accounts user informations
  • /backups/zmigrate/alias – Contains all the aliases of your email accounts

Also the parent folder /backups/zmigrate contains a lot of zip file which are the data inside emails.

Now rsync the files as follows,

root@newserver # rsync -avp -e 'ssh -p 22' root@old-server-ip:/backups/zmigrate /backups/

5. Restore in new server

So after finishing the rsync process , we need to restore this in your new server as follows:

All this operations must be carried out as zimbra sudo user itself. Don’t use root account to store the backups

[root@zimbra ~]# su - zimbra

5.1 Restore all domains

Now create all the domains that we have from the file /backups/zmigrate/domains.txt

[zimbra@zimbra zmigrate]$ for i in `cat /backups/zmigrate/domains.txt `; do  zmprov cd $i zimbraAuthMech zimbra ;echo $i ;done

You can also verify the domains created from the zimbra admin panel too

5.2 Create email accounts and set the old password

We need to create the email accounts for storing the mails. And need to set the old passwords too. We already collected the account info and passwords.

To Create email accounts and restore passwords . Please use the following script to create it

#Scrit  for creating the email accounts createacct.sh
for i in `cat $USERS`
givenName=$(grep givenName: $USERDDATA/$i.txt | cut -d ":" -f2)
displayName=$(grep displayName: $USERDDATA/$i.txt | cut -d ":" -f2)
shadowpass=$(cat $USERPASS/$i.shadow)
zmprov ca $i CHANGEme cn "$givenName" displayName "$displayName" givenName "$givenName" 
zmprov ma $i userPassword "$shadowpass"

5.3 Restore email accounts

Now we are going to restore the emails from the Zip file. This process may take some hours. So it will be good to run behind “screen” command.

[zimbra@zimbra zmigrate]$ for i in `cat /backups/zmigrate/emails.txt`; do zmmailbox -z -m $i postRestURL "/?fmt=tgz&resolve=skip" /backups/zmigrate/$i.tgz ;  echo "$i -- finished "; done
[email protected] -- finished 
[email protected] -- finished 

Note: If any error like this “ERROR: zclient.IO_ERROR (Read timed out) (cause: java.net.SocketTimeoutException Read timed out”. Solution is add parameter -t 0.

for i in `cat /backups/zmigrate/emails.txt`; do zmmailbox -z -m -t 0 $i postRestURL "/?fmt=tgz&resolve=skip" /backups/zmigrate/$i.tgz ; echo "$i -- finished "; done

5.4 Now recreate the distribution lists

It is time to recreate all the distribution lists as follows.

[zimbra@zimbra zmigrate]$ for i in `cat distributinlist.txt`; do zmprov cdl $i ; echo "$i -- done " ; done
[email protected] -- done 

5.5 Restore the distribution lists

After creating the distribution lists we need to add all the members inside the distribution lists. We have the distribution lists in the folder distributinlist_members/ and the list is in distributionlist.txt file. Please use the following small script to restore the distribution lists.

[zimbra@zimbra zmigrate]$ cat restoredist.sh 
# add all memebers to each of these distribution lists
for i in `cat distributinlist.txt`
    for j in `grep -v '#' distributinlist_members/$i.txt |grep '@'` 
    zmprov adlm $i $j
    echo " $j member has been added to list $i"


5.6 Restore Alias accounts

Please use the following script to restore alias. This will add all the aliases in your email accounts.

for i in `cat /backups/zmigrate/emails.txt`
    if [ -f "alias/$i.txt" ]; then
    for j in `grep '@' /backups/zmigrate/alias/$i.txt`
    zmprov aaa $i $j
    echo "$i HAS ALIAS $j --- Restored"

5.7 Restore Email Signatures

No please use the following script to restore email signatures

for i in `cat emails.txt`; do
    zmprov ma $i zimbraSignatureName "`cat signatures/$i.name`";
    zmprov ma $i zimbraPrefMailSignatureHTML "`cat signatures/$i.signature`";
    zmprov ga $i zimbraSignatureId > /tmp/firmaid; sed -i -e "1d" /tmp/firmaid;
    firmaid=`sed 's/zimbraSignatureId: //g' /tmp/firmaid`;
    zmprov ma $i zimbraPrefDefaultSignatureId "$firmaid";
    zmprov ma $i zimbraPrefForwardReplySignatureId "$firmaid";
    rm -rf /tmp/firmaid;
    echo $i "done!";

5.8 Restore Email Filters

You may use the following scripts to restore all your email accounts filters.

for i in `cat emails.txt`; do
    zmprov ma  $i zimbraMailSieveScript "`cat filter/$i.filter`";
    echo "Filter Restore for account ... $i"; 


5.9 Restore Mail Forwarding

Create simple script for restore mail forwarding in each account.

for i in `cat emails.txt`; do
    zmprov ma  $i zimbraPrefMailForwardingAddress "`cat forwarding/$i.forward`";
    echo "Forward Restore for account ... $i";


We can ignore if getting “No such file or directory”. Let process running until finish.

See also  PFlogsumm - Daily Report Postfix Monitoring on CentOS 6

6. Conclusion

So now we migrated all our email accounts. It is time for DNS change. You need to shut down the old zimbra services and change the DNS. After that send some test emails and make sure everything is working fine. Next step is to secure your zimbra server. You need to install ssl certificates and firewall in your new zimbra server. Now you have a new server with new packages and files with the same old email accounts and its data.

7. References

Sitelink reference.

  • https://wiki.zimbra.com/wiki/Zmprov_Examples
  • https://wiki.zimbra.com/wiki/Zmprov
  • https://wiki.zimbra.com/wiki/Backing_up_and_restoring
  • http://stdout.no/zimbra-open-source-backup-strategy-and-scripts/
  • https://syslint.com/blog/tutorial/zimbra-server-migration-and-zimbra-account-transfer-the-perfect-method
  • https://xmission.com/blog/2015/04/30/zimbra-server-admin-tip-mailbox-password-migration-and-server-settings-comparison

That is article about zimbra server migration for open source edition. May be it’s helpful, please feel free to leave a comment if you have any questions and I’ll appreciate it.

habibzain Just husband, father and enthusiastic men about System Administration. Love to write short article about it. Perhaps can help and be useful for others.

Zimbra Relay Amazon SES

Zimbra is a widely used collaboration platform that provides robust email services. When it comes to improving email deliverability and ensuring the security of...
1 min read

Install Zimbra 10 Ubuntu 20.04 from Scratch

Zimbra 10 may have had specific installation requirements, and there might be updates or changes beyond that point. Here is simple guide how to...
4 min read

Zimbra Cannot start TLS: handshake failure

The Zimbra log show error message “Cannot start TLS handshake” typically indicates an issue with establishing a secure TLS (Transport Layer Security) connection. This...
1 min read

8 Replies to “Zimbra Open Source Server Migration and Account Transfer”

  1. Thank you for your article. It is interesting, and the approach is nice. I am currently conducting some tests. However, I have noticed that after migrating from version 8.8.15 to 10.x (Daffodil), shared folders (calendars, etc.) indicate that the original share is no longer available, requiring them to be recreated. This could be problematic for many users’ setups. Have you also noticed this issue? Do you have any suggestions on how to address it?

    1. Dear, for shared folders I haven’t found the right way yet.
      for commercial use, you can use ‘zextras’.

  2. Thank you. For now, I’m trying to upgrade OS/Zimbra and everything works or, when impossible, I’m just manually restoring the shared folders. It’s ok, if you haven’t too many to share.

  3. Thank you, I managed to migrate 700++ zimbra accounts and mailbox without missing any of emails or accounts with your tutorial. Oh and I ask your permission to re-write this article in my language with addition some notes from my own experience.

  4. Thanks for teachings, as I’m a Zimbra newbie.
    I’m surprised that Zimbra/Synacor don’t supply a CLI tool for this

    Suggested improvement to 4.11 Diaz’ script,
    because iteration2+ “>tempfile” overwrites anyway, so remove redundant but place last “rm” outside loop
    because unnecessary tick marks of second “zmprov” were not needed in first, so remove :

    mkdir signature
    for i in `cat emails.txt`; do
    zmprov ga $i zimbraPrefMailSignatureHTML > /tmp/signature;
    sed -i -e “1d” /tmp/signature ;
    sed ‘s/zimbraPrefMailSignatureHTML: //g’ /tmp/signature > signatures/$i.signature;
    zmprov ga $i zimbraSignatureName > /tmp/name;
    sed -i -e “1d” /tmp/name ;
    sed ‘s/zimbraSignatureName: //g’ /tmp/name > signatures/$i.name ;
    rm -rf /tmp/signature /tmp/name

Leave a Reply

Your email address will not be published. Required fields are marked *

Never miss good article from us, get weekly updates in your inbox