Notification Templates

For cPanel & WHM version 66

Overview

cPanel & WHM can send alerts to users when someone changes their account settings or an account approaches a limit, such as disk quotas. You can select the notifications that an account receives with the following interfaces:

cPanel's Notification Templates interface (Home >> Preferences >> Contact Information).
The Notifications section of WHM's Notification Templates interface (Home >> Server Configuration >> Tweak Settings).
WHM's Notification Templates interface (Home >> Server Contacts >> Contact Manager).

The notifications use Template Toolkit templates, and resellers and system administrators can customize these templates for their hosted customers. For example, you can add your logo to a notification, or include a link to your support web site.

This document explains which notification templates are available, and how to customize these templates.

Available notification templates

cPanel & WHM stores the templates in subdirectories under the /usr/local/cpanel/etc/icontact_templates/ directory. Each subdirectory's name represents the module that triggers the alert.

Note:

The system will overwrite any changes that you make to the templates in this directory. For more information about the custom templates directory, read the Customize the templates section below.

These templates use the notification_name.type.tmpl naming convention, where notification_name represents the name of the notification that triggers the alert and type represents the type of template.

Notification types

Notification templates use the following types:

subject — Subject line template, which allows you to configure the subject line of the message.
html or text — Message body template, which allows you to configure the body of the message.
- html — HTML version.
- text — Plaintext version.

Note:

If the text template does not exist, the system will derive the text template from the HTML template.

Notification names

The system uses the following notification templates:

