Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
The Mailbox Format Conversion Scripts - Version 82 Documentation - cPanel Documentation
Page tree
For cPanel & WHM version 82.


Skip to end of metadata
Go to start of metadata

Overview 

The following scripts allow you convert mailbox formats:

  • /usr/local/cpanel/scripts/convert_mdbox_to_maildir — Converts mailboxes from mdbox format to maildir format.
  • /usr/local/cpanel/scripts/convert_maildir_to_mdbox — Converts mailboxes from maildir format to mdbox format.

Call the script

To run either of the scripts at the command line, run one of the following commands as the root user:

/usr/local/cpanel/scripts/convert_mdbox_to_maildir [options]
/usr/local/cpanel/scripts/convert_maildir_to_mdbox [options]

Options

When you run either script, you can specify the following options:

Note:

You must include either the --user= or the --email= option.

OptionDescriptionExample
--help

Displays the script's help message.

/usr/local/cpanel/scripts/convert_mdbox_to_maildir --help
/usr/local/cpanel/scripts/convert_maildir_to_mdbox --help
--userConvert a cPanel user and all of their email accounts.
/usr/local/cpanel/scripts/convert_mdbox_to_maildir --user=username
/usr/local/cpanel/scripts/convert_maildir_to_mdbox --user=username
--email

Convert a single email account.

Note:

Use one of the following email account formats:

  • username@example.com
  • username
  • _mainaccount@example.com
/usr/local/cpanel/scripts/convert_mdbox_to_maildir --email=username@example.com
/usr/local/cpanel/scripts/convert_maildir_to_mdbox --email=username@example.com
--delete-old-formatRemove the old files after successful conversion.
/usr/local/cpanel/scripts/convert_mdbox_to_maildir --user=username --delete-old-format
/usr/local/cpanel/scripts/convert_maildir_to_mdbox --user=username --delete-old-format

Additional documentation