Page tree
Skip to end of metadata
Go to start of metadata

For cPanel & WHM version 11.48 and earlier

Overview

You can use the /scripts/convert2maildir script to perform conversions on mail storage data. Maildir is the only supported mail storage system for cPanel & WHM servers. Because of this, users who migrate data onto cPanel & WHM servers will need to convert any mbox data to the Maildir format.

Warnings

  • This document is only valid for cPanel & WHM version 11.48 and earlier.
  • After you begin a conversion, do not cancel the process. If you cancel the conversion, your server's mail system will break.
  • We strongly recommend that you back up your mail folders before you start this process.

Notes:

  • The conversion process may take up to 24 hours. This depends on your server’s hardware and the number of accounts to convert.
  • You cannot send or receive mail while the server is in the conversion process. We recommend that you run this process at an off-peak time.

The Mail Directory Conversion System

To access the Mail Directory Conversion System, run the following command at the command line:

/scripts/convert2maildir

The conversion options that are available to you vary based on whether your server currently uses a Maildir or mbox configuration. 

mbox options

If you currently run mbox on your server, you will see the following options:

        ____                  _
    ___|  _ \ __ _ _ __   ___| |
   / __| |_) / _` | '_ \ / _ \ |
  | (__|  __/ (_| | | | |  __/ |
   \___|_|   \__,_|_| |_|\___|_|
   Mail Directory (maildir) Conversion System 

NOTE: For users using POP accounts, converted messages will appear as new and will download twice. Users should re-download their messages after the conversion completes.

mbox is enabled
 
1) Start maildir conversion process with Courier mail server
2) Start maildir conversion process with Dovecot mail server
*) Exit 
Enter Selection---] 
  • Enter 1 and press Enter to convert your server from mbox to the Maildir storage format with Courier as the mail server.

  • Enter 2 and press Enter to convert your server from mbox to the Maildir storage format with Dovecot as the mail server.

  • To exit the script, enter an asterisk (*) and press Enter.

Maildir options

If you currently run Maildir on your server, you will see the following options:

        ____                  _
    ___|  _ \ __ _ _ __   ___| |
   / __| |_) / _` | '_ \ / _ \ |
  | (__|  __/ (_| | | | |  __/ |
   \___|_|   \__,_|_| |_|\___|_|
   Mail Directory (maildir) Conversion System 

NOTE: For users using POP accounts, converted messages will appear as new and will download twice. Users should re-download their messages after the conversion completes.

maildir is enabled

1) Convert partially converted mail accounts
2) Attempt to finish a failed conversion
*) Exit 
Enter Selection---] 
  • Enter 1 and press Enter to attempt to complete the mbox to Maildir conversion process on a partially-converted mail system. You should use this option if your server crashed during the conversion process or if you halted the conversion process.
  • Enter 2 and press Enter to attempt to finish a failed mbox to Maildir conversion attempt.
  • To exit the script, enter an asterisk (*) and press Enter.

Additional documentation