WebFacing™ – Email Accounts management for cPanel®

🕸️ By WebFacing™. Read, send, show, manage, list, create, add, remove or delete email accounts, old messages, forwarders and autoresponders.
One click read, send and manage all your emails without a login step. Update notification recipients. Backup and download your complete cPanel® account.

This plugin requires your site is hosted on a cPanel® equipped server.

It uses it’s UAPI through shell access by default, or via HTTP API. Using without shell_exec initially requires a temporary access token generated in the cPanel® native interface.

Translation ready. Ready translations are

• Norwegian (bokmål)

Current features

• NEW: WP Block for frontend access user’s own Webmail
• Bulk entry of from dependent forwarders and email accounts (trial only, limited use)
• Screen Options to select visible forms on New Email screen, saved for as user option (and per site for Mulitsite)
• Search for email
• Duplicate check for New Account Form
• Shortcode [wf_cpanel_email_webmail] or as [wf_cpanel_email_webmail]My Email[/wf_cpanel_email_webmail] for frontend access user’s own Webmail
• API Tokens Management
• No need to have shell_exec enabled in PHP, see below
• Backup account to file, and download
• Restore account backup files by extracting it to a folder (experimental)
• Accounts listing per domain managed via cPanel®
• Completely automated migration to new email server, like setup of new accounts for users, with sending setup instructions, passwords and links to setup guides for most common email clients
• Add 10 single Email Accounts per week (without Pro nag) — else unlimited
• Remove single/multiple Email Accounts
• List mailboxes with number of messages for each account
• Remove old messages from mailboxes (older than 52 weeks implied, currently)
• Shrink a mailbox (empty it)
• Change storage quota for for email accounts
• Add 20 forwarders per week (without Pro nag) — else unlimited
• Add/remove single/multiple Email Failure addresses or Blackhole addresses
• Add/delete/edit email autoresponders (for, subject, body, from, start, stop, interval)
• Send single cPanel® Email Account Instruction (Client Setup) to specfied address
• Send multipe cPanel® Email Account Instructions (Client Setups) to yourself for distribution
• Open your cPanel® Webmail app for selected account (single click/tap – no further login needed!)
• Set/change Email Account passwords
• Set Default Email Address (catch-all) as forwarder, failure or blackhole
• View/change Notification/Contact Email Addresses
• Check auto detect and actual email routing in a Site Health tab (any email address, as sent from this server)
• Access for any user to view and read their own emails, if given the cpanel capability
• Support for subdomain email addresses when main domain is a subdomain
• Option to set the default visibility for users on New Email screen (users may still set their own preferences):
  • add_filter( 'wf-cpanel-email-new-email_user-option', static function( bool $default, string $option, int $user_id ) {
if ( $option === 'wc-show-new-blackhole' /*or by $user_id*/ ) {
$default = true/*false*/;
}
return $default;
}, 10, 2 );
• Option to allow other users than those with manage_options capability to manage email adresses, single- or multisite, one of the following:
  • add_filter( 'wf_cpanel_email_capability', static fn( string $cap ) => $my_cpanel_email_cap );
  • add_filter( 'wf_cpanel_email_capability', static fn( string $cap ) => 'edit_published_pages' );
• Option to limit email addresses to current site domain, even for single site admins, one of the following
  • const WF_CPANEL_EMAIL_SITE_DOMAIN_ONLY = true;
  • define( 'WF_CPANEL_EMAIL_SITE_DOMAIN_ONLY', true );
  • add_filter( 'wf_cpanel_email_site_domain_only', '__return_true' );
  • add_filter( 'wf_cpanel_email_site_domain_only', fn() => true );
• Multisite Network: Option not to limit email addresses to current subsite domain, for site admins that are not network (super) admins, one of the following:
  • const WF_CPANEL_EMAIL_SITE_DOMAIN_ONLY = false;
  • define( 'WF_CPANEL_EMAIL_SITE_DOMAIN_ONLY', false );
  • add_filter( 'wf_cpanel_email_site_domain_only', '__return_false' );
  • add_filter( 'wf_cpanel_email_site_domain_only', fn() => false );
• Many optional parameters and API filters for the shortcode output, see includes/ShortCode.php until further tested and documented (coming soon)
• If the shell_exec function is disabled in your server PHP configuration, add one of these lines to your wp-config.php file, child theme functions.php or in Must-use plugin
  • const WF_CPANEL_API_TOKEN = 'paste-your-api-token';
  • define( 'WF_CPANEL_API_TOKEN', 'paste-your-api-token' );
  • See Manage API Tokens in cPanel®
  • The WF_CPANEL_API_TOKENmay be removed when a new token is created and activated from the admin page
  • If you want to access another user on the server, use one of the following
  • const WF_CPANEL_USER = '%username%';
  • define( 'WF_CPANEL_USER', '%username%' );
  • If you want to access a remote server, use one of the following
  • const WF_CPANEL_HOST = '%host%';
  • define( 'WF_CPANEL_HOST', '%host% );
  • using WF_CPANEL_HOSTrequires WF_CPANEL_USER to also be defined
  • Site Health tests and information

Possible future features

• Scheduled automatic removal of old messages in/from mailboxes
• Import migration list for create account, send instructions and password to current address
• Delete selected email messages from mailboxes (by selectd message age etc.)
• Suspend/unsuspend incoming/outgoing for email accounts (maybe)
• Suspend/unsuspend login to email accounts (if requested)
• Domain Managament
• Domain level email forwarding

Limitations, security, privacy – be warned

• Maximum New Forwarders = 20, Maximum New Accounts = 5, weekly reset
• Trial: Maximum New Forwarders as bulk entry = 4, Maximum New Accounts as bulk entry = 2
• Now works without shell access! Will not work at all if shell_exec is disabled in php.ini
• Works only for admins, or other users with a custom cpanel capability and email on site domain (so far)
• Any admin (if multisite, only network admins), or user with the filtered capability, on a site, can fully access any account on the cPanel® server instance
• No AYS warnings for delete actions
• 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

Pro Addon

• Pro Addon plugin will be released May 1, 2023 at https::/webfacing.eu/ and will unlock in bulk entry new forwarders and new accounts to the numbers in the purchesed license