Zimbra to G Suite Migration Guide

This is the complete onboarding task flow for migrating mailboxes from Zimbra (version 6 and later) to Office 365. MigrationWiz no longer supports TLS 1.0.  TLS 1.2 is now required. Verify the TLS version and update, if necessary, before migrating.

App passwords are not supported for the Microsoft 365 endpoint. 

First migration?

We have created a guide on scoping, planning, and managing the migration process. If this is your first migration, we recommend carefully reading this guide.

MigrationWiz is a migration tool, not a syncing tool. If changes are made at the source after migration, they will not sync to the destination, nor will changes made at the destination sync to the source. We do not have “live” monitoring of changes (as with a sync agent) and cannot handle scenarios such as conflict resolution without user interaction.

MigrationWiz supports the capability to share migration projects across a Workgroup. When the Project Sharing feature is turned on, all Agents besides those who are Inactive can view all migrations projects. 

We are not able to support migrations with two-factor or multifactor authentication. 

Zimbra 6+

What items are and are not migrated?
Migrated Not Migrated
You can find the migrated items for this migration type in the following list. 
  • Inbox
  • Folders
  • Email
  • Contacts
  • Calendars

Prepare the Source Environment

Users must enter usernames on the Zimbra side, even when using an admin account.

Export Users

Export the list of users to a CSV file. This will be used when adding users to your MigrationWiz mailbox project later in the migration.

  1. Open Zimbra Admin.
  2. Select Account.
  3. In the Search box, type the domain name to be exported.
  4. On the Toolbar Zimbra Admin, select the Download button.
  5. Save the CSV file generated.

Split Large Folders

Zimbra will exhibit poor migration performance for folders with several numbers of items. Please, split up folders to avoid performance issues.

Calendar folders can be slower to migrate when the data is complex. For example, recurring calendar meetings result in increased calendar events.

Prepare Admin Credentials

Guarantee that you have admin credentials available for use during migration. If electing to assign the admin role through the Zimbra administrator portal instead of the below commands, the user must be granted Global Administrator. Assigning just an Administrator will not work.

You can prepare your Admin Credentials by using one of the following options:

  • Use existing credentials.
  • Create a new admin account for migration. This will create an additional admin account with the password of 'test123':
    zmprov ca testadmin@domain.com test123 zimbraIsAdminAccount TRUE
  • Transform a normal existing user account into an admin account (in this example future-admin will become an admin):
    zmprov ma future-admin@domain.com zimbraIsAdminAccount TRUE

Test mailbox access

Accessing the SOAP web services is needed for migration, so corroborate that the necessary ports are open to connect to the Zimbra server. There are two modes to connect to a Zimbra server, Regular and Admin User mode.

  1. In regular user mode, we need access to SOAP web services, which are typically the following:
    • On port 80 if it is an HTTP connection.
    • On port 443 if an HTTPS connection.
  2. In admin user mode, we also need access to SOAP web services, typically:
    • ​On ports 80 and 7071 if the Zimbra URL is HTTP.
    • On ports 443 and 7071 if the Zimbra URL is HTTPS.

You must connect using both ports. Some operations will go over the admin port, while others the regular port.

Prepare the Destination Environment

  1. Create users on G Suite
  2. Grant MigrationWiz OAuth 2.0 access to G Suite. Note that Google is currently updating the admin console UI, and the process is slightly different if this has occurred in your instance. Verify which version you have before beginning the steps below. 
  3. Go to https://admin.google.com and authenticate as a Super Administrator.
  4. Click Security. If you do not see the security icon on your admin console home page, you do not have the necessary rights on your account to make these changes. Request Super Administrator access from the customer to implement these changes.
  5. Click Advanced Settings. Google limits accessing and changing this setting to only G Suite Super Administrator accounts.
  6. You will now have one of two options, depending on whether your tenant has been updated to the new Google API or not. 
  7. Old Google Tenant:

    • Go to the G Suite admin page at google.com
    • Click on Security
    • Click on Advanced Settings
    • Click Manage API Client Access.

    OR If your account shows the latest UI updates from Google, as shown below:New_Google_Admin_APP_Access_Control.JPG

    • Go to the G Suite admin page at google.com
    • Click on Security
    • Click Advanced Settings
    • Under ‘Domain-wide delegation’, click Manage domain-wide delegation
    • On the Manage domain-wide delegation page, click Add new
  9. Click Add New.
  10. Enter 113321175602709078332 into the Client ID field. 
  11. Enter the following groups of scopes into the OAuth Scopes (comma-delimited) field:
    • G Suite as the Destination (full scopes):
      https://mail.google.com/, https://www.google.com/m8/feeds, https://www.googleapis.com/auth/contacts.readonly, https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/admin.directory.group, https://www.googleapis.com/auth/admin.directory.user, https://www.googleapis.com/auth/drive, https://sites.google.com/feeds/, https://www.googleapis.com/auth/gmail.settings.sharing, https://www.googleapis.com/auth/gmail.settings.basic,https://www.googleapis.com/auth/contacts
  12. Click Authorize.
  13.  The client name is 113321175602709078332 (make sure there are no leading or trailing spaces, as this may cause the error "URL ends with an invalid top-level domain name."). This will grant BitTitan products access to the appropriate scopes.
  14. If you are migrating to multiple domains, repeat these steps for each domain.

