G Suite (IMAP) to G Suite (IMAP) Migration Guide

Let's Get Started

This migration guide contains the necessary steps to perform the actual migration, but there are many steps to preparing for migration. If this is your first time performing a migration, we have created a Migration Planning & Strategy Guide to walk you through planning, set-up, and general migration best practices.

To discover what items are moved with MigrationWiz in this scenario, and which items will not be moved, see Moved Items. Note that these items will vary by source and destination, so check the proper environment listings carefully.

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 we cannot handle scenarios such as conflict resolution without user interaction.

Important: Migrating from a G Suite/Gmail endpoint requires an administrator email address which matches the end user domain.

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

Preparing the Source

G Suite requires the use of OAuth 2.0 for migrations. The steps to set this up are explained below for Source preparation. OAuth 2.0 OR Google API may be used for the Destination.

Grant MigrationWiz OAuth 2.0 access to G Suite.

Grant MigrationWiz OAuth 2.0 access to G Suite. If you are migrating to multiple domains, repeat these steps for each domain.

BitTitan products use OAuth 2.0 to authenticate to G Suite  and utilize the G Suite (IMAP) endpoint in MigrationWiz. This is applicable to both mailbox and document migration projects. In order to obtain access to your G Suite data, it is necessary to add specifically allowed API scopes to the MigrationWiz project. Enabling access is required for both G Suite mailbox and Google Drive document migration projects.

Mailbox migration projects require that a G Suite administrator grant access to the BitTitan client ID and scopes listed in this article.

To configure the OAuth access within your G Suite environment, follow the directions here: 

Create users on G Suite

Google provides clear, step-by-step guidance for this project. Follow these steps and then move to the next step listed below.

Set Authentication

OAuth 2.0 Steps

BitTitan products use OAuth 2.0 to authenticate to G Suite  and utilize the G Suite (IMAP) endpoint in MigrationWiz. This is applicable to both mailbox and document migration projects. In order to obtain access to your G Suite data, it is necessary to add specifically allowed API scopes to the MigrationWiz project.

  • These steps must be followed whenever there is a migration project either to or from G Suite that will utilize the G Suite (IMAP) endpoint. This is currently required for all Google as Source projects. Enabling access is required for both G Suite mailbox and Google Drive document migration projects.
  • Mailbox migration projects require that a G Suite administrator grant access to the BitTitan client ID and scopes listed in this article.
  • Document migration projects require that a G Suite Super administrator grant access to the BitTitan client ID and scopes listed in this article and enable the API access. The steps to do this are included at the bottom of this article.

Steps in the G Suite Admin Console

Complete these steps to grant BitTitan client ID access to the appropriate scopes:

  1. Go to https://admin.google.com and authenticate as a Super Administrator.
  2. Click Security.
    Note: 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.
  3. Click Advanced settings.
    Note: Google limits accessing and changing this setting to only G Suite Super Administrator accounts.
  4. You will now have one of two options, depending on whether your tenant has been updated to the new Google API or not. 
  5. 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:mceclip1.png

    • 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
  7. Click Add New.
  8. Enter 113321175602709078332 into the Client ID field. 
  9. Enter the following groups of scopes into the OAuth Scopes (comma-delimited) field. Note that these scopes are for the source only. The destination scopes are found below.

    • G Suite as the Source (read-only scopes):
      https://mail.google.com/, https://www.google.com/m8/feeds, https://www.googleapis.com/auth/contacts.readonly, https://www.googleapis.com/auth/calendar.readonly, https://www.googleapis.com/auth/admin.directory.group.readonly, https://www.googleapis.com/auth/admin.directory.user.readonly, 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

Click Authorize.
Note: 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.


Enable IMAP

Ensure IMAP access is enabled for all users. For details on how to check this, refer to the Google support article here.

