Help Center

MailChannels cPanel & WHM plugin for Inbound Filtering

Highlights

  • Protect domains directly from the WHM admin interface.
  • Protect all domains, or protect a selection of domains.
  • Displays the protection status of all domains.
  • If the host has multiple subscriptions, select which subscription to provision under.
  • There is an option to automatically update DNS SRV and MX records when protecting a domain.
  • There is an option to automatically protect domains when they are added to cPanel.
  • There is an option to automatically deprovision domains when they are removed from cPanel.
  • There is an option to protect addon and parked domains in bulk and automatic provisioning operations.
  • Enable routing of all outbound email through MailChannels Outbound relay service, if service is subscribed to.

Getting Started

Requirements

This cPanel plugin requires:

  • cPanel & WHM Version 68 or higher
  • PHP 5.6 or higher

Installation

To install the plugin on a cPanel instance log into the terminal on the cPanel instance and run the following command:

wget https://s3.amazonaws.com/mailchannels-reseller/plugins/mailchannels-cpanel-v3-installer 
&& bash mailchannels-cpanel-v3-installer

Upgrading From a Previous Version

If you are upgrading from the previous v2 cPanel plugin you must uninstall the plugin first before installing the V3 plugin. The v3 installer will ask you if you'd like to uninstall the v2 plugin if it's there. If you say no, the installer will exit and you must uninstall the v2 plugin yourself before proceeding.

Uninstalling MailChannels cPanel Plugin v3

/usr/local/mailchannels/bin/uninstall.sh

Options
--purge - Using the purge option will remove all the logs and configuration files.
Also,if MailChannels Outbound is detected, the uninstall script will disable
MailChannels Outbound without prompt.


The script has to be run as a superuser to uninstall the plugin.

If the script is run without any flags the log files (located at /var/log/mailchannels) and the configuration files (located at /etc/mailchannels) will remain. Use the --purge option will remove these files.

If the purge option is provided and MailChannels Outbound has been detected, the uninstall script will disable MailChannels Outbound without prompt.

If the uninstaller detects that MailChannels Outbound has been enabled (resulting in outbound email being filtered through Mailchannels), the uninstaller will ask if Mailchannels Outbound should be disabled. Answering yes will set your outbound mail settings back to what it was before installing the plugin. This is the recommended option.

Configuration

Once installed, you can find the MailChannels plugin by logging into the cPanel/WHM interface and searching for “MailChannels” using the search box at the top of the left navigation bar.

 

When you click on the MailChannels plugin, a new browser tab will open to display the plugin interface. If you haven’t yet configured your MailChannels API key, you’ll need to do that next. See API Keys below.


API Configuration

API Key

The first thing you’ll need to do to get up and running with MailChannels is configure your API key so that the plugin can be authorized to communicate with the MailChannels service. If you’re not already on the Configuration page of the plugin, click on the Configuration link in the left navigation bar. The Configuration page has three sections, click on the API section header to expand the API configuration section. 

If you don’t already know your API key, it can be created or retrieved from the Host Console. Enter your API key into the provided field and click UPDATE.


Inbound Configuration

Access the Inbound configuration section by clicking on the Configuration link in the left navigation bar and then clicking on the Inbound header to expand the Inbound configuration section.

 

Subscription

Select the subscription under which you want domains to be provisioned. You may only have a single MailChannels Inbound subscription, in which case it will be selected by default. Changing this setting will not impact currently provisioned domains, only domains provisioned in the future.

Options

Automatically provision newly added domains[a][b]

With this option enabled, newly added cPanel domains will be provisioned automatically with MailChannels service. In most cases, you will want to enable “Automatically update DNS configuration” below, in order for this to work effectively. Whether or not parked and addon domains are also provisioned automatically depends on the “Process parked and addon domains during bulk and automatic protection operations” option below. Default: disabled.

Automatically deprovision removed domains, including parked/addon domains

With this option enabled, domains that are removed from cPanel, including parked and addon domains, are automatically deprovisioned from the MailChannels service, freeing up license slots for other domains on your system. Default: enabled.

Automatically update DNS configuration

With this option enabled, the required SRV and MX records are automatically added to the DNS zone file when protecting a domain and removed from the DNS zone file when unprotecting a domain. Default: enabled.

Process parked and addon domains during bulk and automatic protection operations

With this option enabled, parked and addon domains are included in bulk and automatic protection operations. Existing MX records will be copied to SRV records and replaced by MX records that point to the MailChannels Inbound service. When unprotected, the reverse process is used to copy the SRV records to MX records and the SRV records are then removed. Please note that MailChannels does not currently support domain aliasing, so addon and parked domains will count towards your quota of protected domains. Default: disabled.


Outbound Configuration[c]

Access the Outbound configuration section by clicking on the Configuration link in the left navigation bar and then clicking on the Outbound header to expand the Outbound configuration section.

MailChannels Account ID

Your MailChannels Account ID can be found in the top right corner of the Host Console.

SMTP Password

You can get or create an SMTP password in the Host Console.

Bulk Operations

In addition to protecting individual domains, you can protect domains in bulk using one of the bulk operations, Protect Selected or Protect All.

After performing a bulk operation, you will be presented with a summary results dialog which will indicate if the operation completed successfully or had errors. It shows the number of domains completed, skipped and failed as well as the results for individual domains. The results table is sortable, so you can click on the column header to sort by that column. For example, to see all the domains with a Failed status, click on the Status column header.

You can click on Retry, next to individual domains, or Retry All Failed to retry the operation for one or all domains with the Failed status. To get more information about why an operation failed for a particular domain, hover over the status column for the failed domain to display a popover dialog containing the details of the error.

 

 

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Please sign in to leave a comment.