File Locations	Description	Related Settings
`Accounts/DigestAuthResetNeeded.*.tmpl`	An account's domain name has changed, so the system notifies the system administrator that it has disabled Digest Authentication. This notification template uses the following sub-template from the `Accounts/includes` directory: `DigestAuthResetNeeded.body.html.tmpl`	Forced Disable of Digest Auth setting in WHM's Contact Manager interface.
`AdminBin/FullBackup.*.tmpl`	An account experienced a backup failure.	Backup Failure setting in WHM's Contact Manager interface.
`appconfig/Notify.*.tmpl`	Application notifications.	AppConfig registration notifications setting in WHM's Contact Manager interface.
`Application/Base.*.tmpl`	A notification that isn't already handled by an existing notification type and template.	Uncategorized Notifications setting in WHM's Contact Manager interface.
`Backup/Delayed.*.tmpl`	The system delayed a backup.	Backup Delayed setting in WHM's Contact Manager interface.
`Backup/Disabled.*.tmpl`	The system disabled a backup destination for an account.	cPanel Backup Destination Disabled setting in WHM's Contact Manager interface.
`Backup/Failure.*.tmpl`	The system failed to finish a backup.	Backup Failed To Finish setting in WHM's Contact Manager interface.
`Backup/PartialFailure.*.tmpl`	The system finished a backup, but it encountered errors.	Successful Backup setting in WHM's Contact Manager interface.
`Backup/PreBackupNotice.*.tmpl`	The system sends this notification before it runs a backup.	Scheduled Backup Will Start Soon setting in WHM's Contact Manager interface.
`Backup/Success.*.tmpl`	The system finished a backup.	Successful Backup setting in WHM's Contact Manager interface.
`Backup/Transport.*.tmpl`	A backup encountered transport errors.	Backup Transport Failure setting in WHM's Contact Manager interface.
`BandwidthUsageExceeded/Owner.*.tmpl`	Bandwidth overage notifications for resellers of accounts.	Bandwidth Limits setting in WHM's Contact Manager interface.
`BandwidthUsageExceeded/User.*.tmpl`	Bandwidth overage notifications for accounts.	Notifications setting in WHM's Tweak Settings interface
`ChangePassword/NewUser.*.tmpl`	A password setup notification for new Subaccounts.	Account Invites for Subaccounts setting in WHM's Tweak Settings interface.
`ChangePassword/ResetRequest.*.tmpl`	A user clicks the Forgot Password link.	Reset Password for Subaccounts setting in WHM's Tweak Settings interface. Reset Password for cPanel accounts setting in WHM's Tweak Settings interface.
`ChangePassword/User.*.tmpl`	A user changes their password.	cPanel Account Password setting in WHM's Contact Manager interface.
`Check/Biglog.*.tmpl`	A log file uses almost 2 GB of disk space.	System Log Approaches 2GB setting in WHM's Contact Manager interface.
`Check/CpanelRPMs.*.tmpl`	The system found altered RPMs, which pose a security risk.	Altered RPMs Check setting in WHM's Contact Manager interface.
`Check/EximConfig.*.tmpl`	The system cannot automatically update Exim. This notification template uses the following sub-templates from the `Check/includes` directory: `EximConfig.ConfigAttached.html.tmpl` `EximConfig.PreserveCustomizationsHeading.html.tmpl` `EximConfig.ResetACLBlock.html.tmpl` `EximConfig.ResetAll.html.tmpl` `EximConfig.ResetCFReplaceInserts.html.tmpl` `EximConfig.ResetCustomACLS.html.tmpl` `EximConfig.ResetHeader.html.tmpl` `EximConfig.ResetInserts.html.tmpl` `EximConfig.UnableToInstallCritical.html.tmpl` `EximConfig.UnableToInstallNotCritical.html.tmpl` `EximConfig.UpdateSteps.html.tmpl` `EximConfig.WHMLoginSteps.html.tmpl`	Exim Update Failures setting in WHM's Contact Manager interface.
`Check/Hack.*.tmpl`	The system detects a possible `root` compromise.	Root Compromise Checks setting in WHM's Contact Manager interface.
`Check/HostnameOwnedByUser.*.tmpl`	A user currently owns the server's hostname.	Hostname Conflicts with a cPanel User Account setting in WHM's Contact Manager interface.
`Check/ImmutableFiles.*.tmpl`	The system cannot update cPanel & WHM due to immutable files. This notification template uses the following sub-templates from the `Check/includes` directory: `ImmutableFiles.action.message.html.tmpl`	Update Failure Due to Immutable Files setting in WHM's Contact Manager interface.
`Check/InvalidDomains.*.tmpl`	The system detects invalid domains.	Invalid Domains setting in WHM's Contact Manager interface.
`Check/IP.*.tmpl`	The system cannot resolve the hostname to the correct IP address.	IP Address DNS Check setting in WHM's Contact Manager interface.
`Check/MySQL.*.tmpl`	The `check_mysql` script found corrupted database tables.	Corrupt Database Tables setting in WHM's Contact Manager interface.
`Check/MysqlConnection.*.tmpl`	The system encounters a MySQL® connection issue. This notification template uses the following sub-templates from the `Check/includes` directory: `MysqlConnection.cannot_reset_remote_pass.html.tmpl` `MysqlConnection.reset_pass_failed.html.tmpl` `MysqlConnection.reset_pass_successful.html.tmpl` `MysqlConnection._unable_to_auth_error.html.tmpl` `MysqlConnection.unknown_error.html.tmpl`	Remote MySQL Connection Failure setting in WHM's Contact Manager interface.
`Check/Oops.*.tmpl`	The kernel encounters an Oops error.	Kernel Crash Check setting in WHM's Contact Manager interface.
`Check/PopBeforeSMTPEnabled.*.tmpl`	The POP Before SMTP option is enabled, which poses a security risk.	POP before SMTP enabled in WHM's Contact Manager interface.
`Check/Resolvers.*.tmpl`	The server's DNS resolvers respond slowly or do not respond at all. This notification template uses the following sub-template from the `Check/includes` directory: `Resolvers.body.html.tmpl` `Resolvers.subject.html.tmpl`	DNS Resolver Performance Issues in WHM's Contact Manager interface.
`Check/SecurityAdvisorStateChange.*.tmpl`	The Security Advisor feature detected new issues with high importance. This notification template uses the following sub-template from the `Check/includes` directory: `SecurityAdvisorStateChange.body.html.tmpl`	Security Advisor State Change setting in WHM's Contact Manager interface.
`Check/Smart.*.tmpl`	Smartcheck detects a possible hard drive failure.	Disk Integrity Check setting in WHM's Contact Manager interface.
`Check/SSLCertExpired.*.tmpl`	A domain's SSL certificate has expired.	SSL Certificate Expiration setting in WHM's Contact Manager interface.
`Check/SSLCertExpiresSoon.*.tmpl`	A domain's SSL certificate expires soon.	SSL Certificate Expires Soon setting in WHM's Contact Manager interface.
`Check/UnmonitoredEnabledServices.*.tmpl`	Every two weeks, the system scans all active services and sends a notification that lists all of the unmonitored services. This notification template uses the following sub-template from the `Check/includes` directory: `UnmonitoredEnabledServices.body.html.tmpl`	Unmonitored Services setting in WHM's Contact Manager interface.
`Check/ValidServerHostname.*.tmpl`	The system detected an invalid hostname for the server's main IP address.	Invalid Hostname For Main IP Address setting in WHM's Contact Manager interface.
`chksrvd/Diskusage.*.tmpl`	Disk usage notifications.	Disk Usage Warnings setting in WHM's Contact Manager interface.
`chksrvd/Hang.*.tmpl`	The system detected a hung device and restarted it.	Hung Service Checks setting in WHM's Contact Manager interface.
`chksrvd/Notify.*.tmpl`	Service status notifications.	Service failures (ChkServd) setting in WHM's Contact Manager interface.
`chkservd/OOM.*.tmpl`	The system terminated a process to avoid a crash due to low memory.	System Out of Memory setting in WHM's Contact Manager interface.
`CloudLinux/Update.*.tmpl`	The system detects a CloudLinux™ license and provides installation instructions. This notification template uses the following sub-templates from the `CloudLinux/includes` directory: `Update.body.html.tmpl`	CloudLinux License Detected setting in WHM's Contact Manager interface.
`Config/CpConfGuard.*.tmpl`	The system has restored the `cpanel.config` file from settings in the cache and configuration defaults file.	cPanel Configuration Checks setting in WHM's Contact Manager interface.
`ContactInfo/Change.*.tmpl`	Contact information change notifications.	cPanel's Update Confact Information interface.
`ConvertAddon/ConversionCompleted.*.tmpl`	Convert Addon Domain to Account notifications.	Convert Addon Domain to Account setting in WHM's Transfers interface.
`cPHulk/BruteForce.*.tmpl`	cPHulk brute force notifications.	cPHulkd Brute Force setting in WHM's Contact Manager interface.
`cPHulk/Login.*.tmpl`	Login notifications.	cPHulkd Notifications and Root login notifications (cpHulkd) setting in WHM's Contact Manager interface.
`DAV/ChangeHostname.*.tmpl`	The system launched a background task to update the hostname in individual Horde databases.	Hostname Change Notifications setting in WHM's Contact Manager interface.
`dbindex/Warn.*.tmpl`	The dbindex cache file is out of date by more than four hours.	The dbindex Cache File Out Of Date setting in WHM's Contact Manager interface.
`DigestAuth/Disable.*.tmpl`	An account's domain name has changed, so the system notifies the account owner that they must re-enable Digest Authentication.	Digest Authentication Disabled Due to Account Rename setting in WHM's Contact Manager interface.
`DnsAdmin/ClusterError.*.tmpl`	The system encountered an error with the DNS cluster.	DNS Cluster Error setting in WHM's Contact Manager interface.
`DnsAdmin/UnreachablePeer.*.tmpl`	The system was unable to contact a server in the DNS cluster.	Lost Contact With DNS Cluster setting in WHM's Contact Manager interface.
`EasyApache/EA4_LangHandlerMissing.*.tmpl`	EasyApache 4 encountered a missing handler.	EasyApache Configuration setting in WHM's Contact Manager
`EasyApache/EA4_MigrationModSec.*.tmpl`	EasyApache 4 migrated the ModSecurity configuration, and it had to make a change to the custom user configuration file in order to ensure maximum compatibility.
`EasyApache/EA4_TemplateCheckUpdated.*.tmpl`	The system detects an updated EasyApache 4 template.	EasyApache 4 template updated setting in WHM's Contact Manager interface.
`Greylist/CommonProviderRemoval.*.tmpl`	A mail provider no longer exists on the Greylisting Common Mail Providers list.	Greylist System Changes setting in WHM's Contact Manager interface.
`Horde/MySQLToSQLite.*.tmpl`	The system failed to convert the Horde database to SQLite.	Horde Table Conversion Failure setting in WHM's Contact Manager interface.
`iContact/SendIMFailed.*.tmpl`	The system failed to send a notification via an instant message.	Instant Message Failure setting in WHM's Contact Manager interface.
`ImportMyDNSdb/Failure.*.tmpl`	The system failed to import zone files into the MyDNS database. This notification template uses the following sub-templates from the `ImportMyDNSdb/includes` directory: `Failure.already_running.html.tmpl` `Failure.cannot_connect_to_database.html.tmpl` `Failure.cannot_get_zones.html.tmpl` `Failure.cannot_purge_rss.html.tmpl` `Failure.cannot_read_zone_file.html.tmpl` `Failure.cannot_repair.html.tmpl` `Failure.database_error.html.tmpl` `Failure.insufficient_permissions.html.tmpl`	MyDNS Zone Import Failure setting in WHM's Contact Manager interface.
`ImportMyDNSdb/InProgress.*.tmpl`	An import of zone files into the MyDNS database is in progress. This notification template uses the following sub-templates from the `ImportMyDNSdb/includes` directory: `InProgress.zones_imported_successfully.html.tmpl`	MyDNS Zone Import In Progress setting in WHM's Contact Manager interface.
`ImportMyDNSdb/Success.*.tmpl`	The system successfully imported zone files into the MyDNS database. This notification template uses the following sub-templates from the `ImportMyDNSdb/includes` directory: `Success.successful_completion.html.tmpl` `Success.zones_imported_successfully.html.tmpl`	MyDNS Zone Import Successful setting in WHM's Contact Manager interface.
`Install/CheckcPHulkDB.*.tmpl`	cPHulk detected database corruption issues.	cPHulk Database Integrity Notices in WHM's Contact Manager interface.
`Install/CheckRemoteMySQLVersion.*.tmpl`	The system does not support the version of MySQL on a remote MySQL server.
`Install/ClamavConnector.*.tmpl`	The rpm.versions system upgraded ClamAV.	ClamAV Upgrade Changes setting in WHM's Contact Manager interface.
`Install/DatabaseDeprecations.*.tmpl`	A notification about MySQL databases that cPanel & WHM deprecated. The system administrator can remove these databases when convenient.
`Install/Horde.*.tmpl`	The system failed to properly convert a table in Horde.	Horde Maintenance Notification setting in WHM's Contact Manager interface.
`Install/PackageExtension.*.tmpl`	The system renames a package extension and updates all dependent package extensions to use the new filename due to a name conflict.	Package Extension Name Conflicts setting in WHM's Contact Manager interface.
`killacct/Notify.*.tmpl`	Account termination notifications.	Account Removal setting in WHM's Contact Manager interface.
`killacct/PostTerminateCleanup.*.tmpl`	The system cleaned up file permissions after a user termination.	Account Removal setting in WHM's Contact Manager interface.
`Logd/Notify.*.tmpl`	The system timed out while it processed a domain's bandwidth data.	Bandwidth Data Processing Timeout setting in WHM's Contact Manager interface.
`Logger/Notify.*.tmpl`	The system performed a deprecated call within a script and terminated the script.	Script Terminated Due to Deprecated Call setting in WHM's Contact Manager interface.
`Mail/ClientConfig.*.tmpl`	Send the mail client configuration file to a new mail user. This notification template uses the following sub-template from the `Mail/includes` directory: `clientconf_manual_settings_include.html.tt`	Email Client Configuration setting in WHM's Contact Manager interface.
`Mail/SendLimitExceeded.*.tmpl`	A domain exceeds the daily emails sent threshold defined by the Number of emails a domain may send per day before the system sends a notification. option in WHM's Tweak Settings interface (Home >> Server Configuration >> Tweak Settings).	Outgoing Email Threshold Exceeded setting in WHM's Contact Manager interface.
`MailServer/OOM.*.tmpl`	The mail server ran out of memory while it processed mail for an account.	Mail Server Out of Memory setting in WHM's Contact Manager interface.
`Market/SSLWebInstall.*.tmpl`	The system attempted to download and install an SSL certificate that a cPanel user ordered through the SSL/TLS Wizard interface.	Installation of Purchased SSL Certificates setting in WHM's Contact Manager interface.
`migrate_branding/Notify.*.tmpl`	Branding upgrade compatibility warning notifications.	Branding Migration setting in WHM's Contact Manager interface.
`newmailcgi/Notify.*.tmpl`	A user uploads a CGI mail script that could potentially send spam.	Recently Uploaded CGI Script Mail setting in WHM's Contact Manager interface.
`NSD/BadZones.*.tmpl`	The system detected corrupt DNS zones. This notification template uses the following sub-templates from the `NSD/includes` directory: `BadZones.body.html.tmpl`	NSD DNS Zones Corrupted setting in WHM's Contact Manager interface.
`OutdatedSoftware/Notify.*.tmpl`	The system detected outdated software. Note: Notices for cPanel & WHM updates exist in the `upcp` templates.	Notifications of Outdated Software setting in WHM's Contact Manager interface.
`OverLoad/CpuWatch.html.tmpl`	A user's process stalled.	Stalled Process Notifications setting in WHM's Contact Manager interface.
`OverLoad/LogRunner.html.tmpl`	A process stalled while it processed a user's statistics and bandwidth data.	Stalled Statistics and Bandwidth Process Notifications setting in WHM's Contact Manager interface.
`PaperLantern/UpdateUsers.*.tmpl`	The upgrade to cPanel & WHM version 54 updated users from the x3 or x3mail themes to the Retro style for the Paper Lantern theme.	User Theme Update setting in WHM's Contact Manager interface.
`parkadmin/Notify.*.tmpl`	A user parked a domain on top of another domain.	Notification of New Addon Domains setting in WHM's Contact Manager interface.
`queueprocd/Notify.*.tmpl`	The system must shut down the `queueprocd` daemon due to repeated exceptions.
`Quota/DiskWarning.*.tmpl`	Disk quota warning notifications.	User Disk Usage Warning setting in WHM's Contact Manager interface.
`Quota/List.*.tmpl`	Mailbox quota warning notifications for multiple mailboxes.	User Disk Usage Warning setting in WHM's Contact Manager interface.
`Quota/MailboxWarning.*.tmpl`	Mailbox quota warning notifications for a single mailbox.	Notifications setting in WHM's Tweak Settings interface.
`Quota/RebootRequired.*.tmpl`	The system requires a reboot in order to enable filesystem quotas.	Reboot To Enable Filesystem Quotas Reminder setting in WHM's Contact Manager interface.
`Quota/SetupComplete.*.tmpl`	The system successfully finished the process to enable filesystem quotas.	Filesystem Quotas Ready setting in WHM's Contact Manager interface.
`RPMVersions/Notify.*.tmpl`	The system converted settings in the `cpupdate.conf` file to settings in the local.versions file.	Conversion of `cpupdate.conf` settings to `local.versions` setting in WHM's Contact Manager interface.
`Security/AuthnMethodLinkedToAccount.*.tmpl`	A user links their cPanel account to an account at an external authentication provider.	An external account is linked to my account for authentication setting in cPanel's Update Contact Information interface.
`SSHD/ConfigError.*.tmpl`	The system detects an attempt to change the `sshd_config` file.	SSHD Configuration Error in WHM's Contact Manager interface.
`Stats/Lagging.*.tmpl`	The system cannot maintain its log processing schedule because of an overload or unusually high levels of traffic.
`StuckScript/Notify.*.tmpl`	The system detects a stuck script.	Stuck Script setting in WHM's Contact Manager interface.
`suspendacct/Notify.*.tmpl`	Account suspension notifications.	Account Suspensions setting in WHM's Contact Manager interface.
`sysup/Notify.*.tmpl`	The system fails to update.	System Update Failures setting in WHM's Contact Manager interface.
`TwoFactorAuth/UserDisable.*.tmpl`	A user disabled two-factor authentication.	User Disabled Two-Factor Authentication setting in WHM's Contact Manager interface.
`TwoFactorAuth/UserEnable.*.tmpl`	A user enabled two-factor authentication.	User Enabled Two-Factor Authentication setting in WHM's Contact Manager interface.
`unsuspendacct/Notify.*.tmpl`	Account unsuspension notifications.	Account UnSuspensions setting in WHM's Contact Manager interface.
`upacct/Notify.*.tmpl`	Account modification notifications.	Account Modification setting in WHM's Contact Manager interface.
`upcp/Killed.*.tmpl`	The system aborts or terminates an update of WHM.	System Update Failures setting in WHM's Contact Manager interface.
`upcp/MaintenanceFailed.*.tmpl`	The `upcp` script fails to update WHM.	System Update Failures setting in WHM's Contact Manager interface.
`upcp/PostSyncCleanupFailed.*.tmpl`	The system fails to clean up after `upcp` script updates WHM.	System Update Failures setting in WHM's Contact Manager interface.
`upcp/UpdateNowFailed.*.tmpl`	The `updatenow` script fails to update the system.	System Update Failures setting in WHM's Contact Manager interface.
`Update/Blocker.*.tmpl`	The system fails to update because of a version blocker.	Update Version Blocker setting in WHM's Contact Manager interface.
`Update/Now.*.tmpl`	Update failure notifications.	Update Failures setting in WHM's Contact Manager interface.
`Update/ServiceDeprecated.*.tmpl`	The cPanel & WHM update failed because of a deprecated service.	Update Blocker - Service Deprecation Notice setting in WHM's Contact Manager interface.
`Update/UpgradeRequired.*.tmpl`	cPanel & WHM will automatically upgrade a service.	Upgrade Required - Service Is Outdated setting in WHM's Contact Manager interface.
`wwwacct/Notify.*.tmpl`	New account creation notifications.	Account Creation setting in WHM's Contact Manager interface.

