Some or all of these templates are used by the following files:
_Process_AddListing.asp
_Process_AddUser.asp
_Process_AuthorizeUser.asp
f-email.asp
f-email_to_friend.asp
newuser.asp
As these templates are processed and data is drawn from the database or other resources to be inserted into the outgoing email message, the tokens are processed by the ProcessEmailMessage() function located in _globals.asp and the tokens are replaced by dynamic values.
It is important to note that some tokens listed below are only relevant in special circumstances. For example, the [ParentCompanyCompanyName:] and [SenderName:] tokens will work well in any of these templates, but the [fieldUsername:] and [fieldPassword:] tokens are useful only in the "email_loginrecovery_template.html" file where both the username and password are likely to be relevant.
Below is a complete list of the tokens supported by the ProcessEmailMessage() function that you may use in these HTML template files:
[fieldFirstName:]
Source Data Type: A text field returned by a database query as a string. This field has a maximum length of 255 characters.
Output Data Format: A string.
Usage: This token should be used only in templates in which a current user can be determined. This token may be used to display the first name or given name of the person associated with the current user account. This data is stored in the "firstname" field in the "people" table associated with the "peopleID" of the current user account.
Conditional Output: This field will have output if the "firstname" field has length, and the "fieldFirstName" option has length (i.e. if that field name is NOT left blank in the field set), and if the "firstname" field is not disabled by the user's account "displayoptions".
Properties
:label
First Name, Given Name (The label of the field as defined in [User] Account Field Names form).
:value
John or Jane, Jack or Jill
Required Attributes
None
Optional Attributes
HTML Code or Text
Any HTML markup or text that is included in the token will be written directly to the page.
Source Data Type: A text field returned by a database query as a string. This field has a maximum length of 255 characters.
Output Data Format: A string.
Usage: This token should be used only in templates in which a current user can be determined. This token may be used to display the last name or family name of the person associated with the current user account. This data is stored in the "lastname" field in the "people" table associated with the "peopleID" of the current user account.
Conditional Output: This field will have output if the "lastname" field has length, and the "fieldLastName" option has length (i.e. if that field name is NOT left blank in the field set), and if the "lastname" field is not disabled by the user's account "displayoptions".
Properties
:label
Surname, Family Name (The label of the field as defined in [User] Account Field Names form).
:value
Presley (as in Elvis Presley)
Required Attributes
None
Optional Attributes
HTML Code or Text
Any HTML markup or text that is included in the token will be written directly to the page.
Source Data Type: A text field returned by a database query as a string. This field has a maximum length of 255 characters.
Output Data Format: A string.
Usage: This token should be used only in templates in which a current user can be determined. This token may be used to display the password of the person associated with the current user account. This data is stored in the "password" field in the "people" table associated with the "peopleID" of the current user account.
Conditional Output: This field will have output if the "password" field has length.
Properties
:label
Password (The label of the field as defined in [User] Account Field Names form).
:value
myPassword
Required Attributes
None
Optional Attributes
HTML Code or Text
Any HTML markup or text that is included in the token will be written directly to the page.
Exam
ples
[fieldPassword::label::value]
Password: myPassword
[fieldUsername:]
Source Data Type: A text field returned by a database query as a string. This field has a maximum length of 255 characters.
Output Data Format: A string.
Usage: This token should be used only in templates in which a current user can be determined. This token may be used to display the username of the person associated with the current user account. This data is stored in the "username" field in the "people" table associated with the "peopleID" of the current user account.
Conditional Output: This field will have output if the "username" field has length.
Properties
:label
Username (The label of the field as defined in [User] Account Field Names form).
:value
myUsername
Required Attributes
None
Optional Attributes
HTML Code or Text
Any HTML markup or text that is included in the token will be written directly to the page.
Examples
[fieldUsername::label::value]
Username: myUsername
[fieldTitle:]
Source Data Type: A text field returned by a database query as a string. This field has a maximum length of 255 characters.
Output Data Format: A string.
Usage: This token should be used only in templates in which a current user can be determined. This token may be used to display the salutation or title of the person associated with the current user account. This data is stored in the "title" field in the "people" table associated with the "peopleID" of the current user account.
Conditional Output: This field will have output if the "title" field has length, and the "fieldTitle" option has length (i.e. if that field name is NOT left blank in the field set), and if the "title" field is not disabled by the user's account "displayoptions".
Properties
:label
Salutation, Title, etc. (The label of the field as defined in [User] Account Field Names form).
:value
Mr., Mrs., Ms., Dr., CEO, President, etc.
Required Attributes
None
Optional Attributes
HTML Code or Text
Any HTML markup or text that is included in the token will be written directly to the page.
Examples
[fieldTitle::label::value]
Title: President
[fieldTitle::value ][fieldLastName::value]
Mrs. Smith
[ItemLink:]
Source Data Type: http://"& request.servervariables("SERVER_NAME") & "listings.asp?itemID=(itemID)"
Output Data Format: A string representing a URL pointing to the current item (when a current item can be determined).
Usage: This token may be used to produce text, or a clickable link in the outgoing email message which points to the current item.
Conditional Output: This token will always have output.
Any HTML markup or text that is included in the token will be written directly to the page.
Examples
[ItemLink::value]
http://www.google.com/listings.asp?itemID=483
To view this item, go to [ItemLink::value] or <a href="[ItemLink::value]"> Click Here </a>.
To view this item, go to http://www.google.com/listings.asp?itemID=483 or <a href="http://www.google.com/listings.asp?itemID=483"> Click Here </a>.
[ParentCompanyAddress:]
Source Data Type: A text field returned by a database query as a string. This field has a maximum length of 255 characters.
Output Data Format: A string.
Usage: This token may be used to display the mailing address associated with the "parent" company. This data is stored in the "address" field in the "people" table associated with the "peopleID" of the currently selected parent company.
Conditional Output: This field will have output if the "address" field has length, and the "fieldAddress" option has length (i.e. if that field name is NOT left blank in the field set), and if the "address" field is not disabled by the user's account "displayoptions".
Properties
:label
Address, Location (The label of the field as defined in [User] Account Field Names form).
:value
123 Street Addr.
Required Attributes
None
Optional Attributes
HTML Code or Text
Any HTML markup or text that is included in the token will be written directly to the page.
<table border="1"><tr><td>Address:</td><td>123 Street Addr.</td></tr>]</table>
[ParentCompanyCity:]
Source Data Type: A text field returned by a database query as a string. This field has a maximum length of 255 characters.
Output Data Format: A string.
Usage: This token may be used to display the city associated with the "parent" company. This data is stored in the "city" field in the "people" table associated with the "peopleID" of the currently selected parent company.
Conditional Output: This field will have output if the "city" field has length, and the "fieldCity" option has length (i.e. if that field name is NOT left blank in the field set), and if the "city" field is not disabled by the user's account "displayoptions".
Properties
:label
City, Town (The label of the field as defined in [User] Account Field Names form).
:value
Paris
Required Attributes
None
Optional Attributes
HTML Code or Text
Any HTML markup or text that is included in the token will be written directly to the page.
Source Data Type: A text field returned by a database query as a string. This field has a maximum length of 255 characters.
Output Data Format: A string.
Usage: This token may be used to display the company name associated with the "parent" company. This data is stored in the "companyname" field in the "people" table associated with the "peopleID" of the currently selected parent company.
Conditional Output: This field will have output if the "companyname" field has length, and the "fieldCompanyName" option has length (i.e. if that field name is NOT left blank in the field set), and if the "companyname" field is not disabled by the user's account "displayoptions".
Properties
:label
Company Name, Office, Corporation (The label of the field as defined in [User] Account Field Names form).
:value
Big Bob's Auto Sales, Re/Max, etc.
Required Attributes
None
Optional Attributes
HTML Code or Text
Any HTML markup or text that is included in the token will be written directly to the page.
Like the example above, if this field is empty or currently has no output then the result of this example would be: <table border="1"></table>
[ParentCompanyCompanyName:The administrator of this web site works for ":value"] and the logo looks like this: [ParentCompanyPhoto::value]
The administrator of this web site works for "K-Mart" and the logo looks like this: <img src="http://www.k-mart.com/logo.gif" border="0" alt="K-Mart" class="parentCompanyImage" />
[ParentCompanyCounty:]
Source Data Type: A text field returned by a database query as a string. This field has a maximum length of 255 characters.
Output Data Format: A string.
Usage: This token may be used to display the county associated with the "parent" company. This data is stored in the "county" field in the "people" table associated with the "peopleID" of the currently selected parent company.
Conditional Output: This field will have output if the "county" field has length, and the "fieldCounty" option has length (i.e. if that field name is NOT left blank in the field set), and if the "county" field is not disabled by the user's account "displayoptions".
Properties
:label
County, Region (The label of the field as defined in [User] Account Field Names form).
:value
Dade
Required Attributes
None
Optional Attributes
HTML Code or Text
Any HTML markup or text that is included in the token will be written directly to the page.
Source Data Type: A text field returned by a database query as a string. This field has a maximum length of 255 characters.
Output Data Format: A string.
Usage: This token may be used to display the country associated with the "parent" company. This data is stored in the "country" field in the "people" table associated with the "peopleID" of the currently selected parent company.
Conditional Output: This field will have output if the "country" field has length, and the "fieldCountry" option has length (i.e. if that field name is NOT left blank in the field set), and if the "country" field is not disabled by the user's account "displayoptions".
Properties
:label
Country (The label of the field as defined in [User] Account Field Names form).
:value
Canada
Required Attributes
None
Optional Attributes
HTML Code or Text
Any HTML markup or text that is included in the token will be written directly to the page.
Source Data Type: A text field returned by a database query as a string. This field has a maximum length of 255 characters.
Output Data Format: A string.
Usage: This token may be used to display the email associated with the "parent" company. This data is stored in the "email" field in the "people" table associated with the "peopleID" of the currently selected parent company.
Conditional Output: This field will have output if the "email" field has length, and the "fieldEmail" option has length (i.e. if that field name is NOT left blank in the field set), and if the "email" field is not disabled by the user's account "displayoptions".
Properties
:label
Email (The label of the field as defined in [User] Account Field Names form).
:value
the@email.address
Required Attributes
None
Optional Attributes
HTML Code or Text
Any HTML markup or text that is included in the token will be written directly to the page.
Source Data Type: A text field returned by a database query as a string. This field has a maximum length of 255 characters.
Output Data Format: A string.
Usage: This token may be used to display the fax phone number associated with the "parent" company. This data is stored in the "faxphone" field in the "people" table associated with the "peopleID" of the currently selected parent company.
Conditional Output: This field will have output if the "faxphone" field has length, and the "fieldFaxPhone" option has length (i.e. if that field name is NOT left blank in the field set), and if the "faxphone" field is not disabled by the user's account "displayoptions".
Properties
:label
Fax Number (The label of the field as defined in [User] Account Field Names form).
:value
1-800-FAX-1234
Required Attributes
None
Optional Attributes
HTML Code or Text
Any HTML markup or text that is included in the token will be written directly to the page.
Source Data Type: A text field returned by a database query as a string. This field has a maximum length of 255 characters.
Output Data Format: A string.
Usage: This token may be used to display the first name or given name of the person associated with the "parent" company. This data is stored in the "firstname" field in the "people" table associated with the "peopleID" of the currently selected parent company.
Conditional Output: This field will have output if the "firstname" field has length, and the "fieldFirstName" option has length (i.e. if that field name is NOT left blank in the field set), and if the "firstname" field is not disabled by the user's account "displayoptions".
Properties
:label
First Name, Given Name (The label of the field as defined in [User] Account Field Names form).
:value
John or Jane, Jack or Jill
Required Attributes
None
Optional Attributes
HTML Code or Text
Any HTML markup or text that is included in the token will be written directly to the page.
Source Data Type: A text field returned by a database query as a string. This field has a maximum length of 255 characters.
Output Data Format: A string.
Usage: This token may be used to display the last name or family name of the person associated with the "parent" company. This data is stored in the "lastname" field in the "people" table associated with the "peopleID" of the currently selected parent company.
Conditional Output: This field will have output if the "lastname" field has length, and the "fieldLastName" option has length (i.e. if that field name is NOT left blank in the field set), and if the "lastname" field is not disabled by the user's account "displayoptions".
Properties
:label
Surname, Family Name (The label of the field as defined in [User] Account Field Names form).
:value
Presley (as in Elvis Presley)
Required Attributes
None
Optional Attributes
HTML Code or Text
Any HTML markup or text that is included in the token will be written directly to the page.
Source Data Type: A text field returned by a database query as a string. This field has a maximum length of 255 characters.
Output Data Format: A string.
Usage: This token may be used to display the phone number associated with the "parent" company. This data is stored in the "phone" field in the "people" table associated with the "peopleID" of the currently selected parent company.
Conditional Output: This field will have output if the "phone" field has length, and the "fieldPhone" option has length (i.e. if that field name is NOT left blank in the field set), and if the "phone" field is not disabled by the user's account "displayoptions".
Properties
:label
Phone Number (The label of the field as defined in [User] Account Field Names form).
:value
1-800-123-1234
Required Attributes
None
Optional Attributes
HTML Code or Text
Any HTML markup or text that is included in the token will be written directly to the page.
Source Data Type: A text field returned by a database query as a string. This field has a maximum length of 255 characters.
Output Data Format: A string.
Usage: This token may be used to display the postal code associated with the "parent" company. This data is stored in the "postalcode" field in the "people" table associated with the "peopleID" of the currently selected parent company.
Conditional Output: This field will have output if the "postalcode" field has length, and the "fieldPostalCode" option has length (i.e. if that field name is NOT left blank in the field set), and if the "postalcode" field is not disabled by the user's account "displayoptions".
Properties
:label
Postal/Zip Code (The label of the field as defined in [User] Account Field Names form).
:value
90210
Required Attributes
None
Optional Attributes
HTML Code or Text
Any HTML markup or text that is included in the token will be written directly to the page.
Source Data Type: A text field returned by a database query as a string. This field has a maximum length of 255 characters.
Output Data Format: A string.
Usage: This token may be used to display the provinde code associated with the "parent" company. This data is stored in the "province" field in the "people" table associated with the "peopleID" of the currently selected parent company.
Conditional Output: This field will have output if the "province" field has length, and the "fieldProvince" option has length (i.e. if that field name is NOT left blank in the field set), and if the "province" field is not disabled by the user's account "displayoptions".
Properties
:label
Province, State (The label of the field as defined in [User] Account Field Names form).
:value
Texas
Required Attributes
None
Optional Attributes
HTML Code or Text
Any HTML markup or text that is included in the token will be written directly to the page.
Source Data Type: A text field returned by a database query as a string. This field has a maximum length of 255 characters.
Output Data Format: A string.
Usage: This token may be used to display the provinde code associated with the "parent" company. This data is stored in the "secondaryphone" field in the "people" table associated with the "peopleID" of the currently selected parent company.
Conditional Output: This field will have output if the "secondaryphone" field has length, and the "fieldSecondaryPhone" option has length (i.e. if that field name is NOT left blank in the field set), and if the "secondaryphone" field is not disabled by the user's account "displayoptions".
Properties
:label
Alternate Phone (The label of the field as defined in [User] Account Field Names form).
:value
1-789-456-1230
Required Attributes
None
Optional Attributes
HTML Code or Text
Any HTML markup or text that is included in the token will be written directly to the page.
Source Data Type: A text field returned by a database query as a string. This field has a maximum length of 255 characters.
Output Data Format: A string.
Usage: This token may be used to display the salutation or title of the person associated with the "parent" company. This data is stored in the "title" field in the "people" table associated with the "peopleID" of the currently selected parent company.
Conditional Output: This field will have output if the "title" field has length, and the "fieldTitle" option has length (i.e. if that field name is NOT left blank in the field set), and if the "title" field is not disabled by the user's account "displayoptions".
Properties
:label
Salutation, Title, etc. (The label of the field as defined in [User] Account Field Names form).
:value
Mr., Mrs., Ms., Dr., CEO, President, etc.
Required Attributes
None
Optional Attributes
HTML Code or Text
Any HTML markup or text that is included in the token will be written directly to the page.
Source Data Type: A memo field returned by a database query as a valid URL (either a relative URL which references a file stored in the uploads sub folder within the 20/20 DataShed file system, or a full URL which links to a file somewhere on the internet). This field has a maximum length of 64 kilobytes.
Output Data Format: A string that is a valid URL.
Usage: This token may be used to display the URL associated with the "parent" company, and further to create a hyperlink to the company's home page. This data is stored in the "URL" field in the "people" table associated with the "peopleID" of the currently selected parent company.
Conditional Output: This token will have output if the value in the "URL" field is a valid URL, and the "fieldURL" option has length (i.e. if that field name is NOT left blank in the field set), and if the "URL" field is not disabled by the parent user's account "displayoptions".
Properties
:label
URL, WWW, Link, etc. (The label of the field as defined in [User] Account Field Names form).
:value
Example: http://www.2020applications.com/ or http://www.google.com/
Required Attributes
None
Optional Attributes
HTML Code or Text
Any HTML markup or text that is included in the token will be written directly to the page.
Examples
[ParentCompanyURL::label: :value]
URL: http://www.google.com/
[ParentCompanyURL:For more information go to :value]
For more information go to http://www.google.com/
[ParentCompanyURL:For more information go to <a href=":value">:value</a>.]
For more information go to <a href="http://www.google.com/>http://www.google.com/</a>. (Note that the :v
alue property can be used twice
within the same token!)
For more information go to [ParentCompanyURL:<a href=":value">][ParentCompanyCompanyName::value][ParentCompanyURL:</a>.]
For more information go to <a href="http://www.k-mart.com/>K-Mart</a>.
For more information go to [ParentCompanyURL:<a href=":value">][ParentCompanyCompanyName::value][ParentCompanyURL:</a>.]
Like the example above, if the URL field is empty or currently has no output then the result of this example would be: For more information go to K-Mart.
[SenderEmailAddress:]
Source Data Type: Input form data.
Output Data Format: A string representing the email address of a person sending the email message.
Usage: This token may be used to write the email address of the message's sender to the outgoing email message body.
Conditional Output: This token will always have output.
Properties
:value
your@email_address.com
Required Attributes
None
Optional Attributes
HTML Code or Text
Any HTML markup or text that is included in the token will be written directly to the page.
Examples
[SenderEmailAddress::value]
your@email_address.com
[SenderName::value] ([SenderEmailAddress::value]) has sent you a message.
Elvis Presley (elvis@graceland.us) has sent you a message.
[SenderMessage:]
Source Data Type: Input form data.
Output Data Format: A string representing the sender's message.
Usage: This token may be used to write the sender's message to the outgoing email message body.
Conditional Output: This token will always have output.
Properties
:value
The value of this token may contain lengthy text and may or may not include HTML code.
Required Attributes
None
Optional Attributes
HTML Code or Text
Any HTML markup or text that is included in the token will be written directly to the page.
Examples
[SenderMessage::value]
Hello, this is an email message!
[SenderName::value] has sent you this message<br>[SenderMessage::value]
Elvis Presley has sent you this message<br>Hello, this is an email message!
[SenderName:]
Source Data Type: Input form data.
Output Data Format: A string representing the name of a person sending the email message.
Usage: This token may be used to write the name of the message's sender to the outgoing email message body.
Conditional Output: This token will always have output.
Properties
:value
My Name
Required Attributes
None
Optional Attributes
HTML Code or Text
Any HTML markup or text that is included in the token will be written directly to the page.
Examples
[SenderName::value]
My Name
[SenderName::value] has sent you a message.
Elvis Presley has sent you a message.
[Subject:]
Source Data Type: Input form data or dynamically generated content.
Output Data Format: A string representing the message subject.
Usage: This token may be used to write the message subject to the outgoing email message body.
Conditional Output: This token will always have output.
Properties
:value
Text
Required Attributes
None
Optional Attributes
HTML Code or Text
Any HTML markup or text that is included in the token will be written directly to the page.
Examples
[Subject::value]
Re: Your inquiry
The message <b>[Subject::value]</b> is:<br>[SenderMessage::value]
The message <b>Re:Your inquiry</b> is:<br>Hello, this is an email message!
[URLAuthorize:]
Source Data Type: http://"& request.servervariables("SERVER_NAME") & "login.asp?action=authorize_new_user"
Output Data Format: A string representing the URL of this web site's login.asp page (with attached querystring to conveniently send the user directly to the Authorize New User page).
Usage: This token may be used to produce text, or a clickable link in the outgoing email message which points to this web site's login.asp page. For example, this token is used in the "email_newuserregisteredadminnotification_template.html" template.
Conditional Output: This token will always have output.
[URLAuthorize:<a href=":value">Click here to login and authorize the a new user.</a>]
<a href="http://www.google.com/login.asp?action=authorize_new_user">Click here to login and authorize the a new user.</a>
[UserDefinedFormElements:]
Source Data Type: Form Data sent from "newuser_UserDefinedForm.inc" and/or "f-email_UserDefinedForm.inc"
Output Data Format: A string containing name and value pairs produced by the newuser.asp page (in combination with the "newuser_UserDefinedForm.inc" file) and/or the "f-email.asp" (in combination with the "f-email_UserDefinedForm.inc" file).
Usage: This token should be used in any outgoing message produced by the newuser.asp page or f-email.asp page and associated processes in which you'd like the form data to appear.
Conditional Output: This token will have output only if the "newuser_UserDefinedForm.inc" (when used with "newuser.asp") or the "f-email_UserDefinedForm.inc" file (when used with "f-email.asp") contains valid HTML form elements.
Properties
:value
Form data (name and value pairs) in HTML table format.
Required Attributes
None
Optional Attributes
HTML Code or Text
Any HTML markup or text that is included in the token will be written directly to the page.
Send Feedback