MSPComplete Steps

Create the customer

Each customer you add will be displayed in your customer list unless you archive it. There are two ways to add customers.

From the All Customer Page

  1. Click the Add button in the top navigation bar
  2. Click the Add Customer button on the All Customers page
  3. Select the appropriate workgroup and click All Customers.
  4. Click Add Customer.
  5. Enter the new customer’s information in the Add Customer form. Primary Email Domain and Company Name are required. The rest are optional.
  6. Click Save.
  7. Repeat steps 1 through 4 for each customer you want to add. 

Add Button

Add customers from the Add button in the top navigation bar

  1. In the left navigation pane, select the appropriate workgroup.
  2. Click Add in the top navigation bar and click Add in the drop-down list.
  3. Enter the new customer’s information in the Add Customer form.
  4. Click Save.
    When you click a customer in the list in the main pane, the name appears under Recent Customers in the left navigation pane.


Purchase licenses. We recommend using the User Migration Bundle license for this migration scenario. 

  • These licenses enable multiple migrations of user mailboxes, documents, and in-place archives. It also allows using DeploymentPro to perform post-migration Outlook email profile configuration.
  • User Migration Bundle Licenses have unlimited data available per license.
  • User Migration Bundle Licenses are applied to the customer's users and expire 12 months after their purchase date. 
  • Document, Personal Archive, and DeploymentPro projects are all included when using User Migration Bundle Licenses.
  • This license type must be applied manually.

Apply for licenses

  1. Sign in to MSPComplete at https://manage.bittitan.com.
    • When you sign in, make sure to select the MSPComplete button above the email field.
  2. Select the correct workgroup on the top of the left navigation pane. This is the workgroup that the customer and migration project were created under. Your account must be part of the workgroup if the project was not created under your account.
  3. On the left navigation pane, click Customers.
  4. Click the customer that employs the user to whom you want to apply for a User Migration Bundle license.
  5. Click the Users tab at the top of the page.
  6. Select the checkbox to the left of the email for the user(s) you want to apply for a license.
  7. Click the Apply User Migration Bundle License button at the top of the page.


    We recommend adding the users to the Customer page with the vanity domain. Then apply the User Migration Bundle Licenses, before editing to show the .onmicrosoft domain, if the .onmicrosoft domain will be used for the migration.

  8. If at least one unassigned User Migration Bundle license is available for each selected user, click Confirm.

MigrationWiz Steps

Create a Mailbox Migration project

  1. Click the Go to My Projects button.
  2. Click the Create Project button.
  3. Click on the type of project that you wish to create. For this migration:
    • Mailbox: Mailbox projects are used to migrate the contents of the primary user mailbox from the previous environment to the new environment. Most mailbox migrations can migrate email, calendars, and contacts.

For mailbox migrations use administrative credentials to access mailboxes. In most migration scenarios, the admin account must have full access rights to the Source mailboxes. 

    1. Click Next Step.
    2. Enter a Project name and select a Customer.
    3. Click Next Step.


Endpoints are now created through MigrationWiz rather than through MSPComplete. The steps for this section outline how to create the endpoints in MigrationWiz.

