VISUALMAIL 3 - Appendix A

HTX Commands reference

Global Commands

<% UserName %>

Prints the username of the current logged in user.

<% UserFullName %>

Prints the Full Name of the current logged in user.

<% UserCompany %>

Prints the Company name of the current logged in user.

<% UserEMail %>

Prints the e-mail address of the current logged in user.

<% DefaultDomain %>

Default domain name specified in visualmail.conf

<% LicenseName %>

Prints the licensed to name specified in visualmail.conf

<% AutoLogout %>

Automatic Logout time specified in visualmail.conf

<% StartForm %>

Starts a HTML form.

<% EndForm %>

Ends a HTML form.

<% HiddenVar %>

Prints all the hidden vars needed by VisualMail.

<% Goto Compose %>

Prints the Object-ID of the compose screen.

<% Goto Inbox %>

Prints the Object-ID of the Inbox screen.

<% Goto Address %>

Prints the Object-ID of the Address Book screen.

<% Goto Config %>

Prints the Object-ID of the configuration screen.

<% Goto Folder %>

Prints the Object-ID of the Folder screen.

<% Goto Logout %>

Prints the Object-ID of the Logout screen.

<% Goto Accept %>

Prints the Object-ID of the Accept command.

<% If HaveNoFrames %>

If the user is accessing VisualMail without frames, the HTX is parsed until an <% else %> or an <% end if %> is found.

error.htx commands

<% ErrorMsg %>

Prints the error message.

login.htx commands

<% LoginBox = x, y %>

Prints the Login text box, with x chars of length and y characters of max length.

<% PassBox = x, y %>

Prints the Password text box, with x chars of length and y characters of max length.

<% FramesCheck %>

Prints the select frames option check.

<% NoFramesCheck %>

Prints the select no frames option check.

index.htx commands

<% Goto OptionBar %>

Prints the Object-ID of the Option Bar screen.

<% Goto InboxNoFrm %>

Prints the Object-ID of the Inbox screen without frames support.

inbox.htx commands

<% If HaveMail %>

If the user has mail, the HTX is parsed until an <% else %> or an <% endif %> is found.

<% If HaveAttach %>

If a message has an attach, the HTX is parsed until an <% else %> or an <% endif %> is found.

<% If Urgent %>

If a message is urgent, the HTX is parsed until an <% else %> or an <% endif %> is found.

<% While GetMail %>

The HTX is parsed until the <% while end %> command is found while the user has mails.

<% Goto SortByName %>

Prints the Object-ID of the Sort by Name command.

<% Goto SortBySubj %>

Prints the Object-ID of the Sort by Subject command.

<% Goto SortBySize %>

Prints the Object-ID of the Sort by Size command.

<% Goto SortByDate %>

Prints the Object-ID of the Sort by Date command.

<% Goto MsgCheck %>

Prints the CheckBox used to select a message.

<% Goto CheckMail %>

Prints the Object-ID of the Check Mail command.

This command only works in the enterprise version.

<% MsgFrom %>

Prints the sender name of the message.

<% MsgSubject %>

Prints the Subject of the message.

<% MsgSize %>

Prints the message’s Size.

<% MsgDate %>

Prints the message’s sent date.

<% DFolderList = x %>

Prints the destination folders list with x lines of size.

This command only works in the enterprise version.

<% CurrentPage %>

Prints the current page number.

<% MaxPage %>

Prints the max page number.

<% FolderList = x %>

Prints the folders list, with x lines of size.

This command only works in the enterprise version.

<% ServerList = x %>

Prints the server list, with x lines of size.

This command only works in the standard version.

<% CurrentFolder %>

Prints the current folder name.

This command only works in the enterprise version.

<% CurrentServer %>

Prints the current server name.

This command only works in the standard version.

viewmsg.htx commands

<% Goto Reply %>

Prints the Object-ID of the Message Reply Command.

<% Goto ReplyAll %>

Prints the Object-ID of the Message Reply All Command.

<% Goto Forward %>

Prints the Object-ID of the Message Forward Command.

<% Goto Delete %>

Prints the Object-ID of the Message Delete Command.

<% Goto Address %>

Prints the Object-ID of the Add to Address Book command.

<% MsgFrom %>

Prints the sender of the message.

<% MsgTo %>

Prints the recipients of the message.

<% MsgCc %>

Prints the carbon copy recipients of the message.

<% MsgSubject %>

Prints the subject of the message.

<% MsgDate %>

Prints the sent date of the message.

<% MsgBody %>

