Provider administrators can test email messages and manage email templates, if an email SMTP server is set up, and when emails are enabled via the Global Settings (Email tab). See: SMTP Server and Global Settings.

Component	Description
Quick Add Subscriber (QAS)	Enable email functionality via Global Settings > Email tab, then select a checkbox in QAS to send a welcome email to new subscribers added via QAS.
File Transfer Destinations	Configured by high level system administrators to transfer audit data for licensing. See the Licensing and Subscriber Data Export Guide.

Via (default menus) Customizations > Email > Send Test Email, you can allow an email message to be sent to and from a specified email address, and select an email HTML template to test in the email body.

You can view and work with email templates via (default menus) Customizations > Email > Email HTML Templates.

Email HTML templates contain placeholders for the email subject and body text, in HTML markup. The HTML markup can be modified as required (for example, by using an external WYSIWYG HTML editor).

Default Email Templates

By default, the system provides the following email templates:

Note

When adding a HTML template from the list view, the Name can only be "Test Email Template", "Quick Add Subscriber", or "Number Inventory Alerting".

Default email templates	Description
Test Email Template	This default template is read-only. You can't modify it or change its name. To use this template, you can clone it to your hierarchy and customize the clone.
Quick Add Subscriber	This default template is read-only. You can't modify it or change its name. To use this template, you can clone it to your hierarchy and customize the clone. You can use this template only if the setting is enabled via the Global Settings. Values from the Quick Add Subscriber input form can be used to populate the template by adding variables to the HTML template.
Number Inventory Alerting	This default template is read-only. You can't modify it or change its name. To use this template, you can clone it to your hierarchy and customize the clone. You can use this template only if the setting is enabled via the Global Settings. Values from Number Inventory Alert message can be used to populate the template by adding variables to the HTML template.

Quick Add Subscriber Email Template Variables

Values from the Quick Add Subscriber input form can be used to populate the Quick Add Subscriber email template by adding variables to the HTML template.

The table describes the variables available for the Quick Add Subscriber email template:

Field name on input form	Variable available in HTML
Username:	`{{ pwf.EMAIL.username }}`
First name:	`{{ pwf.EMAIL.firstname }}`
Last name:	`{{ pwf.EMAIL.lastname }}`
One time password:	`{{ pwf.EMAIL.password }}`
One time PIN:	`{{ pwf.EMAIL.pin }}`
Access Code:	`{{ pwf.EMAIL.phone_access_code }}`
Email:	`{{ pwf.EMAIL.email }}`
Extension:	`{{ pwf.EMAIL.extension_number }}`
Mobile Number:	`{{ pwf.EMAIL.mobile_number }}`
Entitlement Profile:	`{{ pwf.EMAIL.entitlement_profile }}`
Phone Type:	`{{ pwf.EMAIL.phone_type }}`
Phone Names:	`{{ pwf.EMAIL.phone_names }}`
Jabber Device Names:	`{{ pwf.EMAIL.jabber_names }}`
Extension Mobility Name:	`{{ pwf.EMAIL.extensionmobility_name }}`

Example user details you can add to your QAS HTML template:

<p>Username: {{ pwf.EMAIL.username }}</p>
<p>First name: {{ pwf.EMAIL.firstname }}</p>
<p>Last name: {{ pwf.EMAIL.lastname }}</p>

Number Inventory Alerting Email Template Variables

Values from the Number Inventory Alert message can be used to populate the Number Inventory Alerting email template by adding variables to the HTML template. The table describes the variables available for this template:

Name on alert message	Variable available in HTML
Threshold of available (%)	`{{ pwf.INI_ALERT_THRESHOLD }}`
Threshold reached (True/False)	`{{ pwf.INI_ALERT_THRESHOLD_REACHED }}`
Hierarchy node type	`{{ pwf.INI_ALERT_HIERARCHY_NODE_TYPE }}`
Hierarchy friendly name	`{{ pwf.INI_ALERT_HIERARCHY_NAME }}`
Hierarchy full path	`{{ pwf.INI_ALERT_HIERARCHY }}`
Total Numbers Available	`{{ pwf.INI_ALERT_TOTAL_INI_AVAILABLE }}`
Total Number count	`{{ pwf.INI_ALERT_TOTAL_INI_COUNT }}`
Total percent available	`{{ pwf.INI_ALERT_TOTAL_PERCENT_AVAILABLE }}`
Table of usage per site	`{{ pwf.INI_ALERT_NODES_EXCEEDED_THRESHOLD_TABLE }}`

Example HTML

<h1>Number Inventory Threshold Report</h1>
<table border='1' style='border-collapse:collapse'>
<tr><td><b>Hierarchy node name</b></td><td><center>{{ pwf.INI_ALERT_HIERARCHY_NAME }}</center></td></tr>
<tr><td><b>Hierarchy node type</b></td><td><center>{{ pwf.INI_ALERT_HIERARCHY_NODE_TYPE }}</center></td></tr>
<tr><td><b>Hierarchy full path</b></td><td><center>{{ pwf.INI_ALERT_HIERARCHY }}</center></td></tr>
<tr><td><b>Total numbers available</b></td><td><center>{{ pwf.INI_ALERT_TOTAL_INI_AVAILABLE }}</center></td></tr>
<tr><td><b>Total numbers</b></td><td><center>{{ pwf.INI_ALERT_TOTAL_INI_COUNT }}</center></td></tr>
<tr><td><b>Total percent available</b></td><td><center>{{ pwf.INI_ALERT_TOTAL_PERCENT_AVAILABLE }}%</center></td></tr>
</table>
<p>{{ pwf.INI_ALERT_NODES_EXCEEDED_THRESHOLD_TABLE }}</p>

Example message

The email alert message also includes an attachment file called NumberThreshold.csv that contains the alert report in CSV format, for example:

Hierarchy Node Name,Hierarchy Node Type,% Available,Total Numbers Available,Total Numbers
CS-P,Provider,92,1830,1982
CS-NB,Reseller,92,1830,1982
AAAGlobal,Customer,91,1428,1557
Overton,Customer,8,2,25
LOC001,Site,74,284,382
LOC002,Site,83,20,24
LOC003,Site,90,46,51

Email Groups

The Email Groups input form is used to manage a group of email recipients.

Add a Name and Description to make this group and add a list of Email Addresses. This group can then be available for selection where Email Groups are selected.

See for example Global Settings, for:

Webex App email to specify recipients of generated CSV files.
Number Inventory Alerting - email group to receive alerts.

Title	Description	Details
To Email address	To Email address.	Field Name: to Type: String Pattern: ^([^.@]+)(\.[^.@]+)@([^.@]+\.)+([^.@]+)$ Format:* email
From Email address	From Email address.	Field Name: from Type: String Pattern: ^([^.@]+)(\.[^.@]+)@([^.@]+\.)+([^.@]+)$ Format:* email
Email Template	Email template to use.	Field Name: email_html_template Type: String

Model: view/EmailTest

Email Group

Default Email Templates

Quick Add Subscriber Email Template Variables

Number Inventory Alerting Email Template Variables

Model Details: view/EmailTest