4
Oracle Webmail

This chapter discusses Oracle Webmail.

This chapter contains the following topics:

Overview

Oracle Webmail gives users a simple and fast means to access messages and other self-service features through a web browser. A user points his browser to a predetermined URL to log in to his e-mail account and sees the inbox rendered dynamically.

All programs execute in the Oracle9i Application Server, including the logic to render a user's folders, messages, public directory and personal address book. There is no processing or data storage on the desktop. The browser acts merely as a keyboard and screen.

Oracle Webmail provides a standard, out of the box web mail solution, along with a tool kit that can extend and modify this standard solution.

Tool Kit Default Settings

State File

The state file contains XML defining the navigation behavior of the Oracle Webmail client. This file facilitates defining state transitions in the client, when the user moves from one state to another, and managing the end state to present to the user.

The location of the state file for the Oracle Webmail client is determined by the toolkit.statefile property:

toolkit.statefile=%ORACLE_HOME%/um/client/config/statefile.xml

Note:

Percent symbols (%) in the oc4j.properties file are substituted to reflect the real directory path during installation.

The toolkit.statefile property is set in the $ORACLE_HOME/j2ee/OC4J_UM/config/oc4j.properties file.

Oracle Webmail Client Properties

Table 4-1 describes the Oracle Webmail client properties in alphabetical order. Values given for the properties indicated for database and LDAP connection pooling while using OJMA, and for database connection pool parameters, are just examples and should actually be determined based on the number of users, and system load.

To edit these properties, change their values in the oc4j.properties file.

Table 4-1 Oracle Webmail Client Properties

