Help Center

MailChannels cPanel & WHM plugin for Outbound Filtering

Highlights

  • Centralized log summary data for all outbound messages.
  • Protect all domains, or specifically exclude/include those domains you choose.
  • Trial Inbound anti abuse protections include up to 5 domains with active outbound subscription.
  • Enable routing of all outbound email through the MailChannels Outbound filtering platform, with an active subscription.
  • Custom automated false positive/negative remediation through MailChannels Insight links included in NDR bounce responses.

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 or the root user 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 you ran the command without using the --purge option, you should manually delete the configuration files(/etc/mailchannels/*) to remove them completely from your system.

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.

 


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 by navigating to Settings > Account > SMTP Passwords.

 

 

 

 

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.