If you select an existing endpoint, consider that the dropdown only shows ten endpoints. If you have more than ten, you may need to search. Endpoint search is case and character-specific. For example, Cust0mer will not show up if the search is customer. We recommend keeping a list of endpoints you have created with any unique spellings or capitalization you may have used.

You may either use existing endpoints or create new ones. 

Create a Source Endpoint

  1. Click Endpoints.
  2. Click Add Endpoint.
  3. Select Zimbra 6.5+.
  4. It is necessary to add all domains that will be part of the migration on either the Source or the Destination. This means that, if there are users in one project with domain names Sourcedomain.com and Destinationdomain.com, it is important to ensure that both of these are added under “Your Domains” when creating the endpoints. When adding a domain, click the "+" button.
  5. Enter Zimbra server URL.

  6. Click the Provide Credentials radio button, and enter the admin account credentials. These are either your existing admin credentials or the credentials for the account that was created under the "Prepare the Source Environment" section of this guide.

  7. Click Add.
  8. Click Next Step.

Create a Destination Endpoint

  1. Click Endpoints.
  2. Click Add Endpoint.
  3. Select G Suite/Gmail.
  4. It is necessary to add all domains that will be part of the migration on either the Source or the Destination. This means that, if there are users in one project with domain names Sourcedomain.com and Destinationdomain.com, it is important to ensure that both of these are added under “Your Domains” when creating the endpoints. When adding a domain, click the "+" button.
  5. Enter the Administrative email address. This account must have an admin access level to the Google admin portal.
  6. Click Add.
  7. Click Next Step.

Add Users

Add the user accounts that will be migrated to the project. MigrationWiz allows you to bulk import mailboxes into the system.


The Username of the source mailbox needs to be for the user mailbox being migrated and not the Zimbra administrator account.

Use the Bulk Add option for large migrations, or the Quick Add for smaller migrations. 

To import one or more mailboxes:

  1. Sign in to your MigrationWiz account.
  2. Select the Project for which you want to perform the bulk import.
  3. Click on Add.
  4. Click on Quick Add or Bulk Add.
  5. Follow the instructions on the page.

Add Advanced Options

Support Tab

  • ZimbraCalendarExpandInstances=1 By using this option, you can expand calendar instances, in case Zimbra is missing calendars in the migration.

Performance Tab

  • Maximum concurrent migrations. We recommend setting this to a meager value, such as 5, to ensure that server utilization does not go above 80%.
    • If the Source Zimbra server is running low on resources, it can result in an email being migrated as blank.
    • If the Source server has enough resources, set this parameter based on the bandwidth guideline of three (3) mailboxes per 1Mbps bandwidth.
      Therefore, for example, if there is a 10Mbps connection, we recommend setting the maximum concurrent migrations parameter to 30. In case the Source server has limited available resources such as low memory or high CPU usage, we suggest setting a lower value to prevent overloading the server with requests.

Run Verify Credentials

  1. ​Sign in to your MigrationWiz account.
  2. Open the Project containing items to validate.
  3. Select the items to validate.
  4. Click on the Start button in your dashboard.
  5. Select Verify Credentials from the drop-down list.

Once complete, you can check the verification results in the Status section.​ 

Notify Users

Notify users that a migration is occurring. Send an email to all users telling them the time and date of the migration.

Run Migration

Pre-Stage pass

  1. Select the users you wish to migrate.
  2. Click the Start button from the top.
  3. Select Pre-Stage Migration.
  4. Under the Migration Scheduling section, from the drop-down list, select 90 days ago.
  5. Click Start Migration.

MX Record Cutover

  • Change over MX records on the DNS provider's portal.
  • Also, include the AutoDiscover (CName) setting.
  • Set up Zimbra mail forwarding.

Full (Delta) pass

  1. Select the users.
  2. Click the Start button from the top.
  3. Select Full Migration.
  4. Click Start Migration.

Run Retry Errors

Look through the user list and click any red "failed migration" errors. Review the information and act accordingly.

If problems persist contact Support.

Outlook Configuration

If users are using Microsoft Outlook with G Suite, they need to follow the instructions here to download and install G Suite Sync for Outlook and create a new Outlook profile that connects to G Suite.

Request Statistics

Click the pie chart icon in the MigrationWiz dashboard to receive an email containing all the project migration statistics.

Was this article helpful?
0 out of 0 found this helpful