Property	Description	Acceptable Values	Default Value
client.image.corporate	URLs to use to customize corporate brand with Oracle Collaboration Suite	Any URL that points to an image	`/um/images/branding_collaborationsuite.gif`
client.image.product	URLs to use to customize corporate brand with Oracle	Any URL that points to an image	`/um/images/corporateBrand_oracle.gif`
client.corporate.url	Destination for the corporate logo link:	Any URL that points to a corporate url	`/um/traffic_cop`
client.esdsconnpoolparam. incrementsize	Number of connections to add to the esds client connection pool	Any integer	`1`
client.esdsconnpoolparam. initialsize	Initial number of connections in the esds client connection pool	Any integer	`5`
client.esdsconnpoolparam. maxsize	Maximum number of connections in the esds client connection pool	Any integer	`10`
client.esdsconnpoolparam. minsize	Minimum number of connections in the esds client connection pool	Any integer	`5`
client.esdsconnpoolparam. shrinkingtimeoutinterval	Time delay before esds client connection pool can be shrunk	Any integer	`1800`
client.esdsconnpoolparam. timeoutinterval	Maximum number of seconds the esds client waits for a free connection in the pool. If no connections are released back to the pool within that time, the directory server code throws an exception.	Any integer	`30`
client.ldapsearch.maxresu lt	Maximum number of results returned from an LDAP search. End users whose searches return more matches than this are notified that additional results exist, but that only this maximum number are shown.	Any integer	`500`
client.mail.defaultsort	If `TRUE`, the Oracle Webmail client automatically sorts by the default sort field and order, when user first logs in. The default sort field and order are set in the `MailAppConstants` parameter.	`TRUE` or `FALSE`	`TRUE`
client.mail.enforcenested HTMLfonts	If `TRUE`, original fonts are to be used for HTML.	`TRUE` or `FALSE`	`FALSE`
client.mail.messagetransp ort	If SMTP, messages are sent through the SMTP server; DATABASE uses direct database interaction.	`SMTP` or `database`	`SMTP`
client.mail.translate.INB OX=true	If `TRUE`, the INBOX folder is auto-translated to the user's locale. If `FALSE`, the INBOX is displayed in English.	`TRUE` or `FALSE`	`TRUE`
client.message.charset.de fault	Default character set to use for outgoing messages	Any valid character set
client.portal.url	Destination for the default portal icon link: Default is `http://www.oracle.com`	Any valid URL	`http://www.oracle.com`
client.privacystatement.u rl	Destination for the privacy statement link: Default is `http://www.oracle.com`	Any valid URL	`http://www.oracle.com`
client.product.url	Destination for the product logo link: Default is `/um/traffic_cop`		`/um/traffic_cop`
jdbc.connection.debug	If `TRUE`, enables debugging JDBC connections.	`TRUE` or `FALSE`	`FALSE`
mail.debug	If `TRUE`, enables debugging OJMA API for Oracle Email.	`TRUE` or `FALSE`	`FALSE`
mail.host.qualifiedname	Domain to add to non-qualified address recipients. If this is not set, then the user's domain is used.	Any valid domain	None
mail.imap.host	Form for installation time substitution of variables		`%machinehost%`
mail.imap.port	Port used when `toolkit.mailstore=IMAP`; the IMAP port number	Any valid IMAP port number	`143`
mail.smtp.host	Host used for sending messages through SMTP when `client.mail.messagetransport` is not set to database. This host machine is running the SMTP server.	Any valid SMTP host machine	`%machinehost%`
mail.smtp.port	Port used for sending messages through SMTP when `client.mail.messagetransport` is not set to database. This port is on the machine running the SMTP server.	Any valid SMTP port number	`25`
MaxTelephonePinDigits	Maximum number of digits in voice mail PINs	Any integer	`12`
MinTelephonePinDigits	Minimum number of digits in voice mail PINs	Any integer	`7`
oracle.mail.admin.ldapDeb ug	Enables debugging for the administration ESDS API	`TRUE` or `FALSE`	`FALSE`
oracle.mail.admin.ui.ojma Debug	Enables debugging for the administration OJMA API	`TRUE` or `FALSE`	`FALSE`
oracle.mail.portlet.https ToWebmail	Indicates if the Oracle Webmail title link is `http` or `https`.	`TRUE` or `FALSE`	`FALSE`
oracle.mail.client.prefs. autoreply	Enables access to auto reply features and options. If TRUE, enables auto reply functions for end users	`TRUE` or `FALSE`	`TRUE`
oracle.mail.client.prefs. autoreply.echo	Every incoming message receives an auto reply with the original message copied. Requires `oracle.mail.client.prefs.autoreply` to be enabled. If TRUE, enables auto reply functions for end users	`TRUE` or `FALSE`	`TRUE`
oracle.mail.client.prefs. autoreply.reject	Enables the user to select the reject option in the UI. With the reject option enabled, the server rejects all incoming messages Requires `oracle.mail.client.prefs.autoreply` to be enabled. If `TRUE`, enables auto reply functions for end users.	`TRUE` or `FALSE`	`TRUE`
oracle.mail.client.prefs. autoreply.reply	Enables the reply option in the UI. With the reply option enabled, every sender receives one auto reply regardless the amount of messages sent by that sender. Requires `oracle.mail.client. prefs.autoreply` to be enabled. If `TRUE`, enables auto reply functions for end users	`TRUE` or `FALSE`	`TRUE`
oracle.mail.client.prefs. autoreply.vacation	Enables the vacation option in the UI. With the vacation option enabled, every incoming message receives an auto reply with the original message copied. Requires `oracle.mail.client.prefs.autoreply` to be enabled. If `TRUE`, enables auto reply functions for end users.	`TRUE` or `FALSE`	`TRUE`
oracle.mail.ldap.reconnec time	The amount of time in seconds the server waits to reconnect to the LDAP server if it is unavailable. If set to 0, the server connects immediately. If the value is not set, the reconnect time is the same as the timeout value
oracle.mail.ldap.connects sl	If set to `TRUE`, enables clients to use SSL connections to Oracle Internet Directory
oracle.mail.sdk.esmail.ca che_inactivity_timeout	Number of seconds to wait for a connection before the esds client connection pool times out	Any integer values OJMA connection pool settings	`300`
oracle.mail.sdk.esmail.ca che_scheme	Determines the cache scheme of the database connection pool DYNAMIC dynamically increases or shrinks the pool size based on the system load. FIXED WAIT waits for a specified period if a connection is not available. FIXED-NO-WAIT returns null if a connection is not available in the pool. For more details, refer to the Oracle JDBC Developer Guide.	1 = DYNAMIC 2 = FIXED WAIT 3 = FIXED NO WAIT Use `1` or `3` for best results	1
oracle.mail.sdk.esmail.co nnpool_max_limit	Maximum number of connections in the Oracle mail sdk esmail connection pool	Any integer values OJMA connection pool settings	`10`
oracle.mail.sdk.esmail.co nnpool_min_limit	Determines the initial or minimum number of connections created in the connection pool Oracle recommends keeping this limit as low as possible to avoid holding on to unused database connections.	Depends on the number of users, system load, etc.	1
oracle.mail.sdk.esmail.dr iver_type	Determines the type of jdbc driver to be used for the database connection pool	oci8, thin (recommended in non-RAC)	oci8
oracle.mail.sdk.esmail.en cryption	Disables password encryption, which is mandatory in Oracle Collaboration Suite, Release 2. Can be disabled for more performance.	`FALSE or TRUE`	`TRUE`
oracle.mail.sdk.esmail.ld ap_debug	If TRUE, enables debugging OJMA API for LDAP.	`TRUE` or `FALSE`	`TRUE`
oracle.mail.sdk.esmail.oj ma_debug	Controls the debug output from the ojma layer	`FALSE` or `TRUE`	`FALSE`
toolkit.clientdir	Directory under `$ORACLE_HOME/j2ee/OC4J_UM/applications/UMClientApp/um_client` where the UIX pages reside: Default is `/templates/`	Any valid path under `$OH/j2ee/OC4J_UM/applications/UMClientApp/um_client` where the UIX pages reside	`/templates/`
toolkit.controller.url	URL for accessing the client framework controller: Default is `/um/traffic_cop`	A valid URL that accesses the client framework controller	`/um/traffic_cop`
toolkit.debugmode	Debugging mode for the Oracle Webmail client	`TRUE` or `FALSE`	`FALSE`
toolkit.helpdir	Relative URL path for the image, javascript, and online help files: Default is `/um/help/`	Any valid path to directories containing the associated files	`/um/help/`
toolkit.imagedir	Relative URL path for the image, javascript, and online help files: Default is `/um/images/`	Any valid path to directories containing the associated files	`/um/images/`
toolkit.jslibdir	Relative URL path for the image, javascript, and online help files: Default is `/um/scripts/`	Any valid path to directories containing the associated files	`/um/scripts/`
toolkit.logdirectory	File path location of the Oracle Webmail client log files: Default is `%ORACLE_HOME%/um/log`	A valid file path containing the log files	`%ORACLE_HOME%/um/log`
toolkit.logfilename	Name for the Oracle Webmail client log file		`Webmail_Client`
toolkit.loghostclient	Name for the Oracle Webmail Client host		`%machinehost%`
toolkit.loglevel	Logging level of the Oracle Webmail client, from the five choices shown	internalerror `warning notification trace error`	`error`
toolkit.mail.listsubscrib edfoldersonly	If `TRUE`, only subscribed folders are displayed.	`TRUE` or `FALSE`	`FALSE`
toolkit.pagesuffix	Type of suffix to append when going to targets in `statefile.xml`		`.uix`
toolkit.servlet.version	Differentiates how the servlet is forwarded to the UIX pages: should be set to `2.1` or higher. If set to `<= 2.0` it reverts back to servlet.	Any servlet version	`2.2`
toolkit.statefile	Location and name of the statefile: `%ORACLE_HOME%/um/client/ config/statefile.xml` is the default. `%ORACLE_HOME%` is translated to the real path in the `oc4j.properties` file. All values containing the percent symbol (`%`) are substituted to prevent the `oc4j.properties` file from containing variables	Any valid file path to a file that contains the statefile definitions	`%ORACLE_HOME%/um/client/config/statefile.xml`

