|
Last modified: 04 Jan 2008
WARNING: This documentation covers Parallels H-Sphere versions up to 3.1. For the latest up-to-date Parallels H-Sphere documentation, please proceed to the
official Parallels site.
H-Sphere e-mail notifications can be customized directly in CP admin interfacer as
in the Settings->E-Mail Notifications menu.
The list of e-mail notifications is set in
the ~cpanel/shiva/psoft/hsphere/user_emails.xml XML configuration file.
It is customizable by means of H-Sphere packages.
Example |
DTD Scheme
user_emails.xml has the following structure:
- groups - container for description of the groups of e-mail notifications.
(In Settings->E-Mail Notifications,
notifications are displayed in groups, according to their purpose.)
- group - tag for the group description. Attributes:
- id - group identifier.
- name - group name, corresponds to the label in
language bundles (~cpanel/languages/hsphere_lang.properties).
- emails - container for description of e-mail notifications.
- email - tag with notification description. Attributes:
- tag - notification tag. Corresponds to the notification's
ce.TAG_NAME.title (name of the notification in the list in CP), and
ce.TAG_NAME.desc (short description in the list)
labels in hsphere_lang.properties,
where TAG_NAME is the value set in the tag attribute of the notification
in user_emails.xml
- group_id - corresponds to the id attribute of the group to which
this e-mail notification belongs to.
- template - pathname to the corresponding
system e-mail notification template,
relative to the ~cpanel/shiva/shiva-templates/common directory of default H-Sphere templates.
For example, template="mail/custom_registrar_registration.txt" points to the
~cpanel/shiva/shiva-templates/common/mail/new_account.txt template
for the "welcome" message on creating a new account.
- massmail_applicable - if set to 1, this notification is available for
mass mail delivery.
- admin_only - if admin_only="true", this notification is available only
from the admin CP.
- no_cc - if no_cc="true", no copies (the BCC: field) of this e-mail notification
are sent to the addresses defined in the CP admin's
Settings->Notification Recipients menu. That corresponds to unchecking the Sent CC checkbox while editing the notification in CP.
- subject - tag with the subject of the e-mail message to be sent to customers.
|
