WorldClient © 1999-2000 Alt-N Technologies. All Rights Reserved. |
|
WorldClient's INI File |
This section contains a list of the WorldClient.ini file sections, and descriptions of the various controls within each section. The file is located in WorldClient's base directory, and can be manually edited with any text editor. You can also edit them by using MDaemon's WebConfig web-based interface. See WebConfig Remote Configuration Server in the MDaemon User Manual for more information.
The configuration settings for both WorldClient and the WorldClient Administration Utility are stored in the WorldClient INI file. This section contains a list of the WorldClient.ini file sections, and descriptions of the various controls within each section. The file is located in WorldClient's base directory, and can be manually edited with any text editor, or by using the Remote Administration interface.
The WorldClient.ini file contains the following sections:
Directories - File paths to WorldClient's various directories.
WebServer - Contains settings specific to the WorldClient web server, which listens to WorldClient requests. Also contains settings related to performance and thread usage of the WorldClient web server.
General - Contains controls governing several of WorldClient's general settings.
Session - Here you will designate the maximum number of user sessions that can be active at the same time, and the maximum amount of time that a session can remain idle before it will expire.
Special - Contains any special or miscellaneous keys.
Version - This section contains version information regarding WorldClient's various components. You cannot edit these controls; they will be overwritten each time you start WorldClient.
SpellCheck - This section contains spell check options that are language dependent.
Directories
This section contains the file paths to WorldClient's various directories.
If your platform is Windows NT and you specify a path to a network shared
drive anywhere in WorldClient, you will need to change the WorldClient
Service from
a System Account to
a User Account with administrative privileges (Local System Account will
not provide access to these drives). For more information see: Services.
BaseDir - WorldClient's root directory. Default is [drive]:...\MDaemon\WorldClient
LogDir - The Log file directory. Default is [drive]:\...\MDaemon\Logs
TempDir - Directory to use when creating temporary directories/files. Default is [drive]:\...\MDaemon\WorldClient\Temp
UserDir - The directory where user subdirectories should be created. Default is [drive]:\...\MDaemon\WorldClient\Users
TemplateDir - WorldClient's templates directory. WorldClient's template files are stored here in individual Themes subdirectories. This is also the directory where the languages.ini file is stored. This file is used by WorldClient to replace English text in the Templates when an alternate language has been chosen. Default is [drive]:\...\MDaemon\WorldClient\Templates
SpellDir - WorldClient spell checker's base directory. Default is [drive]:\...\MDaemon\WorldClient\SpellCheck
MDaemonAppDir - This is the path to the directory containing MDUSER.DLL, which is used to synchronize WorldClient and MDaemon accounts. This key should be automatically created when synchronization is turned on in MDaemon.
WebServer
Contains settings specific to the WorldClient web server, which listens
to WorldClient requests.
Port - Server's port which will be listened to for requests. Defaults to 3000.
CgiDir - The path to the directory where CGI executables for WorldClient's web server are located and can be placed. Default is [drive]:\...\MDaemon\WorldClient\cgi-bin.
CgiAlias - What CGI requests start with. Default is /cgi-bin.
HtmlDir - Directory where HTML files and image files are located. Default is [drive]:\...\WorldClient\HTML.
DefHtmlFile - Default file to load in each directory if not specified. Default is index.html.
Auth - Encrypted authorization string for all web requests. The authorization string is of the format username:password, and the password value is case sensitive. Prefix this with a "-" and WorldClient will encrypt it for you the next time it is accessed. If blank, it doesn't require authorization.
LocalAuth - This setting governs whether or not authorization will be required when a request is made from the local computer (127.0.0.1). No = Don't ask for authorization, Yes = authorization required. Default is No.
CgiBase[1-50] - What the HTTP request starts with. (e.g. /WorldClient.cgi)
CgiFile[1-50] - The DLL or EXE to run when the CGI is requested. (e.g. c:\...\WorldClient.dll)
CgiAuth[1-50] - An authorization string (like the "Auth" key above), but only affecting this CGI. Authorization should either be per CGI, or for the entire web server, but not both.
General
This section of the WorldClient INI file contains controls governing several
of WorldClient's general settings.
LogLevel - A number (1 through 4) representing the log file verbosity. A lower number means more verbose. 1 = Most Verbose, 4 = Least Verbose.
MessageDateFormat - This control requires strftime formatting codes for displaying the date/time in the Message View. The default setting is: %x %X. For a list of the codes see: Date/Time Formatting Codes.
ListDateFormat - This control requires strftime formatting codes for displaying the date/time in the Message Listing. The default setting is: %m/%d %H:%M. For a list of the codes see: Date/Time Formatting Codes.
RedirectWait - This is the time interval (in seconds) that WorldClient will wait before refreshing the "Please Wait..." message that is displayed to users while their messages are being checked for and/or collected. This message will state which server it is connecting to and how many messages have been collected since it began downloading them. # = Number of seconds before refreshing.
EnableReplaceFrom - This control makes it possible for you to specify whether or not you want the From column to be replaced by the To column in your users' Drafts and Sent folders. By default it will be replaced. No = Off/No replace, Yes = On/Replace.
MaxInlineAttachSize - Maximum file size (in Kbytes) of text files that are shown inline along with the messages. Default is 20.
CaseSensitivePasswords - Controls whether or not the WorldClient sign-in passwords are case-sensitive. Yes = Passwords are case-sensitive, No = passwords are not case-sensitive. Default is Yes.
SendReadConfirmations - Determines whether or not WorldClient will send read confirmation messages in response to messages that request it. Yes = Reply to read confirmation requests, No = Do not reply to requests. Default is No.
GlobalAddrBookSortOrder - This key is used to designate the order by which Global Address Book entries will be sorted. Accepts: Name, RevName, EMail, RevEMail, Comment, RevComment, and User. The User value will cause the Global Address Book to be sorted by whichever column that the user's personal Address Book entries are being sorted. Default setting is Name.
VerboseSentConfirmation - When this key is set to "Yes", the "Message Sent" message will also display the contents of the "To:" and "Subject:" fields of the outgoing message. Yes = Include headers, No = Don't include.
CacheTemplates - This key governs whether or not WorldClient will cache its Template files. If you choose No in this control then the template files will be loaded from disk each time that WorldClient receives a request. The option to turn off template caching is useful when you are editing templates and want to review your changes without having to restart WorldClient to do so. It is recommended that you do not turn off template caching during normal operation as this can slow down server efficiency. Default is Yes.
Version
This section contains version information regarding WorldClient's various
components. You cannot edit these controls; they will be overwritten each
time you start WorldClient.
Session
Here you will designate the maximum number of user sessions that can be
active at the same time, and the maximum amount of time that a session
can remain idle before it will expire. This section also contains keys
that aid in session security.
Maximum - This is the maximum number of users that may be logged in to WorldClient at the same time (i.e. maximum active sessions). Default is 200.
ExpireTime - Time (in minutes) that an active session may remain idle before WorldClient will kill it. This is equivalent to WorldClient logging out the user. Composing messages can result in larger idle times, therefore whenever a user is in any of the Compose views, the ComposeExpireTime timer will apply rather than this one. Default is 20.
ComposeExpireTime - This is the amount of time (in minutes) that a user may remain in one of the Compose views before their session will expire. Default is 120. Note: If a user attempts to send a message after their session has timed out, the text will be saved as a Draft message that can be resumed after the user logs back in to WorldClient.
CheckCookie - When this key is set to "Yes", only session requests sending the correct cookie value for that session will be honored. The cookie is generated by the server when the session is created. If this check fails, the user trying to access WorldClient will be taken to the Logon screen. This aids in making sure that only the user who logged in to the session will be able to access it. Both this key and the CheckIP key that follows can greatly aid in securing your user's mail and access. Default is Yes. Default is Yes.
Warning! |
When CheckCookie is set to "Yes", users MUST have their web browser configured to allow cookies in order to be able to use WorldClient. This feature is recommended as it can aid greatly in assuring the security of your user's mail and access to the server. |
CheckIP - With this key set to "Yes", all session requests must come from the same IP that was used when the session was created. If this check fails, the user trying to access WorldClient will be taken to the Logon screen. This aids in making sure that only the user who logged in to the session will be able to access it. Both this key and the CheckCookie key above can greatly aid in securing your user's mail and access. Default is Yes.
SpellCheck
These INI options are comma separated lists of languages that the option
applies to.
SplitWords - Whether the spell check should attempt to break misspelled words into a series of shorter, correctly spelled words. Default is de.
SplitContractedWords - Whether the spell check should treat apostrophes as word separators and check each word separately. Default is fr,fc,it.
SuggestSplitWords - Whether the spell check should suggest two shorter words formed by splitting the misspelled word. Default is en.
NoAccentedCaps - Lists the language codes for certain languages which do not use accents in capital letters. For example, French uses accents while French Canadian does not. Therefore the spell checker will not treat French Canadian words as misspelled when the accents do not occur. Default=fc.
AddSingleWords - This key is for controlling whether users will be able to add words to their dictionary during the spell checking process. When it is set to Yes, there will be a plus sign next to each drop-down box that appears for misspelled or unknown words during spell checking. Clicking the plus sign will cause the unknown word to be added to the user's dictionary. When this control is set to No, they will be unable to add words from the spell check page. Default is Yes.
RelayFax
WorldClient/RelayFax integration is governed by the keys in this section.
UseRelayFax - When set to Yes, WorldClient integration with Alt-N Technologies' RelayFax server is enabled. The original setting of this key (Yes or No) is determined during WorldClient's installation. See WorldClient/RelayFax integration for more information.
FaxEmail - By default this key will not appear in the WorldClient.ini file unless you provided a specific email address during WorldClient installation. This is the email address to which WorldClient will deliver messages that are composed using the Compose Fax page, which is accessible when WorldClient/RelayFax integration is enabled. When this key isn't present in the [RelayFax] section of the INI file, WorldClient will deliver Compose Fax messages to your local RelayFax directly instead of using the email delivery method. If you add this key later it should be in the form: FaxEmail=mailbox@domain.
AppPath - By default this key will not appear in the WorldClient.ini file unless you provided it during WorldClient installation. When WorldClient/RelayFax integration is enabled, WorldClient will automatically determine the path to RelayFax when it is installed locally. However, if your RelayFax server is installed on another machine then this key can be used to supply the UNC file path to its \app\ directory. If you add this key later it should be in the form: AppPath=\\machine\path. For more information see WorldClient/RelayFax integration.
Note |
WorldClient/RelayFax integration will use information that is found in the RelayFax.ini file located in RelayFax's \app\ directory. When a UNC file path is used in the AppPath key then you must use UNC file paths in the [Directories] section of the RelayFax.ini file as well. If UNC paths are not used in that section then WorldClient will behave as if the paths refer to its own machine rather than the one on which RelayFax is installed. Using a UNC path to point to a local directory is permitted and will not hinder RelayFax's operation in any way. |
Special
Contains any special or miscellaneous keys.
SendMessageAttachmentsAsText - When set to Yes, WorldClient will send files of content-type "message/rfc822" as "text/plain" instead. This is necessary due to certain browser incompatibilities resulting from messages with "message/rfc822" attachments. Default is Yes.
UseCookies - Controls whether WorldClient will set and use cookies for certain functions. No=do not use cookies. Default is Yes.