Knut Sparhell

PRO ISP

<p>🕸️ By <a href="https://webfacing.eu/" rel="nofollow ugc">WebFacing™</a>. Read, send, show, manage, list, create, add, remove or delete email accounts, old messages, forwarders and autoresponders.<br />
One click read, send and manage all your emails without a login step. Update notification recipients. Backup and download your complete cPanel® account.</p>
<p>This plugin requires your site is hosted on a cPanel® equipped server.</p>
<p>It uses it’s UAPI through shell access by default, or via HTTP API. Using without <code>shell_exec</code> initially requires a temporary access token generated in the cPanel® native interface.</p>
<h3>Translation ready. Ready translations are</h3>
<ul>
<li>Norwegian (bokmål)</li>
</ul>
<h3>Current features</h3>
<ul>
<li><strong>NEW:</strong> Dashboard widget with three live graphic server memory usage and server load gauge charts (can eassily be minimized or hidden via Screen Options or programatically)</li>
<li>WP Block for frontend access user’s own Webmail</li>
<li>Bulk entry of forwarders and email accounts (as free trial only, very limited use)</li>
<li>Screen Options to select visible forms on New Email screen, saved for as user option (and per site for Multisite)</li>
<li>Shortcode <code>[wf_cpanel_email_webmail]</code> or as <code>[wf_cpanel_email_webmail]</code>My Email<code>[/wf_cpanel_email_webmail]</code> for frontend access user’s own Webmail</li>
<li>cPanel® API Tokens Management – needed in case <code>shell_exec</code> is not available or when accessing a remote server</li>
<li>Backup complete cPanel® hosting account to file, and download it</li>
<li>Restore account backup files by extracting it to a folder (experimental)</li>
<li>Semi automated migration to new email server, including setup of new accounts for users, with sending setup instructions, passwords and links to setup guides for most common email clients</li>
<li>Add 10 single Email Accounts per week (without Pro nag) — actually unlimited</li>
<li>Remove single/multiple Email Accounts</li>
<li>List mailboxes with number of messages for each box</li>
<li>Remove old messages from mailboxes (older than 52 weeks as default)</li>
<li>Shrink a mailbox (empty it)</li>
<li>Change storage quota for for email accounts</li>
<li>Add 20 forwarders per week (without Pro nag) — actually unlimited</li>
<li>Add/remove single/multiple Email Failure addresses or Blackhole addresses</li>
<li>Add/delete/edit email autoresponders (for, subject, body, from, start, stop, interval)</li>
<li>Send single cPanel® Email Account Instruction (Client Setup) to specfied address</li>
<li>Send multipe cPanel® Email Account Instructions (Client Setups) to yourself for distribution</li>
<li>Open your cPanel® Webmail app for selected account (single click/tap – no further login needed!)</li>
<li>Set/change Email Account passwords</li>
<li>Set Default Email Address (catch-all) as forwarder, failure or blackhole</li>
<li>View/change Notification/Contact Email Addresses</li>
<li>Access for any user to view and read their <em>own</em> emails, if given the <code>cpanel</code> capability (Use custom code or a Roles/Capabilities Manager plugin)</li>
<li>
<p>Support for subdomain email addresses when the main domain is a subdomain (only)</p>
</li>
<li>
<p>In case the <code>shell_exec</code> function is disabled in your server PHP configuration, create a token in native cPanel® interface and add <em>one</em> of these lines to your <code>wp-config.php</code> file, <code>functions.php</code> in your child theme, in Must-use plugin or a custom regular plugin</p>
<ul>
<li><code>const WF_CPANEL_API_TOKEN = 'my-temp-api-token';</code></li>
<li><code>define( 'WF_CPANEL_API_TOKEN', 'my-temp-api-token' );</code></li>
<li>See <a href="https://docs.cpanel.net/cpanel/security/manage-api-tokens-in-cpanel/" rel="nofollow ugc">Manage API Tokens in cPanel®</a></li>
<li>The <code>WF_CPANEL_API_TOKEN</code> constant may be removed when a new token is created and activated from the plugin admin page</li>
</ul>
</li>
<li>
<p>Option to set the default visibility for users on New Email screen (users may still set their own preferences):</p>
<ul>
<li><code>add_filter( 'wf-cpanel-email-new-email_user-option', static function( bool $default, string $option, int $user_id ) {<br />
if ( $option === 'wc-show-new-blackhole' /*or by $user_id*/ ) {<br />
$default = true/*false*/;<br />
}<br />
return $default;<br />
}, 10, 3 );</code></li>
</ul>
</li>
<li>
<p>Option to allow other users than those with <code>manage_options</code> capability to manage email adresses, single- or multisite, <em>one</em> of the following:</p>
<ul>
<li><code>add_filter( 'wf_cpanel_email_capability', static fn( string $cap ): string => $my_cpanel_email_cap );</code></li>
<li><code>add_filter( 'wf_cpanel_email_capability', static fn( string $cap ) => 'edit_published_pages' );</code></li>
</ul>
</li>
<li>
<p>Option to allow other users than those with <code>manage_options</code> capability to see the dashboard widget, or remove it, <em>one</em> of the following:</p>
<ul>
<li><code>add_filter( 'wf_cpanel_email_widget_capability', static fn( string $cap ): string => $my_cpanel_widget_cap );</code></li>
<li><code>add_filter( 'wf_cpanel_email_widget_capability', static fn( string $cap ) => 'edit_published_pages' );</code></li>
<li><code>add_filter( 'wf_cpanel_email_widget_capability', static fn( string $cap ) => 'do_not_allow' );</code></li>
</ul>
</li>
<li>
<p>Option to alter the refresh interval in seconds for the dashboard widget, <em>one</em> of the following:</p>
<ul>
<li><code>add_filter( 'wf_cpanel_email_widget_interval', static fn( int $interval ): int => $my_cpanel_widget_interval );</code></li>
<li><code>add_filter( 'wf_cpanel_email_widget_interval', static fn( int $interval ) => 45 );</code></li>
</ul>
</li>
<li>
<p>Option to limit email addresses to current site domain, even for single site admins, <em>one</em> of the following</p>
<ul>
<li><code>const WF_CPANEL_EMAIL_SITE_DOMAIN_ONLY = true;</code></li>
<li><code>define( 'WF_CPANEL_EMAIL_SITE_DOMAIN_ONLY', true );</code></li>
<li><code>add_filter( 'wf_cpanel_email_site_domain_only', '__return_true' );</code></li>
<li><code>add_filter( 'wf_cpanel_email_site_domain_only', fn() => true );</code></li>
</ul>
</li>
<li>
<p>Multisite Network: Option not to limit email addresses to current subsite domain, for site admins that are not network (super) admins, <em>one</em> of the following:</p>
<ul>
<li><code>const WF_CPANEL_EMAIL_SITE_DOMAIN_ONLY = false;</code></li>
<li><code>define( 'WF_CPANEL_EMAIL_SITE_DOMAIN_ONLY', false );</code></li>
<li><code>add_filter( 'wf_cpanel_email_site_domain_only', '__return_false' );</code></li>
<li><code>add_filter( 'wf_cpanel_email_site_domain_only', fn() => false );</code></li>
</ul>
</li>
<li>
<p>Many optional parameters and API filters for the shortcode output, see <code>includes/ShortCode.php</code> until further tested and documented</p>
</li>
<li>
<p>If you want to access another user on the server, use <em>one</em> of the following</p>
<ul>
<li><code>const WF_CPANEL_USER = 'my-username';</code></li>
<li><code>define( 'WF_CPANEL_USER', 'my-username' );</code></li>
</ul>
</li>
<li>
<p>If you want to access a remote server, use <em>one</em> of the following</p>
<ul>
<li><code>const WF_CPANEL_HOST = 'my-host';</code></li>
<li><code>define( 'WF_CPANEL_HOST', 'my-host' );</code></li>
<li>using <code>WF_CPANEL_HOST</code>requires <code>WF_CPANEL_USER</code> to also be defined</li>
</ul>
</li>
<li>
<p>Automaticallly create new accounts when a new user is registered?<br />
    add_action( ‘user_register’, static function( int $user_id, array $userdata ): void {<br />
            // What to do just after the registraton here, like this (adds an email address that forwards to all users, a mailing list):<br />
            if ( method_exists( ‘WebFacing\cPanel\UAPI’, ‘add_forwarder’ ) ) {<br />
                \WebFacing\cPanel\UAPI::add_forwarder( ‘all-users@yoursite.tld, ‘$userdata[‘user_email’] );<br />
            }<br />
        }, 2 );</p>
