Tutorial: Editing WebMail Templates

	Home Products Downloads Purchase Support Contact

Products

Downloads

Purchase

Support

Product Info
30 Day Trial
Purchase
Setup Guide
Update History

Version 1.1.12.0

Ocean Mail Server
Help, configuration and tips.

Tutorial: Editing WebMail Templates
The advice offered on this page should only be used by users who are confident in the modification of HTML pages. If you are unsure about this process, we recommend that you firstly learn a basic knowledge of HTML before you continue to make any modifications. For more detailed information on what each option of the WebMail settings is for please view the WebMail Settings page.

What are WebMail Templates and How Do They Work?
The WebMail service is basically an integrated web server which has its own built in script system. The pages displayed by the WebMail service are simply HTML files and normal GIF graphics. These HTML files are generated from template HTML files which contain tags to indicate where certain information should be inserted (e.g. ####USERACCOUNT#### gets replaced with the User/Login). When a user accesses a particular page, the template file is loaded, processed and then sent to the user.
Ocean Mail Server comes installed with a free template called ‘Original’. This template is also intended to form the base of any customization you may wish to create.

How to Modify the Template
The first thing to do when modifying the template is to create a copy of the current template you intend to modify. This means that if you make a serious error or just want to revert back to the original you can without any difficulty. This can be done by making a copy of the original template (copy the folder). Once copied, you then need to go into Ocean Mail Server and configure WebMail to use this new folder as the ‘Default Template’.

A Quick Change
The simplest modification to the template is to remove all 'Code Ocean' images and replace them with your own. Using your favorite GIF editor, you can modify these images and insert your own logos. We recommend that you don't change the size or the background color of the images, as this will then allow the images to better integrate with the rest of the page.

A Complete Change
If you want to completely change the WebMail interface, then this will take much more time. We recommend that you study the structure of the original template and learn how the pages work together. It is important that all the current file names of the HTML files are not changed (Ocean Mail Server expects these filenames to exist in all template folders). However, there’s no harm in adding pages or modifying the code in the current pages.

Filenames
You may notice that some file names begin with an under slash (e.g. _inbox.html). This under slash is used to indicate the file can contain tags that should be compiled. File names without the under-slash will be sent unmodified to the user.

WebMail Tags
The tags which are used within the templates all appear within '' or '####' and '####' markers (e.g.  or ####SUBJECT####). When the file is being compiled, this tag will be replaced with the correct information or removed if not supported. The table below describes each tags purpose and should be used when modifying the template.

Pages	Tag	Replaced With
All Pages	COMPOSELINK	A link to the compose page.
	LOGOUTLINK	A link which logs out the user and sends them to the loggedout.html
	INBOXLINK	A link to the first inbox page.
	ADDRESSBOOKLINK	A link to the address book page.
	EDITFOLDERSLINK	A link to the edit folders page.
	OPTIONSLINK	A link to the options page.
	EDITPERSONALDATALINK	A link to the edit personal data page.
	EDITAUTORESPONSELINK	A link to the edit auto-response page
	EDITSIGNATURELINK	A link to the edit signature page.
	UPDATEPASSWORDLINK	A link to which performs the password update.
	CHANGEPASSWORDLINK	A link to the change password page.
	ID	The ID string of the users current session.
	ADMINADDRESS	The administrators email address.
	USERADDRESS	The current users email address.
	USERACCOUNT	The current users login name.
	MAXMAILSIZE	The maximum mail size of this users account (in KB).
	MAXACCOUNTSIZE	The maximum account size of this users account (in KB).
	STATUSMESSAGE	The current status of the account.
	FILTERSLINK	A link to the filters page.
	ADVANCEDOPTIONSLINK	A link to the advanced options page.
	POP3RETRSLINK	A link to the POP3 retrievals page.
_mailsent.html	SENTTOLIST	The list of addresses in which the email was successfully sent to. Each email address will be a link which will take you to or create an address book entry.
_editattachments.html	DOATTACHMENTLINK	A link to which the attachment is uploaded to.
	RETURNLINK	A link which returns the user to the compose page.
	ATTACHMENTS	A list of attachments (which are download links).
_editattachment.html	ATTACHMENTNAME	The name of the attachment.
	ATTACHMENTSIZE	The size of the attachment (in KB).
	VIEWLINK	A download link to the attachment.
	DELETELINK	A link which deletes the attachment.
	RETURNLINK	A link which returns the user to the edit attachments page.
_inbox.html _otherfolder.html	PREVPAGELINK	A link to the previous page.
	NEXTPAGELINK	A link to the next page.
	PAGENO	The current page number.
	PAGECOUNT	The total number of pages
	LISTSTARTNO	The number of the first email in the list.
	LISTENDNO	The number of the last email in the list.
	TOTALMAILCOUNT	To total number of emails in the inbox
	FOLDERNAME	The name of the current folder.
	FOLDERLIST	A list of links to the 'other folders'.
	FOLDEROPTIONLIST	A HTML option list of all the folders (used for moving emails to another folder).
	PROCESSMSGSLINK	A link to which all the ticked messages will be processed (i.e. for deletion).
	LIST	The list of emails.
	SORTONFROMLINK	Sort the list of emails by the From Field.
	SORTONSUBJECTLINK	Sort the list of emails by the Subject Field.
	SORTONDATELINK	Sort the list of emails by the Date Field.
	SORTONSIZELINK	Sort the list of emails by the Size Field.
	TRIGGERPOP3RETRLINK	A link to manually trigger the POP3 retrievals.
_inboxpart.html	TICK	A tick box which the user can use to select the email.
	ICON	A image representing the read status of a page.
	COLOR	A HTML bgcolor="#??????" parameter. The color depends on the read status of the email.
	FROM	The sender of the email (and a link which takes the user to the read mail page).
	SUBJECT	The subject of the email.
	DATE	The date the email was received.
	SIZE	The size of the email (in KB).
_compose.html _composeallowfrom.html	PROCESSSENDMSGLINK	A link to where the email will be processed.
	ATTACHMENTS	A list of attachments.
	TO	The list of 'To' addresses.
	CC	The list of 'Cc' addresses.
	BCC	The list of 'Bcc' addresses.
	SUBJECT	The subject of the email.
	BODY	The body of the email.
	USECOPYTO	This becomes and HTML checked tag when required.
	FOLDEROPTIONLIST	A HTML option list of all the folders (used for moving emails to another folder).
_readmsghead.html	UIDL	The UID of the email (the ID of the email).
	UID	The UID of the email (the ID of the email).
	TO	Any email address in the To, Cc and Bcc header fields.
	TOONLY	Any email address in the To header field.
	CCONLY	Any email address in the Cc header field.
	BCCONLY	Any email address in the Bcc header field.
	FROM	The from address.
	SUBJECT	The subject.
	DATE	The date the email was received.
	ATTACHMENTLIST	A list of attachments (which are links).
	REPLYLINK	A link which creates a 'reply' email and then takes the user to a compose page.
	REPLYTOALLLINK	A link which creates a 'reply' email and then takes the user to a compose page. This will use all email addresses in the From, To, Cc and Bcc header fields.
	FORWARDLINK	A link which creates a 'forward' email and then takes the user to a compose page.
	FOLDEROPTIONLIST	A HTML option list of all the folders (used for moving the email to another folder).
	MOVEMAIL	A link to move the email into the selected folder.
	DELETELINK	A link which will delete the email.
	NEXTLINK	A link to the next email in the folder.
	PREVLINK	A link to the previous email in the folder.
	CLOSELINK	A link back to the emails's folder.
	BODYTEXTLINK	A link to the text version of the email (if there is one).
	BODYHTMLLINK	A link to the html version of the email (if there is one).
_readmsg.html	HEADLINK	A link to the header page of the email.
	BODYTEXTLINK	A link to the text version of the email (if there is one).
	BODYHTMLLINK	A link to the html version of the email (if there is one).
	BODYDEFAULTLINK	A link to the text or html version of the email, depending on the WebMail settings.
_error.html	ERRORDETAILS	The details of the error.
_editaddressbook.html _viewaddressbook.html	ADDRESSBOOKCOUNT	The number of address book entries
	PROCESSADDRESSBOOKLINK	A link where the selected entries will be processed.
	LIST	The list of address book entries.
_addressbookpart.html	TICK	A tick box which the user can use to select the entry.
	NICKNAME	The nickname of the entry (and a link which takes the user to the edit the entry).
	FULLNAME	The full name of the entry.
	EMAILADDRESS	The email address of the entry
	NOTES	The notes of the entry.
_addaddressbook.html	UPDATEADDRESSBOOKLINK	A link where the form will be processed.
	NICKNAME	The nickname of the entry.
	EMAILADDRESS	The email address of the entry.
	ORIGINALNAME	The original name of the entry (used to manage renaming).
	GIVENNAME	The given name of the entry.
	SURNAME	The surname of the entry.
	ORGANIZATION	The organization of the entry.
	ORGANIZATIONALUNIT	The organizational unit of the entry.
	STREET	The street of the entry.
	LOCALITY	The locality of the entry.
	STATE	The state of the entry.
	POSTALCODE	The postal code of the entry.
	COUNTRYOPTIONLIST	A HTML option list of countries, with the entries country pre-selected.
	TELEPHONENUMBER	The telephone number of the entry.
	DESCRIPTION	The description of the entry.
_editautoresponse.html	PROCESSAUTORESPONSELINK	A link where the form will be processed.
	ENABLED	If auto-responses are enabled, this becomes a HTML checked tag.
	SUBJECT	The current subject.
	MESSAGE	The current message.
	USEREPLYTO	If the auto-response 'Use Reply-To' option is enabled, this becomes a HTML checked tag.
	REPLYTO	The current Reply-To email address.
_editfolders.html	FOLDEROPTIONLIST	A HTML option list of all the folders (used for the selection list).
_editfolders.html	PROCESSFOLDERLINK	A link where the form will be processed.
_editpersonaldata.html	PROCESSPERSONALDATALINK	A link where the form will be processed.
	GIVENNAME	The given name of the account.
	SURNAME	The surname of the account.
	ORGANIZATION	The organization of the account.
	ORGANIZATIONALUNIT	The organizational unit of the account.
	STREET	The street of the account.
	LOCALITY	The locality of the account.
	STATE	The state of the account.
	POSTALCODE	The postal code of the account.
	COUNTRYOPTIONLIST	A HTML option list of countries, with the accounts country pre-selected.
	TELEPHONENUMBER	The telephone number of the account.
	DESCRIPTION	The description of the account.
_editsignature.html	PROCESSSIGNATURELINK	A link where the form will be processed.
	ENABLED	If auto-responses are enabled, this becomes a HTML checked tag.
	SIGNATURE	The current signature.
_advancedoptions.html	PROCESSADVANCEDOPTIONSLINK	A link where the form will be processed.
	USEREPLYTO	If 'Set Reply-To' is enabled, this becomes a HTML checked tag.
	REPLYTO	The current 'Set Reply-To' email address.
	USESAVE	If 'Save Copies of Sent Mails To' is enabled, this becomes a HTML checked tag.
	SAVEDIROPTIONLIST	A HTML option list of all the folders (used for the selection list).
	USEDELE	If 'Place Deleted Mails Into' is enabled, this becomes a HTML checked tag.
	DELEDIROPTIONLIST	A HTML option list of all the folders (used for the selection list).
	USEAUTODELE	If 'Auto-Delete Mails After' is enabled, this becomes a HTML checked tag.
	AUTODELE	The current number of auto-delete days.
_customfilter.html	PROCESSCUSTOMFILTERLINK	A link where the form will be processed.
	CONDITIONPAIRSUBJECT	If 'If Subject Contains' is set, this becomes a HTML checked tag.
	CONDITIONSUBJECT	The custom filter's subject field.
	CONDITIONPAIRFROMADDRESS	If 'If From Address' is set, this becomes a HTML checked tag.
	CONDITIONFROMADDRESS	The custom filter's from address field.
	ACTIONPAIRDELE	If 'Delete Email' is set, this becomes a HTML checked tag.
	ACTIONPAIRPLACEIN	If 'Place in Directory' is set, this becomes a HTML checked tag.
	ACTIONPLACEINOPTIONLIST	A HTML option list of all the folders (used for the selection list).
	FILTERNO	The current number of the custom filter.
	FILTERINDEX	The current index of the custom filter.
_filters.html _filtersnospam.html	PROCESSFILTERSLINK	A link where the form will be processed.
	USESPAM	If 'Enable SPAM Detection' is enabled, this becomes a HTML checked tag.
	SPAMPAIRDELE	If 'Delete Email' is set, this becomes a HTML checked tag.
	SPAMPAIRPLACEIN	If 'Place in Directory' is set, this becomes a HTML checked tag.
	SPAMPLACEINOPTIONLIST	A HTML option list of all the folders (used for the selection list).
	USEBLOCK	If 'Enable Block List' is enabled, this becomes a HTML checked tag.
	BLOCKOPTIONLIST	A HTML option list of all the email address in the block list.
	BLOCKPAIRDELE	If 'Delete Email' is set, this becomes a HTML checked tag.
	BLOCKPAIRPLACEIN	If 'Place in Directory' is set, this becomes a HTML checked tag.
	BLOCKPLACEINOPTIONLIST	A HTML option list of all the folders (used for the selection list).
	USEEXCLUSIVE	If 'Enable Exclusive List' is enabled, this becomes a HTML checked tag.
	EXCLUSIVEPAIRDELE	If 'Delete Email' is set, this becomes a HTML checked tag.
	EXCLUSIVEPAIRPLACEIN	If 'Place in Directory' is set, this becomes a HTML checked tag.
	EXCLUSIVEPLACEINOPTIONLIST	A HTML option list of all the folders (used for the selection list).
	FILTEROPTIONLIST	A HTML option list of all the custom filters.
_pop3retrs.html	PROCESSPOP3RETRSLINK	A link where the form will be processed.
_pop3retrs.html	POP3RETRSOPTIONLIST	A HTML option list of all the POP3 retrievals.
_pop3retr.html	PROCESSPOP3RETRLINK	A link where the form will be processed.
	ENABLED	If 'Enabled' is enabled, this becomes a HTML checked tag.
	HOST	The host field of the POP3 retrieval.
	PORT	The port field of the POP3 retrieval.
	USER	The user field of the POP3 retrieval.
	PASS	The password field of the POP3 retrieval.
	CONFIRMPASS	The password field of the POP3 retrieval.
	DELIVERDIROPTIONLIST	A HTML option list of all the folders (used for the selection list).
	SSLMODEOPTIONLIST	A HTML option list of all SSL modes.
	POP3RETRNO	The current number of the POP3 retrieval.
	POP3RETRINDEX	The current index of the POP3 retrieval.
_signup.html _nosignup.html	ADMINADDRESS	The admin's email address.
	DOMAINLIST	A HTML option list of all the domains allowed for automatic signups.
	COUNTRYOPTIONLIST	A HTML option list of countries.
_signuperror.html	ADMINADDRESS	The admin's email address.
_signuperror.html	ERRORDETAILS	The details of the error.

See Also: WebMail Settings, Tutorial: Using the WebMail Service.


©2008 Code-Crafters Software Ltd. All Rights Reserved. Privacy	Home Products Downloads Purchase Support Contact