Additional templates and resources

The system includes the following subdirectories:

include — This directory contains several useful template snippets and icons in .png file format that you may wish to use in your templates.
wrapper — The main notification template wrapper. This wrapper standardizes the format of each notification and it includes the header, body, and footer in the message. The standard footer contains links that allow the user to disable or change the importance of that type of notification.

Available variables

Notification templates use two kinds of variables: CPANEL and NOTICE.

`CPANEL` variables

All of the notification templates can use the following two CPANEL variables:

locale (object) — If the system directs this notification at a user, this variable returns the user's locale. Otherwise, the variable returns the server's locale.
split_time_dhms (function) — This function converts a number of seconds into a four-member array that indicates days, hours, minutes, and seconds. Use this function to transform system times to human-readable-times.

`NOTICE` variables

Each template lists its allowed NOTICE variables and their descriptions in the header comments.

For example, [% NOTICE.ip_address %] displays the IP address of a request.

Customize a template

To customize a template, copy the desired template from the /usr/local/cpanel/etc/icontact_templates/ directory to the /var/cpanel/templates/icontact_templates/ custom templates directory, and make your changes to the copy.

The system uses templates in the custom templates directory before it uses templates from the original directory.

Example

Note:

The following example demonstrates how to add the Example Hosting, Inc. company name to the subject line of account creation notifications.

