- Created by Tyson Phillips, last modified by Jonathan Reissmueller on Jun 13, 2019
| Table of Contents |
|---|
Description
This email template is sent to a client's email address to notify them of a service having been created under their account.
Supported Tags
The tags described in Blesta are only a list of commonly-used tags, for brevity.
Package Welcome Email
When a package is created, a Welcome Email section is available where content specific to the module and package can be defined. The content set for the Welcome Email can be embedded into the Service Creation email template by using the tag {package.email_html} for the HTML version of the Welcome Email, and {package.email_text} for the Text version of the Welcome Email.
The tags below are all of those available for this email template. For other email and tag customizations, see Customizing Emails.
| Tag | Description | Notes |
|---|---|---|
| {contact.first_name} | The client's first name | |
| {contact.last_name} | The client's last name | |
| {contact.email} | The client's email address | |
| {package.name} | The name set for the package that the service is created from | |
| {package.email_html} | The HTML version of the package Welcome Email | |
| {package.email_text} | The Text version of the package Welcome Email | |
| {client.id_code} | The client's ID | e.g. 1500 |
Additional Tags
Due to the nature of tag objects containing several fields, many of which are likely irrelevant for use in email templates, but may be useful to you in certain circumstances, an example dump of the tag objects are shown below.
The {contact} object Expand source
stdClass Object
(
[id] => 1
[client_id] => 1
[user_id] => 1
[contact_type] => primary
[contact_type_id] =>
[first_name] => First
[last_name] => Last
[title] =>
[company] => Company Co.
[email] => first.last@domain.com
[address1] => 123 Main St.
[address2] =>
[city] => City
[state] => CA
[zip] => 90001
[country] => US
[date_added] => 2014-06-25 18:05:34
[contact_type_name] =>
[contact_type_is_lang] =>
)
The package object contains module-specific fields that will not be the same between packages. The following example uses the Multicraft module.
The {package} object Expand source
stdClass Object
(
[id] => 2
[id_format] => {num}
[id_value] => 2
[module_id] => 6
[name] => Multicraft
[description] =>
[description_html] =>
[qty] => 1
[module_row] => 4
[module_group] =>
[taxable] => 0
[single_term] => 0
[status] => active
[company_id] => 1
[id_code] => 2
[email_content] => Array
(
[0] => stdClass Object
(
[lang] => en_us
[html] => <p>{module.panel_api_url}</p>
[text] => {module.panel_api_url}
)
)
[pricing] => Array
(
[0] => stdClass Object
(
[id] => 2
[pricing_id] => 2
[package_id] => 2
[term] => 1
[period] => month
[price] => 3.0000
[setup_fee] => 0.0000
[cancel_fee] => 0.0000
[currency] => USD
)
)
[meta] => stdClass Object
(
[autostart] => 0
[create_ftp] => 0
[default_level] => 10
[jardir] => daemon
[jarfile] =>
[memory] => 512
[players] => 1
[server_name] => Minecraft Server
[server_visibility] => 1
[user_ftp] => 0
[user_jar] => 0
[user_name] => 0
[user_schedule] => 0
[user_visibility] => 0
)
[groups] => Array
(
[0] => stdClass Object
(
[id] => 3
[name] => Multicraft
[type] => standard
)
)
[option_groups] => Array
(
)
[autostart] => 0
[create_ftp] => 0
[default_level] => 10
[jardir] => daemon
[jarfile] =>
[memory] => 512
[players] => 1
[server_name] => Minecraft Server
[server_visibility] => 1
[user_ftp] => 0
[user_jar] => 0
[user_name] => 0
[user_schedule] => 0
[user_visibility] => 0
)
The {pricing} object Expand source
stdClass Object
(
[id] => 2
[package_id] => 2
[pricing_id] => 2
[term] => 1
[period] => Month
[price] => 3.0000
[setup_fee] => 0.0000
[cancel_fee] => 0.0000
[currency] => USD
)
The module object contains fields specific to the module that the service is created for. See the specific Module for a list of tags that may be available here. The following is an example using the Multicraft module.
The {module} object Expand source
stdClass Object
(
[ips_in_use] => Array
(
[0] => 0
)
[panel_api_url] => http://domain.com/multicraft/api.php
[panel_url] => http://domain.com/multicraft/
)
The service object contains service fields specific to the module that the service is created for. See the specific Module for a list of tags that may be available here. The following is an example using the Multicraft module.
The {service} object Expand source
stdClass Object
(
[id] => 5
[parent_service_id] =>
[package_group_id] => 3
[id_format] => {num}
[id_value] => 5
[pricing_id] => 2
[client_id] => 1
[module_row_id] => 4
[coupon_id] =>
[qty] => 1
[status] => active
[date_added] => 2014-06-25 21:30:23
[date_renews] => 2014-07-25 21:30:23
[date_last_renewed] =>
[date_suspended] =>
[date_canceled] =>
[id_code] => 5
[fields] => Array
(
[0] => stdClass Object
(
[key] => multicraft_autostart
[value] => 0
[serialized] => 0
[encrypted] => 0
)
[1] => stdClass Object
(
[key] => multicraft_create_ftp
[value] => 0
[serialized] => 0
[encrypted] => 0
)
[2] => stdClass Object
(
[key] => multicraft_daemon_id
[value] => 1
[serialized] => 0
[encrypted] => 0
)
[3] => stdClass Object
(
[key] => multicraft_default_level
[value] => 10
[serialized] => 0
[encrypted] => 0
)
[4] => stdClass Object
(
[key] => multicraft_ip
[value] => 127.0.0.1
[serialized] => 0
[encrypted] => 0
)
[5] => stdClass Object
(
[key] => multicraft_jardir
[value] => daemon
[serialized] => 0
[encrypted] => 0
)
[6] => stdClass Object
(
[key] => multicraft_jarfile
[value] =>
[serialized] => 0
[encrypted] => 0
)
[7] => stdClass Object
(
[key] => multicraft_login_password
[value] =>
[serialized] => 0
[encrypted] => 1
)
[8] => stdClass Object
(
[key] => multicraft_login_username
[value] =>
[serialized] => 0
[encrypted] => 0
)
[9] => stdClass Object
(
[key] => multicraft_memory
[value] => 512
[serialized] => 0
[encrypted] => 0
)
[10] => stdClass Object
(
[key] => multicraft_players
[value] => 1
[serialized] => 0
[encrypted] => 0
)
[11] => stdClass Object
(
[key] => multicraft_port
[value] => 25579
[serialized] => 0
[encrypted] => 0
)
[12] => stdClass Object
(
[key] => multicraft_server_id
[value] => 66
[serialized] => 0
[encrypted] => 0
)
[13] => stdClass Object
(
[key] => multicraft_server_name
[value] => Minecraft Server
[serialized] => 0
[encrypted] => 0
)
[14] => stdClass Object
(
[key] => multicraft_server_visibility
[value] => 1
[serialized] => 0
[encrypted] => 0
)
[15] => stdClass Object
(
[key] => multicraft_socket
[value] => 127.0.0.1:25579
[serialized] => 0
[encrypted] => 0
)
[16] => stdClass Object
(
[key] => multicraft_user_ftp
[value] => 0
[serialized] => 0
[encrypted] => 0
)
[17] => stdClass Object
(
[key] => multicraft_user_id
[value] => 13
[serialized] => 0
[encrypted] => 0
)
[18] => stdClass Object
(
[key] => multicraft_user_jar
[value] => 0
[serialized] => 0
[encrypted] => 0
)
[19] => stdClass Object
(
[key] => multicraft_user_name
[value] => 0
[serialized] => 0
[encrypted] => 0
)
[20] => stdClass Object
(
[key] => multicraft_user_schedule
[value] => 0
[serialized] => 0
[encrypted] => 0
)
[21] => stdClass Object
(
[key] => multicraft_user_visibility
[value] => 0
[serialized] => 0
[encrypted] => 0
)
)
[package_pricing] => stdClass Object
(
[id] => 2
[package_id] => 2
[pricing_id] => 2
[term] => 1
[period] => Month
[price] => 3.0000
[setup_fee] => 0.0000
[cancel_fee] => 0.0000
[currency] => USD
)
[package] => stdClass Object
(
[id] => 2
[id_format] => {num}
[id_value] => 2
[module_id] => 6
[name] => Multicraft
[description] =>
[description_html] =>
[qty] =>
[module_row] => 4
[module_group] =>
[taxable] => 0
[single_term] => 0
[status] => active
[company_id] => 1
)
[options] => Array
(
)
[name] => 127.0.0.1:25579
[multicraft_autostart] => 0
[multicraft_create_ftp] => 0
[multicraft_daemon_id] => 1
[multicraft_default_level] => 10
[multicraft_ip] => 127.0.0.1
[multicraft_jardir] => daemon
[multicraft_jarfile] =>
[multicraft_login_password] =>
[multicraft_login_username] =>
[multicraft_memory] => 512
[multicraft_players] => 1
[multicraft_port] => 25579
[multicraft_server_id] => 66
[multicraft_server_name] => Minecraft Server
[multicraft_server_visibility] => 1
[multicraft_socket] => 127.0.0.1:25579
[multicraft_user_ftp] => 0
[multicraft_user_id] => 13
[multicraft_user_jar] => 0
[multicraft_user_name] => 0
[multicraft_user_schedule] => 0
[multicraft_user_visibility] => 0
)
The {clients} object Expand source
stdClass Object
(
[id] => 1
[id_format] => {num}
[id_value] => 1500
[user_id] => 1
[client_group_id] => 1
[primary_account_id] =>
[primary_account_type] =>
[status] => active
[id_code] => 1500
[contact_id] => 1
[first_name] => First
[last_name] => Last
[company] => Company Co.
[email] => first.last@domain.com
[address1] => 1 Main St.
[address2] =>
[city] => City
[state] => CA
[zip] => 90001
[country] => US
[group_name] => General
[company_id] => 1
[username] => first.last@domain.com
[two_factor_mode] => none
[two_factor_key] =>
[two_factor_pin] =>
[date_added] => 2014-05-13 17:12:20
[settings] => Array
(
...
[language] => en_us
...
)
)
- No labels