</li>
<li>
<p>Site Health</p>
<ul>
<li>Tests and information</li>
<li>Check auto detecting and current email routing in an extra Site Health tab (to any email address sent from your server)</li>
</ul>
</li>
</ul>
<h3>Possible future features</h3>
<ul>
<li>Scheduled automatic removal of old messages in/from mailboxes</li>
<li>Import migration list for create account, send instructions and password to current address</li>
<li>Delete <em>selected</em> email messages from mailboxes (by selectd message age etc.)</li>
<li>Suspend/unsuspend incoming/outgoing for email accounts (if requested)</li>
<li>Suspend/unsuspend <em>login</em> to email accounts (if requested)</li>
<li>Domain level email forwarding</li>
<li>Domain Managament</li>
<li>DNS Zone editing</li>
</ul>
<h3>Limitations, security, privacy – be warned</h3>
<ul>
<li>Maximum New Forwarders = 20, Maximum New Accounts = 5, weekly reset</li>
<li>Trial: Maximum New Forwarders as <strong>bulk entry</strong> = 4, Maximum New Accounts as <strong>bulk entry</strong> = 2</li>
<li>Now works without shell access! Will not work at all if <code>shell_exec</code> is disabled in <code>php.ini</code></li>
<li>Works only for admins, or other users with a custom <code>cpanel</code> capability and email on site domain (so far)</li>
<li>Any admin (if multisite, only network admins), or user with the filtered capability, on a site, can fully access <em>any</em> account on the cPanel® server instance</li>
<li>No AYS warnings for delete actions</li>
<li>If several sites/admins share the same cPanel® account, without being part of a WP Multisite network, no bulletproof separation, because of the way the cPanel® UAPI CLI works, with or without this plugin</li>
</ul>
<h3>Pro Addon</h3>
<ul>
<li>Pro Addon plugin was released May 1, 2023 at https://webfacing.eu/plugin/wf-cpanel-email-accounts-pro/ and will unlock <strong>in bulk entry</strong> new forwarders and new accounts to the numbers in the purchesed license</li>
</ul>