Oracle Webmail LDAP Properties

The LDAP properties in Table 4-2 apply to all LDAP servers for search:

Table 4-2 LDAP properties for all LDAP servers

Property	Description
toolkit.ldap.pool.timeo ut=1000	The number of milliseconds that an idle connection can remain in the pool without being closed and removed from the pool
toolkit.ldap.pool.inits ize=5	Initial size for a directory service connection pool.
toolkit.ldap.pool.prefs ize=5	Preferred size for a directory service connection pool.
toolkit.ldap.pool.maxsi ze=10	Maximum size for a directory service connection pool.
toolkit.ldap.search.tim eout=2000	Length of time in milliseconds a directory service search times out.
toolkit.ldap.results.ma xsize=200	Limits the maximum size for Directory Service search results.
toolkit.ldap.dir.total= 1	Number of LDAP directory services. Use 0 if none is available.

The LDAP properties in Table 4-3 are contained in each LDAP server:

Table 4-3 LDAP properties contained in each LDAP server

Property	Description
toolkit.ldap.dir.1.labe l=Corporate Directory	Text string to display for the directory service. The text string is "Corporate Directory," it is translated to the user's locale.
toolkit.ldap.dir.1.url= ldap:enter_your_host_ here:389	Directory service host name and port number. The format is ldap://`host:port`. By default, LDAP servers listen on port 389.
toolkit.ldap.dir.1.sear chbase=dc=your_ subdomain,dc=your_ domain	Search base for the directory service. Change this value to reflect the search base for the directory service.
toolkit.ldap.dir.1.user name=enter_username_ here toolkit.ldap.dir.1.pass word=enter_password_ here	Sets the user name and password. Uncomment this to set the user name and password for a directory service that requires access control. All users using the Oracle Webmail must access the directory service using this name and password.

