Contents |
The following variables can be used in templates themselves as part of the HTML that is sent in emails.
Notes: These variables are for LetterMark the 5.x server only. If you are using the 6.x server this variables are not available.
| Variable used in template | Data source |
|---|---|
| <instructions/> | If HELPGRAPHICID is not 0, then this is replaced by an image link based on the company set. |
| <header/> | Replaced with the url and image map for the image associated with the template itself. This will include the server side mapping if the image contains a map. |
| <vmlheader/> | This is the same as above, except it includes the client side map required to make Outlook 2007 work properly. The image sizes must be set for the image before this variable is used or the system will use the standard version (above) instead. |
| <header name="???"/> | The '?' refers to the name of a header image. By specifying a name, the alternate header image and map will be used instead of the one associated directly with the template. Example: <header name="RTSTestTemplate"/> would use header for the template named RTSTestTemplate. The text is replaced with the url and image map for the image specified. This will include the server side mapping if the image contains a map. You must use standard double quotes, not single quotes due to a flaw in the processing of these values. |
| <vmlheader name="???"/> | This is the same as above, except it includes the client side map required to make Outlook 2007 work properly. The image sizes must be set for the image before this variable is used or the system will use the standard version (above) instead. You must use standard double quotes, not single quotes due to a flaw in the processing of these values. |
| <businesscard/> | Replaced with the url and image map for the default business card style for the user of the template. This will include the server side mapping if the image contains a map. |
| <vmlcard/> | There is no default vmlcard variable. Due to the way this information is transmitted to the client, it must be the same for all users in a given company, so vmlcard will not work properly for users who have a default card other than card #1. Because this is counter-intuitive, this variable is not processed by the client or server and is silently ignored. Specify a specific vmlcard by number or name instead. |
| <businesscard_??/> | The '?' marks can be any number between 1 and the number of cards in the system for the company. By specifying a number, the alternate business card image and map will be used instead of the users default card style. Example: <businesscard_5/> would use card graphic #5. The text is replaced with the url and image map for the image specified. This will include the server side mapping if the image contains a map. |
| <vmlcard_??/> | This is the same as above, except it includes the client side map required to make Outlook 2007 work properly. The image sizes must be set for the image before this variable is used or the system will use the standard version (above) instead. |
| <businesscard name="??"/> | The '?' marks can be the name of any of the cards in the system for the company. By specifying a name, the business card image and map named will be used instead of the users default card style. Example: <businesscard name="simple"/> would use card graphic named 'simple'. The text is replaced with the url and image map for the image specified. This will include the server side mapping if the image contains a map. You must use standard double quotes, not single quotes due to a flaw in the processing of these values. |
| <vmlcard name="??"/> | This is the same as above, except it includes the client side map required to make Outlook 2007 work properly. The image sizes must be set for the image before this variable is used or the system will use the standard version (above) instead. You must use standard double quotes, not single quotes due to a flaw in the processing of these values. |
| <userlicensekey/> | Replaced with the users license key |
| <userinfoinsert1></userinfoinsert1> | A concatination of the users personal information, the following fields: fname, lname, jobtitle, telno, faxno, mobile, pager and email. This is formatted onto multiple lines with the fname and lname fields on the same line, seperated by a space. Other than the fname/lname and jobtitle fields, all other fields are prefixed with a hard coded label like: Tel:, Fax:, Mobile:, Pager:, and mailto: repsectively. Because the format is hard coded, use of this variable should be avoided if possible. |
| <Message:Body/> | This text is replaced by the message body and original message(s) if the message is a reply or forward. This tag is required in all templates and the system will not allow templates to be saved without it. |
WARNING: The code to support these new variables in template text is not available in LetterMark clients prior to version 5.6. The variables may be used in all other items regardless of client or server version, including images, image maps and customize vcards.
These variables may be used in templates and SVG images and vcard links. When used in templates, the client must have version 5.6 or newer. If the sender is using an older version of client software the variables will not be used as expected and will be left as variables in the message sent out. For SVG images, you may name an element by a variable name and it will be hidden if the variable is empty.
| Variable Name | Logic used to determine the value of the variable. |
|---|---|
| Company:Name | The company name field as stored in the database. |
| Company:URL | The company url field as stored in the database. |
| Location:Name | The locationname field as stored in the database. |
| Location:DisplayName | The location displayname field as stored in the database. |
| Location:Address1 | The location address1 field as stored in the database. |
| Location:Address2 | The location address2 field as stored in the database. |
| Location:City | The location city field as stored in the database. |
| Location:State | The location state field as stored in the database. |
| Location:Country | The location country field as stored in the database. |
| Location:Postal | The location zip field as stored in the database. |
| Location:FormattedAddress | A block of formatted text representing the joined location address elements |
| Location:Phone | This field is provided for feature compatibility. It contains a copy of the users Phone information. |
| Location:Fax | This field is provided for future compatibility. It contains a copy of the users Fax information. |
| Location:URL | The location locationurl field as stored in the database. |
| Location:MapURL | The location yahoomap field as stored in the database. |
| User:EmailAddress | The user email field as stored in the database. |
| User:DisplayName | The user formattedName field as stored in the database. |
| User:NamePrefix | The user prefixname field as stored in the database. |
| User:FirstName | The user givenName field as stored in the database. |
| User:MiddleName | The user middleName field as stored in the database. |
| User:LastName | The user familyName field as stored in the database. |
| User:NameSuffix | The user suffixname field as stored in the database. |
| User:JobTitle | The user jobTitle field as stored in the database. |
| User:BusinessPhone | The user businessPhone field as stored in the database. |
| User:SecondaryBusinessPhone | The user businessPhone2 field as stored in the database. |
| User:MobilePhone | The user mobilePhone field as stored in the database. |
| User:Pager | The user pager field as stored in the database. |
| User:HomePhone | The user homephone field as stored in the database. |
| User:Fax | The fax field as stored in the database. |
| User:URL | The user HOMEPAGEURL field as stored in the database. |
| User:BusinessAddress1 | Uses custom_address1 if it is not empty or Location:Address1 if it is empty |
| User:BusinessAddress2 | Uses custom_address2 if it is not empty or Location:Address2 if it is empty |
| User:BusinessCity | Uses custom_city if it is not empty or Location:City if it is empty |
| User:BusinessState | Uses custom_state if it is not empty or Location:State if it is empty |
| User:BusinessCountry | This value is not currently stored in the database and is always pulled from Location:Country for forward compatibility. |
| User:BusinessPostal | Uses custom_zip if it is not empty or Location:PostalCode if it is empty |
| User:BusinessFormattedAddress | A block of formatted text representing the joined business address elements above. |
| User:SecondaryBusinessAddress1 | Currently this value is always blank, it is included only for forward compatibility with LetterMark 6.0 |
| User:SecondaryBusinessAddress2 | Currently this value is always blank, it is included only for forward compatibility with LetterMark 6.0 |
| User:SecondaryBusinessCity | Currently this value is always blank, it is included only for forward compatibility with LetterMark 6.0 |
| User:SecondaryBusinessState | Currently this value is always blank, it is included only for forward compatibility with LetterMark 6.0 |
| User:SecondaryBusinessCountry | Currently this value is always blank, it is included only for forward compatibility with LetterMark 6.0 |
| User:SecondaryBusinessPostal | Currently this value is always blank, it is included only for forward compatibility with LetterMark 6.0 |
| User:SecondaryBusinessFormattedAddress | A block of formatted text representing the joined secondary business address elements |
| User:HomeAddress1 | Currently this value is always blank, it is included only for forward compatibility with LetterMark 6.0 |
| User:HomeAddress2 | Currently this value is always blank, it is included only for forward compatibility with LetterMark 6.0 |
| User:HomeCity | Currently this value is always blank, it is included only for forward compatibility with LetterMark 6.0 |
| User:HomeState | Currently this value is always blank, it is included only for forward compatibility with LetterMark 6.0 |
| User:HomeCountry | Currently this value is always blank, it is included only for forward compatibility with LetterMark 6.0 |
| User:HomePostal | Currently this value is always blank, it is included only for forward compatibility with LetterMark 6.0 |
| User:HomeFormattedAddress | A block of formatted text representing the joined home address elements |
Custom Variables are exposed in the same manner as the predefined variables. The variable name is a combination of the prefix based on the variable type, and the variable name. There are currently three types of custom variables supported. *
Examples:
| Variable | Custom Variable Type | Custom Variable Name | Description |
|---|---|---|---|
| Company:Newsletter | Company Wide | Newsletter | This is a common variable used to link templates to a newsletter, allowing it to be updated to point to the latest version online. |
| Location:EventCalendar | Location specific | EventCalendarURL | Contains a link to a page describing upcoming events specific to the location. Useful for companies which host events at their various locations and would like to keep their customers aware of the latest events in their area. |
| User:LinkedInURL | User specific | LinkedInURL | Contains a link to the users LinkedIn public profile page, a nice touch on business card images. |
The following variables are for use in SVG images. By setting the id attribute of an <image> tag in the svg template to a value in the table below, it will be replaced with the special image specified.
LetterMark 5:
Special images are uploaded using special names to the Designer login area. The file name must have a gif, jpg, or png or extension. There is only one company_logo image per company. The location and user images will only be available in Cards, not headers images as headers are company wide objects. When uploading images, due to a bug in the current system, if you upload multiple images with different extensions for the same purpose, such as company_logo.gif and company_logo.png, the .png file will be used even if a new company_logo.gif is uploaded. This means that old png files will be prefered over jpg or gif files, and also that jpg files will be prefered over gif files. As such, the simplest thing to do is always upload .png images when uploading new Special images.
The filename used when an image is upload determines how it is used. The table below shows the format used to determine the filename.
LetterMark 6:
Special images are specified on the user, location or company editor pages directly, the filename and notes do not apply to LetterMark 6. The images will be used without referencing the filename.
| Image Name | Base filename checked. | Example |
|---|---|---|
| Company:Image | company_logo | company_logo.gif |
| Location:Image | logo<LOCATIONID> | logo22270.gif ( for location id 22270, the RTS Headquarters ) |
| User:Image | photo_<LICENSEKEY> | photo_ZVJH.jpg ( for the photo for the user with the license key of ZVHJ, the RTS Test Master ) |
VCards can use all regular and custom variables to customize the vcard format used for your company. The variables used must contain text only, other data types such as image variables are not supported.
The following table represents the default vcard format for the LetterMark 5 system only. LetterMark 6 administrators should consult the company defaults section of the LetterMark.NET website to view the default mapping for your company.
| VCard Field | Variable used | Notes |
|---|---|---|
| Name Prefix | User:NamePrefix | Mr, Ms, Mrs, Dr, Prof, ect |
| First/Given Name | User:FirstName | |
| Middle Name | User:MiddleName | |
| Last/Family Name | User:LastName | |
| Name Suffix | User:LastName | Sr, Jr, II, III, IV, Esq |
| Company Name | Company:Name | |
| Title | User:JobTitle | |
| Work Phone Number | User:BusinessPhone | |
| Fax Number | User:Fax | |
| Mobile Phone Number | User:MobilePhone | |
| Work Address | User:BusinessFormattedAddress | This will be the Location:Address by default, but will be the custom address for the user if one is configured. |
| Work Address Location Name | Custom | If the user has a custom address configured in their profile and a custom label set, the custom label will be used to name the address provided. |
| Work URL | Company:URL | |
| Email Address | User:EmailAddress | |
| Notes | custom | If the user has the 'notes' field is not blank, this information will be included in the vcard Notes field. |
Note: Different email clients handle vcards differently. This vcard format works well with Microsoft Outlook, but you may wish to configure a custom vcard URL if you wish to better support other client types.