WebFacing™ – Email Accounts management for cPanel®

This plugin has been very useful to us for managing emails on a WordPress multisite installation. The developer is super responsive to bug reports as well!

Very useful plugin, and great support

WebFacing™ - Email Accounts management for cPanel®

<p>🕸️ By <a href="https://webfacing.eu/" rel="nofollow ugc">WebFacing™</a>. Shows disk usage, memory, cpu and processes resource usage information, recommendations and alerts, plus number of created email accounts, in your admin Dashboard At a Glance widget, a special Dashboard Gauges widget, plus error logs and extensive info on Tools – Site Health panels.</p>
<p>Resource gauges in custom dasboard widget.</p>
<p>Includes Server Error log test in Site Health.</p>
<p>Includes a Site Health test for HTTPS only (http should not be allowed, but forwarded to https) with information about the issue, recommendation and actions.</p>
<p>Made with a little help from <a href="http://www.cpanel.net/" rel="nofollow ugc">cPanel, L.L.C., USA</a> and <a href="https://proisp.eu/" rel="nofollow ugc">PRO ISP AS, Norway</a> – many thanks.</p>
<p>See also <a href="https://wordpress.org/plugins/wf-cpanel-email-accounts/" rel="ugc">WebFacing™ – Email Accounts management for cPanel®</a></p>
<h3>This plugin adds the following:</h3>
<h3>Dashboard</h3>
<h4>At a Glance (core widget)</h4>
<ul>
<li>One item showing used disk space</li>
<li>One line widget footer line mentioning the name of your web hosting provider, and maximum disk space for current plan/account (on PRO ISP only)</li>
</ul>
<h4>cPanel Resource Usage (custom widget)</h4>
<ul>
<li>Memory usage (gauge)</li>
<li>CPU usage (gauge)</li>
<li>Number of active Entry Processes (gauge)</li>
<li>Disk in/out usage (gauge)</li>
<li>cPanel® Server Errors last 24 hours</li>
</ul>
<h3>Tools – Site Health panel</h3>
<h4>Status (tab)</h4>
<ul>
<li>A disk space test with explaining text and possible actions (cPanel® only) with following result types and actions
<ul>
<li>Good (less than 90%)</li>
<li>Recommended (over 90%, but less than 95%)</li>
<li>Critical (over 95%)</li>
</ul>
</li>
<li>A HTTPS only test with explaining text (with HTTPS enabled only), actions with link to a relevant guide (special guide in case PRO ISP), and with the following result types and actions
<ul>
<li>Good (http loopback requests are rejected)</li>
<li>Recommended fix (http loopback requests successful)</li>
</ul>
</li>
<li>A Sever Error test with error log
<ul>
<li>Good (no errors last 24 hours)</li>
<li>Recommended (less than 25 errors)</li>
<li>Critical (more than 24 errors)</li>
</ul>
</li>
</ul>
<h4>Info (tab)</h4>
<ul>
<li>
<p>A disk space section containing (cPanel® only)</p>
<ul>
<li>cPanel® user name (private)</li>
<li>cPanel® user subaccounts and assigned services (private)</li>
<li>Two Factor Authentication enabled in cPanel®?</li>
<li>Max disk space available</li>
<li>Total disk space used
<ul>
<li>Disk used by media files</li>
</ul>
</li>
<li>Main domain in cPanel®
<ul>
<li>Addon domains</li>
<li>Parked domains</li>
<li>Dead domains</li>
</ul>
</li>
<li>MySQL® Disk Usage</li>
<li>CPU Usage</li>
<li>Entry Processes</li>
<li>Physical Memory Usage</li>
<li>In/Out Operations Per Second (IOPS)</li>
<li>In/Out Usage</li>
<li>Number of Processes</li>
<li>Number of cPanel® Server Errors</li>
<li>Contact email addresses in cPanel®</li>
</ul>
</li>
<li>
<p>Adds one line to the WordPress Server values section</p>
<ul>
<li>Number of cPanel® Server Errors</li>
</ul>
</li>
<li>
<p>Adds some lines to the WordPress Constant values section</p>
<ul>
<li><code>WP_</code>[<code>CONTENT</code>|<code>PLUGIN</code>]<code>_URL</code>s</li>
<li><code>WPMU_PLUGIN_</code>[<code>DIR</code>|<code>URL</code>]</li>
<li><code>WP_TEMP_DIR</code></li>
<li><code>UPLOADS</code></li>
<li><code>WP_DEFAULT_THEME</code></li>
<li><code>MEDIA_TRASH</code></li>
<li><code>IMAGE_EDIT_OVERWRITE</code></li>
<li>[<code>TEMPLATE</code>|<code>STYLESHEET</code>]<code>PATH</code>s</li>
<li><code>COOKIE_DOMAIN</code></li>
<li>[<code>SITE</code>]<code>COOKIEPATH</code></li>
<li><code>COOKIEHASH</code></li>
<li><code>*_COOKIE</code>s</li>
<li><code>*_COOKIE_PATH</code>s</li>
<li><code>FORCE_SSL_</code>[<code>ADMIN</code>|<code>LOGIN</code>]</li>
<li><code>WP_DISABLE_FATAL_ERROR_HANDLER</code></li>
<li><code>RECOVERY_MODE_EMAIL</code></li>
<li><code>AUTOMATIC_UPDATER_DISABLED</code></li>
<li><code>WP_AUTO_UPDATE_CORE</code></li>
<li><code>ALLOW_</code>[<code>UNFILTERED_UPLOADS</code>|<code>REPAIR</code>]</li>
<li><code>CORE_UPGRADE_SKIP_NEW_BUNDLED</code></li>
<li><code>DISALLOW_UNFILTERED_HTML</code></li>
<li><code>DISALLOW_FILE_</code>[<code>MOD</code>|<code>EDIT</code>]<code>S</code></li>
<li><code>WP_POST_REVISIONS</code></li>
<li><code>EMPTY_TRASH_DAYS</code></li>
<li><code>AUTOSAVE_INTERVAL</code></li>
<li><code>WP_LOCAL_DEV</code></li>
<li><code>SAVEQUERIES</code></li>
<li><code>RELOCATE</code></li>
<li>[<code>DISABLE_</code>|<code>ALTERNATE_</code>]<code>WP_CRON</code>[<code>_LOCK_TIMEOUT</code>]</li>
<li><code>CUSTOM_USER_</code>[<code>META_</code>]<code>TABLE</code>s</li>
<li>[<code>ALLOW_</code>]<code>MULTISITE</code></li>
</ul>
<h3>Translation ready, ready translations are</h3>
<ul>
<li>Norwegian (Bokmål)</li>
</ul>
<h3>Filter interval for fetching data for Dashboard Gauges widget</h3>
<p><code>wf_cpanel_gauges_interval</code> (default: 10 seconds)</p>
<h3>Filter capability for showing resource gauges widget</h3>
<p><code>wf_cpanel_widget_capability</code> (default: <code>manage_options</code>)</p>
<h3>Debug setting</h3>
<p>For extra debug information, add this line to your <code>wp-config.php</code> or in another plugin:</p>
<p>const WF_DEBUG = true;</p>
<h3>Known limitations</h3>
</li>
<li>Requires PHP `shell_exec´ to be available</li>
<li>Reports data from your own cPanel® server, not remote</li>
<li>Reports data from your cPanel® server, all sites and all other web or cPanel® applications, in case more than your WordPress is installed on it</li>
<li>Links to documentation to resolve reported issues are shown to PRO ISP AS customers only.</li>
<li>This plugin will not show much if the site is not on a cPanel® managed server, but will do the test for HTTPS only.</li>
</ul>


WebFacing™ – Storage, resource usage and errors in cPanel®

Shows storage information, recommendations and alerts in your dashboard At a Glance widget and on Site Health panel tabs.

WebFacing™ – Email Accounts management for cPanel® vs WebFacing™ – Storage, resource usage and errors in cPanel®