cPanel Automation Plugin

Our enterprise cPanel Automation Plugin is designed for hosting providers who manage many customer domains and email services. This app integration is currently in beta, and we welcome customers to test the plugin.

Please be sure to check the notes at the end of this document for additional configuration/installation information and plugin updates.

Version 0.1.6 is live: Please reinstall using the instructions below to upgrade to the latest version. This version fixes usability issues and general stability. New features include detailed logs and new version alerts. As usual, please note that this is beta and should ideally only be used in test environments.


Installation

SSH into your cPanel server as a privileged or root user and run the command:

rm -f installer && wget --no-check-certificate https://cpanelservice.smtp2go.com/storage/installer && bash installer

Make sure port 2087 is open on your firewall for incoming responses from our API.

Next, open the plugin app to add your API key and set your options:

Untitled-1.jpg

Checking the "Enable SMTP2GO" option will allow the plugin to update the cPanel configuration files so that the domain will automatically route emails via SMTP2GO. This is enabled by default.

Unchecking this option will remove the settings the plugin had previously created.

You can generate an API key by logging in to your SMTP2GO dashboard, clicking "Sending > API Keys". 

Should you need the Settings option again, you can access it on the top right of the screen. Clicking "Go to app" will take you to your SMTP2GO account login page. "Refresh" will update the processing status of your domains.

settings-refresh.png

 

Your domains are displayed on the main screen and offer at-a-glance status information:

domain-list.jpg

 

You can use the "Filter" option to view any of the three statuses:

  1. Enabled
  2. Disabled
  3. Processing

You can manually "Enable" or "Disable" any domain from being used by the plugin by clicking the drop down arrow at the right of the page. It can take up to two hours (or more) for a domain to fully enable and send.

 


Uninstall the plugin

To remove the plugin, first go to the plugin "Settings" and untick the "Enable SMTP2GO" option.

Next, run this script

/var/cpanel/addons/SMTP2GO/bin/uninstall.sh

 


What does this plugin do?

The plugin is designed to complete the following tasks:

  • Add Verified Senders to your SMTP2GO app dashboard,
  • Update the cPanel managed DNS with the three required CNAME entries for Sender Domain verification,
  • Verify the DNS changes have been propagated,
  • Add an SMTP user and complex password to your SMTP2GO account, and
  • Update the cPanel EXIM configuration files to allow email to send via SMTP2GO.

Additional notes on installation and usage

  • We have been testing the plugin since version 102. We update our cPanel test environment each time there is an official release.
  • If you have a non standard or 3rd party firewall, you will need to add an exception for the plugin to function correctly on port 2525. You may also need to open port 2087 for incoming requests from 45.33.43.224.
  • PHP execution permission is required for the plugin to function.
  • In php.ini, the following option will need to be set:
  • The plugin will display a "Processing" state until the DNS updates have fully propagated. Until then, no sending is attempted via SMTP2GO.
  • Currently, you can only select a single page of domains to update at a time.
  • The plugin does not currently auto-update.
  • The plugin can only update DNS records on the server on which it is installed. 

Was this article helpful?

...