To customize a template, perform the following steps:

Log in to the server via SSH as the root user.
If this is your first template customization, run the following command to make the custom templates directory and copy the files in the include and wrapper directories to the custom templates directory:
```
mkdir /var/cpanel/templates/icontact_templates && cp -rp /usr/local/cpanel/etc/icontact_templates/{include,wrapper} /var/cpanel/templates/icontact_templates
```
Copy the /usr/local/cpanel/etc/icontact_templates/wwwacct/Notify.subject.tmpl file to /var/cpanel/templates/icontact_templates/wwwacct/Notify.subject.tmpl file.
Open the /var/cpanel/templates/icontact_templates/ wwwacct/Notify.subject.tmpl file in a text editor:
```
[%-
 CPANEL.locale.maketext('New account on [_1] ([_2])', NOTICE.host_server,NOTICE.domain);
-%]
```

Edit the Notify.subject.tmpl file to appear similar to the following example:

[%-
 CPANEL.locale.maketext('Example Hosting, Inc.: New account on [_1] ([_2])', NOTICE.host_server,NOTICE.domain);
-%]

Additional documentation

Notification Templates — This document describes cPanel & WHM's Template Toolkit, the main template system for the cPanel and WHM interfaces.

Notification Templates — This document describes the locale system, a system that localizes text in Perl, Template Toolkit, or JavaScript code.

Template Toolkit website — This external website contains information about the Template Toolkit, a fast, flexible, and highly extensible template processing system.

Content by label

There is no content with the specified labels

Page:

How to Send Server Notifications to Custom Services

Content by label

There is no content with the specified labels

Page tree

Notification Templates

Overview

Available notification templates

Notification types

Notification names

Additional templates and resources

Available variables

CPANEL variables

NOTICE variables

Customize a template

Example

Additional documentation

`CPANEL` variables

`NOTICE` variables