Email Templates

Email Templates
	Chapter 4. Various BillMax files

Name

Email Templates — Definition of Email Templates

DESCRIPTION

BillMax contains with a number of e-mail templates. These templates are used when BillMax sends e-mails to Account holders and Service users.

The e-mail templates are located in /usr/local/billmax/local. For each e-mail template a copy of the e-mail template is in a file that has the extension ".email-dist". This file is the original delivered with BillMax and should not be modified. An identical copy of the template is in the file that has the extension ".email". This file is available for modification.

Example 4.5. /usr/local/billmax/local/ccdecline.email

 To: @@TO@@ (1)
 From: @@FROM@@
 Subject: @@SUBJECT@@

 According to our records, your credit card (ending in @@LAST4@@) will
 expire in @@DAYS@@ days. In order to prevent an interruption
 in service, please send the new card number and/or expiration
 date. You can either reply to this email or call our office
 at @@config.phone@@. (2)

 Thank you for your business!

 Billing Department
 @@config.company@@
 @@FROM@@

(1)

BillMax will substitute a value for a string that is surrounded by "@@" characters. The substitutions recognized by BillMax and the values used for the substitutions depend on the e-mail template being processed.

(2)

An example of using a value from the config table for the substitution. In addition to predefined values, values from the config table may be substituted. Here, the value from config.phone (i.e. the phone field of the config table) is substituted for "@@config.phone@@". The string to designate substitution is composed of "@@config.fieldname@@" where "fieldname" is the name of a field in the config table. See Configuring a Virtual Company on how to specify the values. See the config table for a list of field names. The row of data from the config table that is used is the row for the Virtual Company to which the Account belongs.

The following substitution strings (not including those from the config table) are recognized by BillMax for the following e-mail templates. The second column indicates the value (e.g. table.field) for the substituted string.

`/usr/local/billmax/local/ccdecline.email`

Used by ccparse for sending "declined electronic funds transaction" e-mails to Account holders.

@@TO@@: "account.email"
@@FROM@@: "config.bcemail"
@@SUBJECT@@: "account account.number"
@@LAST4@@: The last four characters of account.ccnum if account.ccnum has more than four characters. Otherwise the string "unknown".
@@AMOUNT@@: The amount of the transaction.
@@REASON@@: "DECLINED"

`/usr/local/billmax/local/ccexpire.email`

Used by closeofday to notify Account holders that the expiration date of a credit card on record is approaching.

@@TO@@: "account.email"
@@FROM@@: "config.bcemail"
@@SUBJECT@@: "account account.number"
@@CCEXPWARN@@: "config.ccexpwarn"
@@LAST4@@: The last four characters of account.ccnum if account.ccnum has more than four characters. Otherwise the string "unknown".

`/usr/local/billmax/local/gracewarn.email`

Used by closeofday to notify Account holders of expiring Grace Dates.

@@TO@@: "account.email"
@@FROM@@: "config.bcemail"
@@SUBJECT@@: "account account.number"
@@DAYS@@: "config.gracewarn"
@@GRACEDATE@@: "account.gracedate"

`/usr/local/billmax/local/licexpire.email`

Used internally by BillMax. Please do not edit.

`/usr/local/billmax/local/overdue.email`

Used by closeofday to notify Account holders of amounts overdue.

@@TO@@: "account.email"
@@FROM@@: "config.bcemail"
@@SUBJECT@@: "account account.number is past due"
@@DAYS@@: "config.overduenotice"
@@AMOUNT@@: The amount that is overdue.
@@BALANCE@@: "account.balance"

`/usr/local/billmax/local/svcexpire.email`

Used by closeofday to notify Account holders of upcoming expiration dates for Services.

@@TO@@: "account.email"
@@FROM@@: "config.bcemail"
@@SUBJECT@@: "Expiration of service.d01"
@@SERVICE@@: "service.d01"
@@DAYS@@: "30"
@@PRICE@@: "service.price"

`/usr/local/billmax/local/usagereport.email`

Used by closeofday to notify Account holders of usage associated with Tierplan billing.

@@TO@@: "account.email"
@@FROM@@: "config.bcemail"
@@SUBJECT@@: "Usage Report for account accountname" where accountname is the first 60 characters of "account.number account.cfname account.clname account.company".
@@BWINFO@@: The result of the executing /usr/local/billmax/bin/usage for a specific Service.
@@ACCOUNTNAME@@: This is the first 60 characters of "account.number account.cfname account.clname account.company".
@@SERVICENAME@@: This is composed of service.number and service.d01.

`/usr/local/billmax/local/usagesusp.email`

Used by radiusd processing to notify Account holders when a Service State is change to Suspended State due to the usage limits being met or exceeded.

@@TO@@: "account.email"
@@FROM@@: "config.bcemail"
@@SERVICE@@: "service.d01"
@@HOURS@@: "service.oususp/3600"
@@PHOURS@@: "service.ouprimesusp/3600"

`/usr/local/billmax/local/usagewarn.email`

Used by radiusd processing to notify Account holders when a Service usage has either 1) exceeded service.ounotice but is less than service.oususp; or 2) exceeded service.ouprimenotice but is less than service.ouprimesusp.

@@TO@@: "account.email"
@@FROM@@: "config.bcemail"
@@SERVICE@@: "service.d01"
@@USEDHOURS@@: "service.totseconds/3600"
@@USEDPHOURS@@: "service.ouprimenotice/3600"
@@HOURS@@: "service.oususp/3600"
@@PHOURS@@: "service.ouprimesusp/3600"


	BillMax Billing Solutions 877.245.5629 sales@billmax.com


dbschema		lists