H-Sphere Reseller Guide

Editing Mail Messages To Users
(version 2.4 and higher)

 

Related Docs:  

Configuring User Notification Rules

Starting with version 2.4, it became possible to edit e-mail notifications by master admin and resellers directly from H-Sphere control panel.

In previous versions, system emails were stored ONLY in system email templates and could be edited only by master admin. Now system emails are stored in the H-Sphere database and can be modified in the admin CP for each of interface languages provided in H-Sphere.

To customize system emails in CP, do the following:

  1. In the admin interface, choose Custom E-Mails in the Settings menu:

    You will see the list of custom e-mails already added to the system:

  2. To edit a custom email message, click on the name of the message in the list. You will see the page containing two parts:

    1) Preview: message preview as generated from the message template code:

    NOTE: Variable message fields such as user's first and last name or user login are replaced in Preview by the H-Sphere intuitively understandable "pseudo texts": FirstName, LastName, USER.LOGIN, and the like.

    2) Edit Form: contains the subject title and the dynamically generated message body:

    Send the message as: setting the message's content type, the format in which the message would be sent (in plain text or in HTML format).
    Default message for all languages: uncheck this box to apply changes only to the selected language; check it to apply modifications to all languages that use default message settings (won't be applied to the messages already modified with this box unchecked).

    On the bottom of the form there is the language panel with all interface languages available in H-Sphere. Click to choose the language you wish to modify the message for.

  3. Press Save to apply changes.

    If you change the message code correctly, you will get the note that changes have been successfully saved (in the H-Sphere database), and you may see these changes in the Preview Message.

    Otherwise, you will receive an error notification, and changes won't apply:

    IMPORTANT:

    1. System email messages are generated from Freemarker code. To correctly customize the code, you should be familiar with Freemarker commands and with H-Sphere advanced customization and resources.

    2. There is no need to customize lang texts represented in the code as ${lang.text_name} and set in the bundle files in the /hsphere/local/home/cpanel/shiva//psoft/hsphere/lang/ default bundle directory or in custom bundles directory. Instead, you could set the text directly for each interface language here in the given form. For this, please make sure you uncheck the The default message for all languages box when editing the message for each language.

    3. Changes applied to the system emails through the given form are stored in the system database and do not affect the .txt system email notification templates that are located in the /hsphere/local/home/cpanel/shiva/shiva-templates/common/mail. Moreover, you can restore the hardcoded system notification from the template by pressing the Restore From Template button at the bottom of the form.

    We don't recommend customizing the default templates!

 


Related Docs:  

Configuring User Notification Rules



© Copyright 1998-2004. Positive Software Corporation.
All rights reserved.