Table of Contents

Description

This email template is sent to all active staff members that have subscribed to receive Suspension Errors (under [My Info] -> [Notices]), which are sent when attempting to suspend a service results in error.

Supported Tags

The tags described in Blesta are only a list of commonly-used tags, for brevity.

Because the {errors} tag is an array of arrays (i.e. possibly multiple errors), you should configure the template to loop through each error individually by using the for notation described under Customizing Emails.

The tags below are all of those available for this email template. For other email and tag customizations, see Customizing Emails.

TagDescriptionNotes
{staff.first_name}The staff's first name
{staff.last_name}The staff's last name
{staff.email}The staff's email address
{client.id_code}The client's IDe.g. 1500
{client.first_name}The client's first name
{client.last_name}The client's last name
{client.email}The client's email address
{package.name}The name of the package that the service belongs to
{service.name}The name of the service (as given by the module)

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
stdClass Object
(
    [id] => 1
    [client_id] => 1
    [user_id] => 
    [contact_type] => primary
    [contact_type_id] => 
    [first_name] => First
    [last_name] => Last
    [title] => 
    [company] => 
    [email] => first.last@domain.com
    [address1] => 1 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
stdClass Object
(
    [id] => 1
    [id_format] => {num}
    [id_value] => 1
    [module_id] => 3
    [name] => My Package
    [description] => 
    [description_html] => 
    [qty] => 
    [module_row] => 1
    [module_group] => 
    [taxable] => 0
    [single_term] => 0
    [status] => active
    [company_id] => 1
    [prorata_day] => 1
    [prorata_cutoff] => 
    [id_code] => 1
    [email_content] => Array
        (
            [0] => stdClass Object
                (
                    [lang] => en_us
                    [html] =>
                    [text] => 
                )

        )

    [pricing] => Array
        (
            [0] => stdClass Object
                (
                    [id] => 2
                    [pricing_id] => 2
                    [package_id] => 1
                    [term] => 1
                    [period] => day
                    [price] => 1.0000
                    [setup_fee] => 0.0000
                    [cancel_fee] => 0.0000
                    [currency] => USD
                )

            [1] => stdClass Object
                (
                    [id] => 3
                    [pricing_id] => 3
                    [package_id] => 1
                    [term] => 1
                    [period] => week
                    [price] => 7.0000
                    [setup_fee] => 0.0000
                    [cancel_fee] => 0.0000
                    [currency] => USD
                )

           [2] => stdClass Object
               (
                   [id] => 1
                   [pricing_id] => 1
                   [package_id] => 1
                   [term] => 1
                   [period] => month
                   [price] => 15.0000
                   [setup_fee] => 0.5000
                   [cancel_fee] => 0.0000
                   [currency] => USD
              )

        )

        [meta] => stdClass Object
            (
            )

        [groups] => Array
            (
                [0] => stdClass Object
                    (
                        [id] => 1
                        [name] => My Package Group
                        [description] => 
                        [type] => standard
                        [company_id] => 1
                    )

                [1] => stdClass Object
                    (
                        [id] => 2
                        [name] => Addon Group
                        [description] => 
                        [type] => addon
                        [company_id] => 1
                    )

            )

        [option_groups] => Array
            (
                [0] => stdClass Object
                    (
                        [id] => 1
                        [name] => Package Option Group
                        [description] => 1
                    )

            )

)
The {service} object
stdClass Object
    [id] => 35
    [parent_service_id] =>
    [package_group_id] => 1
    [id_format] => {num}
    [id_value] => 35
    [pricing_id] => 2
    [client_id] => 1
    [module_row_id] => 1
    [coupon_id] =>
    [qty] => 1
    [override_price] =>
    [override_currency] =>
    [status] => suspended
    [date_added] => 2014-08-27 18:52:50
    [date_renews] => 2014-10-27 18:52:50
    [date_last_renewed] =>
    [date_suspended] => 2014-10-20 00:00:00
    [date_canceled] =>
    [id_code] => 35
    [client_id_code] => 1500
    [term] => 1
    [period] => month
    [name] => My Service Field
    [client_first_name] => First
    [client_last_name] => Last
    [client_company] =>
    [client_address1] => 1 Main St.
    [client_email] => first.last@domain.com
    [package_prorata_day] =>
    [fields] => Array
    (
        [0] => stdClass Object 
            [key] => cpanel_confirm_password
            [value] => !fy$n(nz3#szh
            [serialized] => 0
            [encrypted] => 1
        [1] => stdClass Object
            [key] => cpanel_domain
            [value] => testdomain.com 
            [serialized] => 0 
            [encrypted] => 0 
        [2] => stdClass Object
            [key] => cpanel_password 
            [value] => !fy$n(nz3#szh 
            [serialized] => 0 
            [encrypted] => 1 
        [3] => stdClass Object 
            [key] => cpanel_username 
            [value] => testusername 
            [serialized] => 0 
            [encrypted] => 0 
    )
    [options] => Array
    (
    )
The {client} object
stdClass Object
(
    [id] => 1
    [id_format] => {num}
    [id_value] => 1500
    [user_id] => 2
    [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] => 
    [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-06-25 18:05:34
    [settings] => Array
        (
            ...
            [language] => en_us
            ...
        )
}
The {staff} object
stdClass Object
(
    [id] => 1
    [user_id] => 1
    [first_name] => Staff
    [last_name] => Member
    [email] => s.member@domain.com
    [email_mobile] => 
    [status] => active
)
The {errors} array
 Array
(
    [service_notice_suspend] => Array
        (
            [failed] => The module failed communicating with the remote server when attempting to suspend the service.
        )
)
  • No labels