Notification Templates

Valid for versions 120 through the latest version

Version:

Overview

cPanel & WHM can send alerts to users for various reasons (for example, when someone changes their account settings or an account approaches a quota). You can select the notifications that an account receives with the following interfaces:

cPanel’s Contact Information interface (cPanel » Home » Preferences » Contact Information).
The Notifications section of WHM’s Tweak Settings interface (WHM » Home » Server Configuration » Tweak Settings).
WHM’s Contact Manager interface (WHM » Home » Server Contacts » Contact Manager).

The notifications use Template Toolkit templates that hosting providers can customize. For example, you can add your logo to a notification, or include a link to your support website. This document explains which notification templates exist and how to customize them.

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.

Warning:

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 a template 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.
If the text template does not exist, the system will derive the text template from the HTML template.

Note:

Additional WP Toolkit notification templates may be available based on 3rd party installations. For more information, read Plesk’s WP Toolkit documentation.

Notification names

The system uses the following notification templates:

Template file	Description	Interface setting
`Accounts/ChildDedistributionFailure.*.tmpl`	A parent server node failed to restore a cPanel account’s offloaded service functionality from a child server node.	Contact Manager Transfer Offloaded Functionality from a Child Node Failure
`Accounts/ChildDedistributionSuccess.*.tmpl`	A parent server node successfully restored a cPanel account’s offloaded service functionality from a child server node.	Contact Manager Transfer Offloaded Functionality from a Child Node Success
`Accounts/ChildDistributionFailure.*.tmpl`	The system failed to offload functionality to a linked cPanel & WHM child server node.	Contact Manager Offload Functionality to a Child Node Failure
`Accounts/ChildDistributionSuccess.*.tmpl`	The system successfully offloaded functionality to a linked cPanel & WHM child server node.	Contact Manager Offload Functionality to a Child Node Success
`Accounts/ChildRedistributionFailure.*.tmpl`	A parent server node failed to offload functionality to a different linked cPanel & WHM child server node.	Contact Manager Transfer Offloaded Functionality between Child Nodes Failure
`Accounts/ChildRedistributionSuccess.*.tmpl`	A parent server node successfully offloaded functionality to a different linked cPanel & WHM child server node.	Contact Manager Transfer Offloaded Functionality between Child Nodes Success
`Accounts/DigestAuthResetNeeded.*.tmpl`	An account’s domain name changes and the system notifies the system administrator that it disabled Digest Authentication. This notification template uses the `DigestAuthResetNeeded.body.html.tmpl` sub-template from the `Accounts/includes` directory.	Contact Manager Forced Disable of Digest Auth
`AdminBin/FullBackup.*.tmpl`	An account experiences a backup failure.	Contact Manager Backup Failure
`appconfig/Notify.*.tmpl`	Application notifications for plugin installations.	Contact Manager AppConfig registration notifications
`Application/base.*.tmpl`	A notification that an existing notification type and template does not monitor.	Contact Manager Uncategorized Notifications
`AutoSSL/CertificateExpiring.*.tmpl`	AutoSSL fails to request a certificate because all of the website’s domains have failed DCV. This notification template uses the following sub-templates from the `AutoSSL/includes` directory: `autossl_problems_table.tmpl` `autossl_queue_table.tmpl`	Contact Manager AutoSSL cannot request a certificate because all of the website’s domains have failed DCV (Domain Control Validation).
`AutoSSL/CertificateExpiringCoverage.*.tmpl`	AutoSSL defers normal certificate renewal because a domain on the current certificate failed DCV. This notification template uses the following sub-templates from the `AutoSSL/includes` directory: `autossl_problems_table.tmpl` `autossl_queue_table.tmpl`	Contact Manager AutoSSL has deferred normal certificate renewal because a domain on the current certificate has failed DCV (Domain Control Validation).
`AutoSSL/CertificateInstalled.*.tmpl`	AutoSSL installs an SSL certificate.	Contact Manager AutoSSL has installed a certificate successfully
`AutoSSL/CertificateInstalledReducedCoverage.*.tmpl`	AutoSSL renews a certificate, but the new certificate lacks at least one domain that the previous certificate secured. This notification template uses the `autossl_problems_table.tmpl` sub-template from the `AutoSSL/includes` directory.	Contact Manager AutoSSL has renewed a certificate, but the new certificate lacks at least one domain that the previous certificate secured.
`AutoSSL/CertificateInstalledUncoveredDomains.*.tmpl`	AutoSSL renewed a certificate, but the new certificate lacks one or more of the website’s domains. This notification template uses the ‘autossl_problems_table.tmpl’ sub-template from the AutoSSL/includes directory.	Contact Manager AutoSSL has renewed a certificate, but the new certificate lacks one or more of the website’s domains.
`AutoSSL/CertificateRenewalCoverage.*.tmpl`	AutoSSL will not secure new domains because a domain on the current certificate failed DCV (Domain Control Validation) and the certificate has not entered the renewal period. This notification template uses the `autossl_problems_table.tmpl` and `autossl_queue_table.tmpl` sub-templates from the `AutoSSL/includes` directory.	Contact Manager AutoSSL will not secure new domains because a domain on the current certificate has failed DCV (Domain Control Validation), and the certificate is not yet in the renewal period.
`AutoSSL/DynamicDNSNewCertificate.*.tmpl`	AutoSSL provisioned a new certificate for a specific dynamic DNS domain.	Contact Manager AutoSSL has provisioned a new certificate for a dynamic DNS domain.
`Backup/Delayed.*.tmpl`	The system delays a backup.	Contact Manager Backup Delayed
`Backup/Disabled.*.tmpl`	The system disables a backup destination for an account.	Contact Manager cPanel Backup Destination Disabled
`Backup/Failure.*.tmpl`	The system fails to finish a backup.	Contact Manager Backup Failed To Finish
`Backup/PartialFailure.*.tmpl`	The system finishes a backup, but it encounters errors.	Contact Manager Backup Successful
`Backup/PreBackupNotice.*.tmpl`	The system will begin a backup soon.	Contact Manager Scheduled Backup Will Start Soon
`Backup/Success.*.tmpl`	The system finishes a backup.	Contact Manager Backup Successful
`Backup/Transport.*.tmpl`	A backup encounters transport errors.	Contact Manager Backup Transport Error
`BandwidthUsageExceeded/Owner.*.tmpl`	Bandwidth overage notifications for resellers of accounts.	Contact Manager Bandwidth Limits
`BandwidthUsageExceeded/User.*.tmpl`	Bandwidth overage notifications for accounts.	Tweak Settings Notifications section.
`ChangePassword/NewUser.*.tmpl`	A password setup notification for new Subaccounts.	Tweak Settings Account Invites for Subaccounts
`ChangePassword/ResetRequest.*.tmpl`	A user clicks the Forgot Password link.	Tweak Settings Reset Password for Subaccounts Reset Password for cPanel accounts
`ChangePassword/User.*.tmpl`	A user changes their password.	Contact Manager cPanel Account Password
`Check/Biglog.*.tmpl`	A log file uses almost 2 GB of disk space.	Contact Manager System Log Approaches 2GB
`Check/CpanelPackages.*.tmpl`	The system finds altered packages that pose a security risk.	Contact Manager Altered Cpanel Packages Check
`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`	Contact Manager Exim Update Failures
`Check/Hack.*.tmpl`	The system detects a possible root compromise.	Contact Manager Root Compromise Checks
`Check/HostnameOwnedByUser.*.tmpl`	A user currently owns the server’s hostname.	Contact Manager Hostname Conflicts with a cPanel User Account
`Check/ImmutableFiles.*.tmpl`	The system cannot update cPanel & WHM due to immutable files. This notification template uses the `ImmutableFiles.action.message.html.tmpl` sub-template from the `Check/includes` directory.	Contact Manager Update Failure Due to Immutable Files
`Check/InvalidDomains.*.tmpl`	The system detects invalid domains.	Contact Manager Invalid Domains
`Check/IP.*.tmpl`	The system cannot resolve the hostname to the correct IP address.	Contact Manager IP Address DNS Check
`Check/LocalConfTemplate.*.tmpl`	The system detected a local custom configuration template for a service during an upgrade (for example, Dovecot).	Contact Manager Local configuration template detected upon upgrade
`Check/MySQL.*.tmpl`	The `check_mysql` script finds corrupted database tables.	Contact Manager Corrupt Database Tables
`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`	Contact Manager Remote MySQL Connection Failure
`Check/Oops.*.tmpl`	The kernel encounters an Oops error.	Contact Manager Kernel Crash Check
`Check/PdnsConf.*.tmpl`	The system upgraded PowerDNS, but it may contain configuration settings which require manual migration and adjustment.	Contact Manager Migrate PowerDNS Configuration Upon Upgrade
`Check/Resolvers.*.tmpl`	The server’s DNS resolvers respond slowly or do not respond at all. This notification template uses the `Resolvers.body.html.tmpl` and `Resolvers.subject.html.tmpl` sub-templates from the `Check/includes` directory.	Contact Manager DNS Resolver Performance Issues
`Check/SecurityAdvisorStateChange.*.tmpl`	The Security Advisor feature detects new issues with high importance. This notification template uses the `SecurityAdvisorStateChange.body.html.tmpl` and `SecurityAdvisorStateChange.subject.html.tmpl` sub-templates from the `Check/includes` directory.	Contact Manager Security Advisor State Change
`Check/Smart.*.tmpl`	Smartcheck detects a possible hard drive failure.	Contact Manager Disk Integrity Check
`Check/SSLCertExpired.*.tmpl`	A domain’s SSL certificate expires.	Contact Manager Service SSL Certificate Expiration
`Check/SSLCertExpiresSoon.*.tmpl`	A domain’s SSL certificate will expire soon.	Contact Manager Service SSL Certificate Expires Soon
`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 `UnmonitoredEnabledServices.body.html.tmpl` and `UnmonitoredEnabledServices.subject.html.tmpl` sub-template from the `Check/includes` directory.	Contact Manager Unmonitored Services
`Check/ValidServerHostname.*.tmpl`	The system detects an invalid hostname for the server’s main IP address.	Contact Manager Invalid Hostname For Main IP Address
`chkservd/DiskUsage.*.tmpl`	Disk usage notifications.	Contact Manager Disk Usage Warnings
`chkservd/Hang.*.tmpl`	The system detects and restarts a hung device.	Contact Manager Hung Service Checks
`chkservd/Notify.*.tmpl`	Service status notifications.	Contact Manager Service failures (ChkServd)
`chkservd/OOM.*.tmpl`	The system terminates a process to avoid a crash due to low memory.	Contact Manager System Out of Memory
`CloudLinux/Update.*.tmpl`	The system detects a CloudLinux™ license and provides installation instructions. This notification template uses the `Update.body.html.tmpl` sub-templates from the `CloudLinux/includes` directory.	Contact Manager CloudLinux License Detected
`Config/CpConfGuard.*.tmpl`	The system restores the `cpanel.config` file from settings in the cache and configuration defaults file.	Contact Manager cPanel Configuration Checks
`ContactInfo/Change.*.tmpl`	Contact information change notifications.	Contact Information
`ConvertAddon/ConversionCompleted.*.tmpl`	Convert addon domain to account notifications.	Transfer Tool Convert Addon Domain to Account Notifications
`cPHulk/BruteForce.*.tmpl`	cPHulk brute force notifications. Note: cPHulk uses GeoLite2 data created by MaxMind.	Contact Manager cPHulkd Brute Force
`cPHulk/Login.*.tmpl`	Login notifications.	Contact Manager cPHulkd Notifications and Root login notifications (cpHulkd)
`dbindex/Warn.*.tmpl`	The `dbindex` cache file is out-of-date by more than four hours.	Contact Manager dbindex Cache File Out Of Date
`DemoMode/MailChildNodeExists.*.tmpl`	A demo account is distributing mail to a child node.	Contact Manager Accounts with demo mode restrictions enabled and mail distributed to a child node.
`DigestAuth/Disable.*.tmpl`	An account’s domain name changes and the system notifies the account owner that they must re-enable Digest Authentication.	Contact Manager Digest Authentication Disabled Due to Account Rename
`DnsAdmin/ClusterError.*.tmpl`	The system encounters an error with the DNS cluster.	Contact Manager DNS Cluster Error
`DnsAdmin/DnssecError.*.tmpl`	DNSSEC keys don’t sync properly. This means servers in a DNS cluster don’t currently serve DNSSEC records for a DNS zone.	Contact Manager DNSSEC key synchronization failure
`DnsAdmin/UnreachablePeer.*.tmpl`	The system could not contact a server in the DNS cluster.	Contact Manager Lost Contact With DNS Cluster
`EasyApache/EA4_ConflictRemove.*.tmpl`	EasyApache 4 attempts to resolve a package conflict.	Contact Manager EasyApache 4 conflict removed
`EasyApache/EA4_LangHandlerMissing.*.tmpl`	EasyApache 4 encounters a missing handler.	Contact Manager EasyApache Configuration
`EasyApache/EA4_TemplateCheckUpdated.*.tmpl`	The system detects an updated EasyApache 4 template.	Contact Manager EasyApache 4 template updated
`Greylist/CommonProviderRemoval.*.tmpl`	The system removes a mail provider from the Greylisting Common Mail Providers list.	Contact Manager Greylist System Changes
`iContact/SendIMFailed.*.tmpl`	The system fails to send a notification via an instant message.	Contact Manager Instant Message Failure
`InitialWebsite/Creation.*.tmpl`	Website setup notifications.	Contact Manager Initial Website Creation
`Install/CheckcPHulkDB.*.tmpl`	cPHulk detects database corruption issues.	Contact Manager cPHulk Database Integrity Notices
`Install/CheckRemoteMySQLVersion.*.tmpl`	The system does not support the version of MySQL® on a remote MySQL server.	Contact Manager Remote MySQL Server Notifications
`Install/ClamavConnector.*.tmpl`	The rpm.versions system upgrades ClamAV.	N/A
`Install/DatabaseDeprecations.*.tmpl`	A notification about MySQL databases that cPanel & WHM deprecated. The system administrator can remove these databases when convenient.	Contact Manager Database Deprecation Notifications
`Install/FixcPHulkConf.*.tmpl`	The system repairs the cPHulk configuration.	Contact Manager cPHulk Configuration Issues
`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.	Contact Manager Package Extension Name Conflicts
`killacct/Notify.*.tmpl`	Account termination notifications.	Contact Manager Account Removal
`killacct/PostTerminateCleanup.*.tmpl`	The system cleans up file permissions after a user termination.	Contact Manager Account Removal
`Logd/Notify.*.tmpl`	The system times out while it processed a domain’s bandwidth data.	Contact Manager Bandwidth Data Processing Timeout
`Logger/Notify.*.tmpl`	The system performs a deprecated call within a script and terminates the script.	Contact Manager Script Terminated Due to Deprecated Call
`Mail/ClientConfig.*.tmpl`	Send the mail client configuration file to a new mail user. This notification template uses the `clientconf_manual_settings_include.html.tt` sub-template from the `Mail/includes` directory.	Contact Manager Email Client Configuration
`Mail/HourlyLimitExceeded.*.tmpl`	A domain exceeds the hourly emails sent threshold in the Max hourly emails per domain option in WHM’s Tweak Settings interface (WHM » Home » Server Configuration » Tweak Settings).	Contact Manager Maximum Hourly Emails Exceeded
`Mail/ReconfigureCalendars.*.tmpl`	The system sends a notification email to all users with Calendar and Contacts Server (CCS) data. The email tells them to reconfigure their calendars and contacts applications for the replacement of CCS by the `cpdavd` service.	Contact Manager Reconfigure CalDAV/CardDAV clients
`Mail/SendLimitExceeded.*.tmpl`	A domain exceeds the daily emails sent threshold in the Number of emails a domain may send per day before the system sends a notification. option in WHM’s Tweak Settings interface (WHM » Home » Server Configuration » Tweak Settings).	Contact Manager Outgoing Email Threshold Exceeded
`Mail/SpammersDetected.*.tmpl`	A mail user exceeds the preconfigured threshold of 500 unique outbound messages (excludes mailing lists). The system either takes no action, holds, or rejects additional messages. You can configure the action that the system performs when a domain exceeds this threshold with the Select the action for the system to take on an email account when it detects a potential spammer setting in the Mail section of WHM’s Tweak Settings interface (WHM » Home » Server Configuration » Tweak Settings).	Contact Manager Large Amount of Outbound Email Detected
`MailServer/OOM.*.tmpl`	The mail server runs out of memory while it processes mail for an account.	Contact Manager Mail Server Out of Memory
`Market/SSLCertActionNeeded.*.tmpl`	An SSL certificate purchased through the cPanel Market needs validation.	Contact Manager Notices concerning goods and services purchased via the cPanel Market
`Market/SSLWebInstall.*.tmpl`	The system attempts to download and install an SSL certificate that a cPanel user ordered through cPanel’s SSL/TLS Wizard interface (cPanel » Home » Security » SSL/TLS Wizard).	Contact Manager Installation of Purchased SSL Certificates
`Market/WHMPluginInstall.*.tmpl`	The system fails to install a WHM plugin that a cPanel user ordered through the cPanel Store.	Contact Manager Notices concerning goods and services purchased via the cPanel Market
`OutdatedSoftware/Notify.*.tmpl`	The system detects outdated software. Note: Notices for cPanel & WHM updates exist in the `upcp` templates.	Contact Manager Notifications of Outdated Software
`OverLoad/CpuWatch.html.tmpl`	A user’s process stalls.	Contact Manager Stalled Process Notifications
`OverLoad/LogRunner.html.tmpl`	A process stalls while it processes a user’s statistics and bandwidth data.	Contact Manager Stalled Statistics and Bandwidth Process Notifications
`parkadmin/Notify.*.tmpl`	A user parks a domain on top of another domain.	Contact Manager Notification of New Addon Domains
`PHPFPM/AccountOverquota.*.tmpl`	An over quota account prevents PHP-FPM from starting on a server that runs in a Virtuozzo environment.	Contact Manager PHP-FPM Account is over quota
`queueprocd/Notify.*.tmpl`	The system must shut down the queueprocd daemon due to repeated exceptions.	N/A
`Quota/Broken.*.tmpl`	The system cannot enable disk quotas automatically. Note: This notification only affects systems that run Ubuntu®.	Contact Manager Filesystem quotas are currently broken.
`Quota/DiskWarning.*.tmpl`	Disk quota warning notifications.	Contact Manager User Disk Usage Warning
`Quota/List.*.tmpl`	Mailbox quota warning notifications for multiple mailboxes.	Contact Manager User Disk Usage Warning
`Quota/MailboxWarning.*.tmpl`	Mailbox quota warning notifications for a single mailbox.	Contact Manager Mailbox Usage Warning
`Quota/RebootRequired.*.tmpl`	The system requires a reboot in order to enable filesystem quotas.	Contact Manager Reboot To Enable Filesystem Quotas Reminder
`Quota/SetupComplete.*.tmpl`	The system successfully finishes the process to enable filesystem quotas. Note: Because the system automatically enables filesystem quotas for all new installations of cPanel & WHM, you will receive this notification during the installation process.	Contact Manager Filesystem Quotas Ready
`RPMVersions/Notify.*.tmpl`	The system converts settings in the `cpupdate.conf` file to settings in the `local.versions` file.	Contact Manager Conversion of cpupdate.conf settings to local.versions
`Security/AuthnMethodLinkedToAccount.*.tmpl`	A user links their cPanel account to an account at an external authentication provider.	Contact Information An external account is linked to my account for authentication
`Solr/Maintenance.*.tmpl`	The `/usr/local/cpanel/3rdparty/scripts/cpanel_dovecot_solr_maintenance` script fails.	Contact Manager Dovecot Solr maintenance task errors
`SSHD/ConfigError.*.tmpl`	The system detects an attempt to change the `sshd_config` file.	Contact Manager SSHD Configuration Error
`SSL/CertificateExpiring.*.tmpl`	An account’s SSL certificate expires soon.	Contact Manager SSL certificates expiring
`SSL/CheckAllCertsWarnings.*.tmpl`	The `usr/local/cpanel/bin/checkallssl` script detected issues with the cPanel & WHM services’ SSL certificates.	Contact Manager cPanel Service SSL certificate warnings
`SSL/LinkedNodeCertificateExpiring.*.tmpl`	The system will send a notice when a linked node’s hostname SSL certificate will soon expire.	Contact Manager Hostname’s SSL certificate expiring on a linked node
`Stats/Lagging.*.tmpl`	The system cannot maintain its log processing schedule because of an overload or unusually high levels of traffic.	Contact Manager Stats and Bandwidth Processing Errors
`StuckScript/Notify.*.tmpl`	The system detects a stuck script.	Contact Manager Stuck Script
`suspendacct/Notify.*.tmpl`	Account suspension notifications.	Contact Manager Account Suspensions
`sysup/Notify.*.tmpl`	The system fails to update.	Contact Manager System Update Failures
`TwoFactorAuth/UserDisable.*.tmpl`	A user disables two-factor authentication.	Contact Manager User Disabled Two-Factor Authentication
`TwoFactorAuth/UserEnable.*.tmpl`	A user enables two-factor authentication.	Contact Manager User Enabled Two-Factor Authentication
`unsuspendacct/Notify.*.tmpl`	Account unsuspension notifications.	Contact Manager Account Unsuspensions
`upacct/Notify.*.tmpl`	Account modification notifications.	Contact Manager Account Upgrades/Downgrades
`upcp/Killed.*.tmpl`	The system aborts or terminates an update of WHM.	Contact Manager System Update Failures
`upcp/MaintenanceFailed.*.tmpl`	The `upcp` script fails to update WHM.	Contact Manager System Update Failures
`upcp/PostSyncCleanupFailed.*.tmpl`	The system fails to finish the process after the `upcp` script updates WHM.	Contact Manager System Update Failures
`upcp/UpdateNowFailed.*.tmpl`	The `updatenow` script fails to update the system.	Contact Manager System Update Failures
`Update/Blocker.*.tmpl`	The system fails to update because of a version blocker.	Contact Manager Update Version Blocker
`Update/EndOfLife.*.tmpl`	The cPanel & WHM version that exists on the server will reach the End Of Life (EOL) tier soon.	Contact Manager cPanel & WHM End of Life Notice
`Update/Now.*.tmpl`	Update failure notifications.	Contact Manager Update Failures
`Update/ServiceDeprecated.*.tmpl`	The cPanel & WHM update fails because of a deprecated service.	Contact Manager Update Blocker - Service Deprecation Notice
`Update/UpgradeRequired.*.tmpl`	cPanel & WHM will automatically upgrade a service.	Contact Manager Upgrade Required - Service Is Outdated
`wwwacct/Notify.*.tmpl`	New account creation notifications.	Contact Manager Account Creation

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.

If you plan to customize any templates, you must copy these two directories to the /var/cpanel/templates/icontact_templates/ custom templates directory.

Available variables

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

CPANEL variables

All of the notification templates can use the following 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.

Warning:

You must store both of the following files in the /var/cpanel/templates/icontact_templates/ directory:

The customized wrapper template.
The notification template that the wrapper customizes.

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 the /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 and locate the following entry:
1 2 3

[%- CPANEL.locale.maketext(‘New account on [_1] ([_2])’, NOTICE.host_server,NOTICE.domain); -%]

Edit the entry from step 4 in the Notify.subject.tmpl file to appear similar to the following example:

1
2
3


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

Run the following command to rebuild the files:
```
/usr/local/cpanel/bin/rebuild-templates
```