Kavi® Members Help

Chapter 97. Add Template

Overview

Customize the email and form templates used by Kavi Members to convey your organization's message to use with the Send Template-based Email and Schedule Renewal Reminders tools. Use variables to include information from the database in email sent to users and company representatives. Only custom templates can be added.

Use the Add Template page to:

Add email templates used by Kavi Members to convey your organization's message.

Back to top

How to Add a Template

You can add new custom templates for use with the Send Template-Based email tools and in the schedule of renewal reminders.

Choose Target

Select whether the template should be addressed to users or company representatives. The variables available will depend upon this.

Add Template

The following fields are displayed:

Template Name

This should be a unique and descriptive name. For example, 'Password Requested Email' or 'Company Membership Denied Email'.

Category

This describes the type of the template, whether required or custom or page text and whether company or user related.

When used

The related action upon which the template can be sent. For example, 'Sent when a user requests a password change' or 'Sent when a company's membership is denied in moderation'.

Subject

The subject of an email notice will be the subject of the email notice sent out if scheduled. It will be the first thing a user will read. The subject should be clear, direct, and as specific as possible to inform the user about why they should read this message.

Text

Type the body of your message in the text box. Use the available variables and your own text. Text can be formatted using spaces and line breaks for email templates, but HTML formatting is not allowed to ensure the security of mail sent to members from Kavi Members.

Available Template Variables for Users

A list of the variables that are available to be included in the template text. Variables are used to represent information stored in the database. The variables available by default for email sent to a user are shown in the table below. The variables shown here may differ from those available on your site depending on how Kavi Members is configured and whether custom fields have been added for users.

$custom_fieldname: Any custom fields will be listed by their database name. This will be identical to the column heading used for that field in the User Data Report.

Table 97.1. Template Variables for Users

Variable Example
$address 123 SW Main Street Portland, OR 97215 USA
$admin_email admin@example.org
$cell_phone 503-555-1212
$change_password_link http://www.example.com/kbl?k=123456 or http://www.example.com/kmembers/person/change_password The shorter link is sent when the user has requested a new password. The longer link is sent when a user already has a password. It takes the user to the change password page where they can change their username and password.
$city Portland
$company_name Example Corporation
$contact_types Primary Contact
$country USA
$deactivation_date Oct 7, 2004
$display_publicly Yes
$edit_person_link http://www.example.org/kmembers/person/change_personal_info/
$fax_phone 503-555-1213
$first_name Jane
$home_phone 503-555-1214
$last_modified Dec 3, 2004
$last_name Doe
$membership_status_link http://www.example.org/kmembership_info/membership_status?participant_key=12345678
$middle_name Lee
$modification_time Dec 13, 2004 3:06 pm US/Pacific
$org_name Example Trade Association
$postal_code 97214
$primary_email janedoe@example.org
$purpose company_rep
$receive_email Yes
$renewal_link http://www.example.org/kmembership_info/renew_membership?k=12345678
$salutation Ms.
$secondary_email Jane@example.org
$signup_date 21 Nov 2003
$state_province OR
$status Active
$street SW Main Street
$title Director of Communications
$user_fullname Ms. Jane Doe
$username janedoe
$work_phone 503-555-1215
Available Template Variables for Companies

Variables are used to represent information stored in the database. The variables available by default for email sent to a company representative are shown in the table below. The variables shown here may differ from those available on your site depending on how Kavi Members is configured and whether custom fields have been added for companies.

$custom_fieldname: Any custom fields will be listed by their database name. This will be identical to the column heading used for that field in the User Data Report.

Table 97.2. Template Variables for Companies

Variable Example
$accepted_domains kavi.com
$address 123 SW Main Street Portland, OR 97215 USA
$admin_email admin@example.org
$allow_membership 1
$city Portland
$company_name Example Corporation
$company_type Board,Member
$country USA
$deactivation_date Oct 7, 2004
$display_publicly Yes
$edit_company_link http://www.example.org/kmembers/company/company_edit
$expiration_date March 16, 2006
$last_modified 23 Aug 2004 16:24:35 GMT-7
$membership_status_link http://www.example.org/kmembership_info/membership_status?participant_key=12345678
$modification_time Dec 13, 2004 3:06 pm US/Pacific
$name Example Corporation
$org_name Example Organization
$postal_code 97214
$purpose member
$show_on_signup_form 1
$signup_date 21 Nov 2003
$state_province OR
$status Active
$street SW Main Street
$url http://www.examplecorp.com

Preview

Preview the message. All variables will be replaced with information from your personal account to make it easier to see what messages will look like when they are sent. If you are satisfied with this message and are ready to save this template, click 'Save Template'. If you want to make more changes, click 'Back'. The new template text will be used the next time email is sent using this template.

Back to top