Enable Folder Size Limits

  1. Ensure the folder size limits on IMAP folders have been removed for all users. For each user:
  2. Click the gear icon
  3. Click Settings
  4. Select Forwarding and POP/IMAP tab
  5. Select Folder Size Limits
  6. Select the radio button for Do not limit the number of messages in an IMAP folder (default).

Note: This is an end user setting, which can only be set on a per-user basis. Therefore, we recommend that you send instructions to your end users to check this setting. Expand the following section for sample communication and instructions:

>Removing Folder Limit

Export mailboxes to CSV file(s)

From the Google Admin portal:

  1. Click Users
  2. Click ⁝ (3 vertical dots)
  3. Download Users
  4. Download All Users
  5. Click OK
  6. Save

Preparing the Destination

The steps for preparing the destination are identical to the steps for preparing the source, with the exception of the scopes. Follow the directions above to set up your destination, but substitute the following block of scopes for the source scopes above, then continue setting up your destination according to the Prepare the Source instructions. 

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


Purchase and Apply UMB Licenses

Licenses are required to run a migration project in MigrationWiz. To obtain license pricing information, or to purchase licenses, click the Purchase button in the top of your MSPComplete or MigrationWiz dashboard.

Payment: We accept credit cards, and wire transfer in certain situations.  

  • When purchasing with a credit card, payment is immediately processed during checkout. If successful, licenses are granted to your account instantly.
  • Wire transfers are available for purchases of 100 or more licenses. If you are purchasing at least 100 licenses, you will be presented an option to purchase via wire transfer during checkout. A wire transfer checkout will generate an invoice with wiring information for your accounts payable department and bank. Once the funds are received by our system, the licenses are granted to your account immediately. 

For this project type it is recommended to use our User Migration Bundle licenses. 

  • These licenses enable you to perform multiple migrations of User mailboxes, documents, and in-place archives, and allows the use of DeploymentPro to perform post-migration Outlook email profile configuration.
  • Further information on User Migration Bundle Licenses:
    • User Migration Bundle Licenses have unlimited data available per license.
    • User Migration Bundle Licenses are applied to the customer's users, for whom you'll be performing migrations, and are valid for one year.
    • Read the Apply User Migration Bundle Licenses to the Customer's Users article for more information about how to apply the licenses to Users for migrations.

Set the Endpoints

  1. When creating the project on your Source Settings or Destination Settings tab, click New.
  2. Fill in the fields below. Once endpoint has been saved in the project, it will automatically be assigned to the customer that was selected in the Project Information tab when creating the project.
  • Name: Type any name you want for the endpoint.
  • Find My Service Provider: Use this control only if the endpoint you’re creating is hosted by a service provider and not a local endpoint. If you don’t know your server type, click this button and then click your provider in the drop-down list.
  • Endpoint Type: Click the Endpoint Type drop-down, and then click the appropriate endpoint type in the list. Ensure you have selected the correct source and destination. When you select an endpoint type, the form will expand so that you can provide additional connection information and credentials for that endpoint type. These additional fields vary depending on the endpoint type.
  • If an endpoint does not exist for the service that you want to connect to with MigrationWiz, then use the Generic endpoint type to generically store the web address for that service, a username, and password. This endpoint can still be used for Runbook execution.
  • Provide credentials: Select Provide Credentials or Do Not Provide Credentials as needed.
  • If you select Provide credentials, the form expands to present more fields for username and password. The credentials will be used by MigrationWiz to access the service selected. In most cases, you must provide credentials for an administrator account on those services, as this will enable MigrationWiz to have full access to the cloud service.
  • If you select Do not provide credentials, then MigrationWiz will request credentials from end users before a migration can be started, or before a Runbook can be completed. This may slow your migration, as you are now dependent on the end users to provide these credentials.
  • Domains: For migrations using G Suite Endpoints, this is the list of domains that you will be migrating to, or migrating from. This is not relevant to any other migration environment.
  • Use SSL: For some endpoint types, there is an SSL check box at the bottom of the form. Select this check box if you want to secure your new endpoint with Secure Sockets Layer (SSL).
  • Note that IMAP and POP endpoints include an SSL option (check box): If your provider uses SSL, you should select this check box and enter the SSL port number in the field provided. For IMAP endpoints, the default port number for SSL is 993. For POP endpoints, the default port number for SSL is 995.
  • If your provider does not use SSL, do not select this check box, and enter the non-SSL port number in the field provided. For IMAP endpoints, the default port number for non-SSL is 143. For POP endpoints, the default port number for non-SSL is 110.