Prints the body of the message.

<% If HaveAttach %>

If a message has attachments, the HTX is parsed until an <% else %> or an

<% endif %> is found.

<% While GetAttach %>

The HTX is parsed until the <% while end %> command is found while the message has attachments.

<% MsgAttach %>

Prints the Object-ID of the attachment.

options.htx commands

<% Goto FilterConf %>

Prints the Object-ID of the Filters Configuration screen.

This command only works in the enterprise version.

<% Goto SignConf %>

Prints the Object-ID of the Signature Configuration screen.

<% Goto PersonalConf %>

Prints the Object-ID of the Personal Configuration screen.

<% Goto AdvancedConf %>

Prints the Object-ID of the Advanced Configuration screen.

filterconf.htx commands

<% ItemNumber %>

Prints the filter number.

<% StatusCheck %>

Prints the filter status check box.

<% WhereList = x %>

Prints the list of "where to find the string" with x lines of size.

<% ConditionList = x %>

Prints the list of conditions to match with x lines of size.

<% MatchString = x, y %>

Prints the match string text box with x chars of size and a max length of y chars.

<% FolderList = x %>

Prints the list of folders with x lines of size.

<% While GetFilter %>

The HTX is parsed until the <% while end %> command is found while the message has filters to show.

persconf.htx commands

<% FullNameBox = x, y %>

Prints the Full Name text box with x chars of length and y chars of max length.

<% EMailBox = x, y %>

Prints the E-Mail text box with x chars of length and y chars of max length.

<% CompanyBox = x, y %>

Prints the Company Name text box with x chars of length and y chars of max length.

<% PageSizeBox = x, y %>

Prints the Page Size text box with x chars of length and y chars of max length.

signconf.htx commands

<% SignBox = x, y %>

Prints a signature text area with x rows and y columns.

servconf.htx commands

<% StatusCheck %>

Prints the server status check box.

<% ItemNumber %>

Prints the server number.

<% LoginBox = x, y %>

Prints the login name text box with x chars of length and y chars of maxlength.

<% PassBox = x, y %>

Prints the login pass text box with x chars of length and y chars of maxlength.

<% ServerBox = x, y %>

Prints the server text box with x chars of length and y chars of maxlength.

<% PortBox = x, y %>

Prints the port text box with x chars of length and y chars of maxlength.

<% Pop3Check %>

Prints the POP3 server option box.

<% ImapCheck %>

Prints the IMAP server option box.

<% LeaveMailCheck %>

Prints the Leave Mail on Server check box.

This command only works in the enterprise version.

<% While GetServer %>

The HTX is parsed until the <% while end %> command is found while the message has servers to show.

address.htx commands

<% Goto Cancel %>

Prints the Object-ID of the Cancel command.

<% AddressList = x %>

Prints the list of addresses with x lines of size.

<% FullNameBox = x, y %>

Prints the full name text box with x chars of length and y chars of maxlength.

<% EMailBox = x, y %>

Prints the E-Mail box with x chars of length and y chars of length.

<% If Modify %>

If the user is in modify mode, the HTX is parsed until an <% else %> or an <% endif %> is found.

folder.htx commands

<% Goto Cancel %>

Prints the Object-ID of the Cancel command.

<% FolderList = x %>

Prints the list of folders with x lines of size.

<% FolderBox = x, y %>

Prints the folder text box with x chars of length and y chars of maxlength.

<% If Modify %>

If the user is in modify mode, the HTX is parsed until an <% else %> or an <% endif %> is found.

compose.htx commands

<% MsgTo = x, y %>

Prints the Message To text box with x chars of length and y chars of maxlength.

<% MsgCc = x, y %>

Prints the Message Cc text box with x chars of length and y chars of maxlength.

<% MsgBcc = x, y %>

Prints the Message Bcc text box with x chars of length and y chars of maxlength.

<% MsgSubject = x, y %>

Prints the Message Subject text box with x chars of length and y chars of maxlength.

<% MsgFiles = x, y %>

Prints the Attachments text box with x chars of length and y chars of maxlength.

<% PriorityLevel = x %>

Prints the priority levels list with x lines of size.

<% AddressList = x %>

Prints the Address List with x lines of size.

<% MsgBody = x, y %>

Prints the Message Body text area with x rows and y columns.

<% AttachBox = x %>

Prints the Attach text box with x chars of length.

<% SignCheck %>

Prints the Add Signature check box.

<% AddSentCheck %>

Prints the Add to sent items check box.

This command only works in the enterprise version.