Searching Multiple Directories

Create records for each directory to list and search multiple directories in the client. Each subsequent directory service must have a unique ordinal. For example, the second directory service should be toolkit.ldap.dir.2.

Example

toolkit.ldap.dir.2.label=Acme Directory
toolkit.ldap.dir.2.url=ldap://ldap.acme.com:389
toolkit.ldap.dir.2.searchbase=c=US

Set the following two values:

toolkit.ldap.dir.2.username=enter_username_here
toolkit.ldap.dir.2.password=enter_password_here

Oracle Webmail Client Log Files Location

Table 4-4 provides the Oracle Webmail client log files location.

Table 4-4 Oracle Webmail Client Log Files Location

UNIX Windows

UNIX	Windows
Default: `$ORACLE_HOME/um/log/Webmail_Client` Oracle Webmail logging is configured by properties in `oc4j.properties` for the `OC4J_UM` application. Where: `toolkit.loghostclient` maps to a field in the log files to indicate what machine generated the log file. `toolkit.logleve`l indicates the amount of logging to do, and can be set to one of the following values; internalerror, error, warning, notification, trace. `toolkit.debugmode` controls whether or not debug info is logged for use of the ESDS API by the Oracle Webmail client code.	n/a

Default: $ORACLE_HOME/um/log/Webmail_Client

Oracle Webmail logging is configured by properties in oc4j.properties for the OC4J_UM application.

Where:

toolkit.loghostclient maps to a field in the log files to indicate what machine generated the log file.

toolkit.loglevel indicates the amount of logging to do, and can be set to one of the following values; internalerror, error, warning, notification, trace.

toolkit.debugmode controls whether or not debug info is logged for use of the ESDS API by the Oracle Webmail client code.

n/a