Chapter 1   Introduction to Messenger Express and Customization


iPlanet Messenger Express is a web-based electronic mail program that enables end users to access their mailboxes using a browser. Messenger Express clients send mail to a specialized web server that is part of iPlanet Messaging Server. The HTTP service then sends the message to the local Message Transfer Agent (MTA) or to a remote MTA for routing or delivery.

Almost all features of Messenger Express are fully customizable. This guide explains the features that are customizable. Most features can also be customized easily during an upgrade.

This chapter contains the following sections:

• Messenger Express Customization Overview

• Messenger Express Localization

• Basic Interfaces and Associated Functions

Messenger Express Customization Overview

---

iPlanet Messenger Express lets you rewrite the "static" portion of the pages served by the Messenger Express HTTP daemon to produce a fully customized webmail service. Messenger Express supports both JavaScript and HTML in implementing customization schemes.

Messenger Express Components

iPlanet Messenger Express consists of two components, the client and the server. The client reads and interprets the JavaScript language. The HTTP server understands proprietary protocols that communicate with Messenger Express. The JavaScript files reside on the server and are downloaded to the client. The client extracts data from the JavaScript code to customize Messenger Express functions. All modifications and customizations are done on the server.

HTML files contain both text and markup describing how the text is formatted and handled. Markup is implemented through a set of tags, which specify things like headers, indents, font size, italics and so on. These are largely static tags that deal exclusively with text within the HTML file on the client. However, the HTML also contains dynamic tags, such as JavaScript embedded in the client file, that point to files and functions on the server. The dynamic tags enable the HTML file client to pull in data processed on the server for use in otherwise static Web pages.

HTML files provide the skeleton structure of each of the interfaces, whereas JavaScript files give the specific attributes. Each of the JavaScript main functions are contained within an HTML parent functions. There are also differentiations within the JavaScript files themselves. The file main.js primarily controls the layout of the interfaces, whereas the file i18n.js controls the text. The i18n.js file also can be localized to fit the language of many regions in the world.

The HTML files are the parent functions that call the main functions in the JavaScript files to initiate actions.

Location of Customizable Files

The Messenger Express JavaScript and HTML files that can be customized reside in the server-root/html directory, where server-root represents the directory path in which you install the Messaging Server software. The server needs to be restarted for any changes in the HTML and JavaScript files to take effect.

lists the files to be edited to customize Messenger Express, and which part of Messenger Express each file controls.

Table 1-1    Messenger Express Customizable Files 

Files	What the File Controls in Messenger Express
main.js	Layout of the UI
lang/i18n.js	Text on the UI
mbox_fs.html	Mailbox management portion of the UI
msg_fs.html	Message management portion of the UI
fldr_fs.html	Folder management portion of the UI
opts_fs.html	Option management portion of the UI
comp_fs.html	Message composition
lang/default.html	Login screen
lookup_fs.html	Address search
attach_fs.html	Attachments
collect_fs.html	Collection of mail from another server
receipt_fs.html	Return receipt
subscribe_fs.html	Subscribe Folders
emoticons.html	Alter emoticons

Messenger Express Localization

---

You can localize any feature of iPlanet Messenger Express. You can create different pages for different languages. When you create language-specific static webmail pages, you group them in subdirectories under the main document directory. The webmail code automatically detects the client's language preference and fetches the webmail pages from the appropriate subdirectory.

When you change common sections of the static webmail pages, you must make the changes on multiple occasions if modifications (for example, to JavaScript behavior) are desired across languages. Conversely, you can make language-specific modifications selectively throughout the application.

Specific Locales

Table 1-2 lists the specific locales (and their abbreviations) that Messenger Express services. The protocol's default language is English.

Table 1-2    Messenger Express Specific Locales  

Locale	Abbreviation
English	en
Japanese	ja
Spanish	es
French	fr
German	de

Location of Locale-Specific Customizable Files

The localized Messenger Express JavaScript and HTML files reside in the server-root/html/locale_specific directory, where server-root represents the directory path in which the Messaging Server software is installed.

Basic Interfaces and Associated Functions

---

This section presents the functions associated with various Messenger Express screens, including:

• Inbox screen

• Message screen

• Folders screen

• Options screen

• Composition window

• Message search window

Tables list the functions associated with each button on Messenger Express screens.

The files containing the functions reside in the server-root/html directory, where server-root represents the directory path in which the Message Server software is installed.

Inbox Screen

The Messenger Express inbox screen, shown in Figure 1-1, enables you to view all messages and its basic features— for example, subject, from, received and size. The inbox screen gets new messages and enables you to search for or delete old messages, as well as move messages into other folders.

Figure 1-1    Messenger Express Inbox Screen

