Next: Editing & adding language Up: adminMailer Previous: Using Qmail


Editing the templates

All Vorras Mailer files are in HTML format. However, they contain special commands in the form of HTML comments to tell the page engine software how to display dynamic information and to include other HTML files.

To create a new template you will have to create a new template directory first. Lets assume you decide to create a new template for Vorras Mailer which you call the ``Red template''. The steps you need to take are as follows:

  1. First change directory to the templates directory in the Vorras Mailer directory.
  2. Create a subdirectory called Red_template.
  3. Copy all files from one of the templates provided in the downloaded package such as the Blue template. For example on UNIX systems, you can copy all files from the Blue template as follows: cp -r Blue/* Red_template/
  4. On the administration interface, make sure you reload the page to reflect the new directory created and then go to ``Select HTML template:'' and change the selected template to Red_template. To modify your new template select a *.txt file from the ``Edit HTML'' select menu and edit the template from that page.
NOTE: Do not modify the JavaScript code found between the head and /head tags in the header.txt file included in all templates. This code ensures Vorras Mailer can use JavaScript and if erased, Vorras Mailer will not work properly.

HTML templates for Vorras Mailer use special tags in form of HTML comments as follows:

  • MaiosPowered-: This tag may be mandatory depending on your license agreement with Vorras Corporation. If your license agreement dictates that you should include a link to the Vorras Mailer homepage then this tag should exist on all Vorras Mailer pages. This prints a link to the Vorras Mailer homepage at http://www.vorras.com/products/vorras_mailer/. The easiest way to ensure that it exists on all Vorras Mailer pages is to place it in the footer.txt file, which is imported by all other files (see below for information on importing other files). Alternatively you can place in any other file as long as this file is imported in all your HTML pages.
  • !-MaiosImport:filename-: This tag will import another HTML file from the current template directory in the html file being modified. This permits administrators to store for example one header or footer file in the template directory and use it on all pages, without repeating the HTML code for it everywhere. To include a footer.txt file in your HTML template you would write:
MaiosImport:footer.txt-

*
!-MaiosVariable:FixedRandomSequence-: This tag can be used whenever there is a need for a random number sequence that is the same whenever used in the HTML page. A typical use of this tag is for banners: if you are posting banners using HTML code from a third party, you often need to place a unique identifier in the banner code, often in multiple locations. The random sequence is the same whenever this tag is used in the page.
*
!-MaiosVariable:RandomSequence-: This tag does the same thing as the FixedRandomSequence tag, except that each time it is used it returns a different random sequence. If for example you have a second banner that requires a different random number on the same page, you can use the RandomSequence tag.
*
!-MaiosLink:action-: This tag is used to create an HTML link that leads to another Vorras Mailer page. The ``action'' can be one of the following:
  • compose: leads to a page that is used to compose a compose a new message
  • showhelp: goes to the help page
  • signout: signs out the user
  • accountinfo: shows account information, i.e. disk space and quotas for the user
  • showoptions: shows all user options
  • index: show mailbox index
  • deleteone: this one is used when reading messages. It will delete the current message
  • forward: this action is used to link to a message forward window
  • readmsg: this action is used in the mailbox index screen to create a link to read a specific message.
  • readmsgprev: this action is used when reading message, to link to the previous message in the current mailbox
  • readmsgnext: this action is used when reading message, to link to the next message in the current mailbox
  • reply: this action is used to link to a message reply window
  • replyall: this action is used to link to a reply window where all recipients of the original message are included.
*
!-MaiosConditional:variable?value-: This tag is used to conditionally insert HTML code depending on the value of a Vorras Mailer variable. A Vorras MailerConditional can be part of another tag, as shown in the example 1 below. In example 1 the image will only be shown if the Vorras Mailer variable start is greater than 1. A MaiosConditional tag can also be used as shown in example 2. When it is used a standalone tag in the beginning of as line, its role is to invalidate completely all HTML code in that line if the condition does not hold, or to show everything if the condition holds.
  1. Example 1: !-MaiosConditional:start1-img src="!-MaiosVariable:imageHtmlTag-prev.gif" border="0" width=80 height=30/a
  2. Example 2: !-MaiosConditional:allowregister0-a href="!-MaiosVariable:scriptName-?action=register"bNew user? Please register here/b/a
The allowed comparisons between the Vorras Mailer variable and the value are: , , =, !. The variables that can currently be tested are:

  • composeheader: this variable is set to 1 if javascript is disabled on Vorras Mailer (users can enable or disable javascript) and if the Vorras Mailer command box (for searching) is being used. In those cases it is recommended to avoid starting a new compose/reply/forward window.
  • start: this variable stores the beginning email number of the mailbox. When it is set to 1 it shows emails starting with the first (i.e.most recent email).
  • NextLinkSet: This is set to 1 whenever there are more messages in the mailbox that can be shown on screen. In those cases a next button or link appears in the message index page.
  • msgsprinted: This stores the number of messages shown in the current page.
  • allowregister: This variable is set to one if user registrations are allowed. This may be set to 0 if Vorras Mailer is used only to check email on existing accounts, and no new user registrations are allowed.
Currently the system only accepts one Vorras Mailer comment per line, with the exception of a MaiosConditional directive.

You can modify your template by using the Vorras Mailer administration interface or by using any other HTML editor and then copy-pasting your HTML code in the appropriate HTML page in the Vorras Mailer administration interface or even directly using the UNIX shell.



Next: Editing & adding language Up: adminMailer Previous: Using Qmail
Site Search
Vorras Support
For general information and support questions about our products: Products Forum - FAQ
To submit a problem or bug please use our Problem submission form
Contact
Vorras Corporation
5 Independence Way, Suite 300
Princeton, NJ 08540
USA
Email: click here


Copyright © 2003 Vorras Corporation. All rights reserved. - User Agreement - Privacy Policy