Set the Project Advanced and Support Options

The following options are the most valuable for this migration scenario:

  • Under Filtering, add: (^All Mail$|^All Mail/)
    • This will filter out the All Mail label from your migration passes. It will also speed up your migration passes.
    • You will remove this folder filter before performing your final migration pass. These steps are included later in this section.
  • Set the Maximum concurrent migrations value.
    Note: The default value is 100. For cloud to cloud migrations, this value can be set to a very high number, such as 500, because both the Source and Destination environments can handle a large number of concurrent migrations.
  • Under Support/Support options, add:
    • StoreOverflowGooglePropertiesInNotes=1 
    • StoreOverflowGooglePropertiesInNotesPrefix="enter your text here"  

Launch the Migration

The following sections will guide you through setting up and launching your migration. Each header is one step, with its component steps below. Follow these steps in order, and read the notes for important information about dependencies or best practices.

Run Verify Credentials

  1. Open the Project containing items you wish to validate​.
  2. Select the items you wish to validate.
  3. Click on the Start button in your dashboard.
  4. Select Verify Credentials from the drop-down list.
  5. Once complete, the results of the verification will be shown in the Status section.

Notify Users

Send out the final notification that the migration is beginning. Include when the migration will start, expected duration, any usage instructions during migration, and any expected steps or notifications for the post-migration timeline.

If using DeploymentPro, refer to KB005799 for some sample text and screen shots that can be included in this email.

Pre-Stage Pass

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

MX Record Cutover

Change over MX records on the DNS provider's portal. Also, include the AutoDiscover (CName) setting. If Mail Coexistence if Required

If mail coexistence is required, you must set up mail forwards against those user accounts that are in the migration batches. Google documentation explains how: https://support.google.com/mail/answer/10957

If you are migrating in batches, you will not be cutting over the MX records until your final batch of users has been migrated.

Run Full (Delta) Pass Migration

Select the users – you may either select individual users, or select all users in a project by clicking the checkbox to the left of Source Email.

Click the Start button from the top

Select Full Migration. If you want to delay your migration, then select the checkbox marked "Automatically start the migration at", and enter the date and time to have the migration start. To start a migration immediately, you do not need to select the scheduling option.

Click Start Migration

Run Retry Errors

Each error logged represents an item that was not migrated. MigrationWiz contains a mode in which you can resubmit the migration to retry failed items. This mode of operation is always free of charge. You may only submit mailboxes in this mode only if they satisfy all of the following conditions:

  1. The last migration completed successfully.
  2. The mailbox contains at least one error.

If your mailbox does not satisfy these conditions, you will receive a warning when submitting the migration in this mode and your request will not be fulfilled.

To submit one or more mailboxes in retry mode, perform the following steps:

  1. Click the Go To My Projects button.
  2. Select the project that contains the mailboxes that you want to retry.
  3. Select the mailboxes that have migration errors.
  4. Click on the Start button.
  5. Select Retry Errors from the menu.
  6. Click the Retry Errors button.

When errors are repaired, they will disappear from the error log. Some errors may not disappear if the Source item was not reprocessed (due to filters, for example), has been deleted or moved, or if the item failed again.

Run Final Full Migration Pass

  1. Under Project Advanced Options, navigate to filtering section
  2. Delete: (^All Mail$|^All Mail/)
  3. Select the users
  4. Click the Start button from the top, select Full Migration
  5. Click Start Migration

Post Migration

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

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