Inbox Screen Functions

Table 1-3 lists the functions needed to customize the inbox screen, including main functions (found in main.js) and parent functions (found in mbox_fs.html).

Table 1-3    Inbox Screen Functions  

Item	Function
Folders	main.displayFolders()
Inbox	main.displaySpecialMbox('Inbox')
Sent Mail	main.displaySpecialMbox('Sent')
Trash	main.displaySpecialMbox('Trash')
Drafts	main.displaySpecialMbox('Drafts')
Addresses	main.displayPab()
Options	main.selectOptions()
Help	main.help()
Logout	main.logout()
Get Mail	main.check_mail = 1; main.displaySpecialMbox('Inbox')
Compose	main.compose('new')
Search	parent.srch()
Move Messages to Folder	parent.move()
Delete and Undelete	parent.delmsg()
Collect External Mail	main.collect()

Message Screen

The Messenger Express message screen, shown in Figure 1-2, displays the message selected from the inbox screen. The message screen gives the option of replying to the sender(s), forwarding the message, moving the message to a different folder, or deleting the message. The message screen also enables navigation to the next or previous message.

Figure 1-2    Messenger Express Message Screen

Message Screen Functions

Table 1-4 lists the functions needed to customize the message screen, including main functions (found in main.js) and parent functions (found in msg_fs.html).

Table 1-4    Message Screen Functions

Item	Function
Compose	main.compose('new')
Reply	main.compose('reply')
Reply All	main.compose('replyall')
Forward	main.compose('forward')
Delete and Undelete	parent.delmsg()
Add Addresses	parent.addAllAddresses()
Previous	parent.prev()
Next	parent.next()
Close	parent.gotofolder()

Folders Screen

The Messenger Express Folders screen, shown in Figure 1-3, displays all folders that can be accessed. The Folders screen lists the number of messages contained and the size of each folder. The Folders screen also enables creating new folders, renaming or deleting old ones, subscribing or unsubscribing shared folder, sharing folder, moving a folder within another folder, updating the inbox, and composing new messages. Like the Inbox screen, the Folders screen also enables collection of external mails.

Figure 1-3    Messenger Express Folders Screen

Folders Screen Functions

Table 1-5 lists the functions needed to customize the folders screen, including main functions (found in main.js) and parent functions (found in fldr_fs.html).

Table 1-5    Folders Screen Functions  

Item	Function
Update	main.refreshFolders()
Compose	main.compose('new')
New	parent.addFolder()
Rename	parent.renFolder()
Share	parent.setfolder()
Delete	parent.delFolder()
Subscribe	main.subscribeFolder()
Unsubscribe	main.unsubscribeFolder()
Move Folder	parent.moveFolder(options[selectedIndex].value)

Options Screen

The Messenger Express Options screen, shown in Figure 1-4, enables access to the subscriber's account summary, personal information, password, settings, appearance, vacation message, and delegated administrator, all of which can be customized.

Figure 1-4    Messenger Express Options Screen

Options Screen Functions

Table 1-6 lists the parent. functions (found in opts_fs.html) needed to customize the options screen.

Table 1-6    Options Screen Functions  

Item	Function
Account Summary	parent.toggle('summary')
Personal Information	parent.toggle('personal')
Password	parent.toggle('password')
Settings	parent.toggle('settings')
Appearance	parent.toggle('appearance')
Vacation Message	parent.toggle('vacation')
Delegated Administrator	parent.toggle('NDA')

Composition Window

The Messenger Express composition window, shown in Figure 1-5, is used primarily to compose a new message. You can also use the window to save a draft or attach a file to the message, look up a recipient in the address book, access the help file, and cancel the composition altogether. Mail recipients can be added in "To", "Cc", or "Bcc" fields. You can edit the message in Text or HTML format and also check the spelling. The composition window also enables you to set the mail priority or request for a return receipt.

Figure 1-5    Messenger Express Composition Window

Composition Window Functions

Table 1-7 lists the functions needed to customize the composition window, including main functions (found in main.js) and parent functions (found in comp_fs.html).

Table 1-7    Composition Window Functions  

Item	Function
Send	parent.send('smtp')
Address	parent.lookup()
Attach	main.attach()
Save Draft	parent.send('draft')
Spell Check	parent.spellck()
Help	main.help(1007399)
Cancel	parent.cancel()
To/Cc/Bcc	parent.lookup()
Text/HTML	parent.switchEditor()

Message Search Window

---

The Messenger Express message search window, shown in Figure 1-6, is primarily used to search messages by entering sender's name, subject, body text, or recepient's name. You can also delete the messages from the search list.

Figure 1-6    Messeage Search Window