|
This document introduces you to system e-mail notifications
sent to the customers and explains how to customize them.
System e-mail notifications are built up using
system notification templates, text
documents that contain instructions for including dynamically-generated
data. In other words, context data is put into the templates
to create complete e-mail messages. All e-mail templates are
located in shiva/shiva-templates/common/mail of the
'cpanel' user's home directory and can be customized
according to your requirements.
System Notification Templates
Template
(in shiva/shiva-templates/common/mail/) |
Sent |
| /new_account.txt |
on account activation |
| /new_account_moderated.txt |
on moderated check account registration |
| /new_account_moderated_cc.txt |
on moderated credit card registration |
| /trial_account.txt |
on account trial period expiration |
| /welcome.txt |
optionally from mass mail |
| /login_psw.txt |
optionally from mass mail |
| /invoice.txt |
- on each paid operation
- at the beginning of the next billing period
- on switching to another billing period
|
| /balance.txt |
optionally from mass mail |
| /overlimit.txt |
on reaching the set percentage of resource
quota/limit usage |
| /suspended_account.txt |
on account suspension |
| /resumed_account.txt |
on account activation |
| /tranfer_domain.txt |
on successful domain transfer |
| /forgot_passwd.txt |
on user's account password request from
the login page |
Note: To add paragraphs on support and checks info,
go to Look and Feel -> Misc.Text and fill in the
Customer Support Info and Checks Info forms.
Customization of System
Notification Templates
Important: Before you do any customization, log in as cpanel superuser under root:
# su - cpanel
To implement customization correctly, all template files and directories should have cpanel:cpanel ownership.
WARNING: DO NOT MAKE ANY CHANGES TO THE DEFAULT TEMPLATES,
because
1) You may need them to restore the original setup;
2) You will lose all your changes with the next upgrade.
Instead, it is recommended to stick to the following steps:
Step 1. In your document root, create the directory
shiva/custom/templates/. It may already be there.
Step 2. Copy the templates you would like to override
(e.g. shiva/shiva-templates/common/mail/mail_template.txt
into shiva/custom/templates/common/mail/mail_template.txt).
The original configuration can be restored without server
restart, simply by deleting your custom e-mail templates from
the shiva/custom/templates directory.
Important: Don't copy the whole directory! Your custom
templates will override all default templates and you will
not see the new features and bugfixes that come with new versions.
Step 3. Modify the templates that you have copied
to the shiva/custom/templates/ directory. It is important
to keep FreeMarker expressions (such as ${...}) intact
while editing texts in the templates.
Step 4. Now that you have edited the templates, get them used instead
of the defaults. In the file shiva/psoft_config/hsphere.properties
find the USER_TEMPLATE_PATH line. Here, enter the full name of the directory
with your custom templates, e.g. /hsphere/local/home/shiva/custom/templates/.
*You might have /hsphere/local/home/cpanel/shiva/custom-templates/" already
written in
USER_TEMPLATE_PATH line, in this case we advise you to change it to "/hsphere/local/home/shiva/custom/templates/
Important: The directory name must end with a slash!
Step 5. Log in as root and
restart H-Sphere.
You don't need to restart H-Sphere if you did nothing on step 4.
|
