The setupmailserver Script

Valid for versions 82 through the latest version

Version:

82


Last modified: January 28, 2021

Overview

The /usr/local/cpanel/scripts/setupmailserver script lets you select a mail server.

Note:

cPanel & WHM only ships with the Dovecot mail server.

Run the script

To run this script on the command line, use the following format:

/usr/local/cpanel/scripts/setupmailserver [options] [mailserver]
Important:

This script only accepts the following mailserver values:

  • dovecot — The Dovecot mail server.
  • disabled — This disables local POP3 and IMAP functionality. Dovecot will only function in authentication-only mode.

Options

Use the following options with this script:

Options Description Example
--force Force the system to perform the mail server conversion. --force
--current Display the currently-configured mail server. --current
--help Display the script’s help documentation. --help

Additional Documentation