Installation and Setup

The following is the list of available ini settings that may be setup in your ini file. This ini file should be located in the same directory as the cgi.

General configuration settings are stored in WebMail.ini which must be in the same directory and have the same root name as the executable. So if the cgi is renamed xmail.cgi then the configuration file will be xmail.ini

Label	Example	Default	Explanation
@imap	true	false	Allows user to enter mail host by using user@imaphost in the username field in login.tpl. Without this setting user@mailhost would be passed to the mail server as a username. (overrides @pop setting)
@pop	true	false	Allows user to enter pop host by using user@pophost in the username field in login.tpl. Without this setting user@pophost would be passed to the pop server as a username.
allow_$	var1,var2	none	A comma seperated variable that allows other ini settings to allow $(...) variable replacement.
allow_dot	true	false	This will allow folders that start with a '.' to be displayed.
allow_fld_spaces	true	false	When set to true will allow spaces to be created in folder names.
allow_form	true	false	This will allow Forms to be ignored when viewing an HTML attachment.
allow_form	true	false	This will allow Forms to be ignored when viewing an HTML attachment.
allow_host_login	1.2.3.4	(none)	This setting is used to limit which hosts the users can login to WebMail with. It is possible to setup more than 1 host to allow by just added another line to the ini file. allow_host_login 1.2.3.4 allow_host_login 2.*.3.4
allow_java	true	false	This will allow Javaapplets to be ignored when viewing an HTML attachment.
allow_script	true	false	This will allow Scripts to be ignored when viewing an HTML attachment.
allow_style	true	false	This will allow <style> tags to be ignored when viewing an HTML attachment.
always_attach	true	false	This will force WebMail to always display the 'attachment' list in the item.tpl. Otherwise the list will only apear when inline images are turned off.
attach_target	target="_blank"	none	Which allows you to set up a target for all attachments.
authen_using_spaces	true	false	This will convert underscores to spaces during authentication. This was added as Exchange servers allow usernames to have spaces when authenticating only. NOTE: Setting this will mean that no underscores can be used in usernames.
authent_cookie	true	false	This will allow autologin via cookies.
auto_delete	lynden* 0 @temp 1 30	none	This setting is used to determine when accounts will be automatically used if not logged in for x number of days. You are allowed multiple settings. When set to 0 days then this account will never be removed.
auto_create_folders	Trash_Can,Sent,Drafts	none	This will automatically create these folders for any new users.
auto_logout_mins	200	60	Time since last activity for logged in user before cache of new mail messages is purged
background	this.gif	background.gif	This is the default background that is used in the templates.
bind_sockets	1.2.3.4:0	none	This will force all outgoing sockets to bind to a selected IP number. Only used if the machine has mutiple IP's and you want to make sure that the CGI when talking to the Mail server, looks like that it is comming from 1 address.
body_add	http://xxx.yyy.zzz	blank	Adds the line given to the body of all outgoing EMail messages. You can have multiple body_add lines to produce a multi-line addition. To add blank lines use a body_add line with trailing spaces.
body_sig_spaces	1	0	This setting is for the number of lines between the body of the EMail and the users signature.
bulletin_dflt_time	14	7	This is the default time that is setup on the bulletin.tpl when creating a new bulletin.
bulletin_max_time	30	14	This is the max time that a bulletin can live for.
bulletin_path	/var/spool/webmail/bulletins	none	This is the directory where the bulletin information is keep. If this is not defined then bulletins will not work.
bulletin_users	lynden, ralph, adim*	none	This is the list of users that are allowed to send bulletins to WebMail users.
bypass_email_decode	true	false	This will stop EMail address being converted that are located inside an EMail message when set to true.
cookie_valid_days	2	31	This is how long the cookies are valid for.
copy_name	Copies_to_Self	Sent	This is the name of the folder to store copies to self items in
cgi_path	/home/httpd/cgi-bin	env var	This sets the cgi_path. It is only needed if theWeb Server does not set the appropriate environment variable for cgi's
date_format	dmy	mdy	Sets the date format to month first or day first
date_layout	mm-dd	mm/dd/y	This will change the layout of the date displayed in the list of EMails.
debug	true	false	Enables verbose debug output.
debug_external_book	true	false	When set to true, a file called 'external.log' is create and all the input and output of global external address book are logged into this file.
debug_socket	socket.log	none	This logs the data that is being sent and received via IMAP/POP/SMTP/POPPASSD servers.
default_folders_first	true	false	When set to true all the menubar and folder lists are all in alpha-numberic order, but with the default folders first. (fixed_folders).
default_port	143	110	This setting sets up the default port that the CGI will try if none is provided. Also used to make WebMail act like WebIMAP by setting it to port 143.
del_fail	true	false	If set to true it will use the 'del_fail' template when a disk qouta problem occurs.
dictionary	spanish.dat	words.dat	This is used to default what words.dat file to use for the spell checker.
disable_imap_checking	true	false	If your IMAP server does support mutiple connections to the same folder, then setting this to 'true' will allow the CGI to do this.
disable_picture	true	false	This will disable the CGI passing images out. On some web servers that automatically setup the environment: 'PATH_INFO' Then this setting is needed.
disable_user_locking	true	(none)	This will stop the CGI from preforming locking. true - stop locking false - Always lock (none defined) - Depending on Command.
disallow_folders	mailboxdir, crap	none	This allows the admin to restrict what folders are allowed to be called. This setting is also used to determine which folders that are currently on the IMAP server will not be displayed to the user by WebMail
disallow_folder_characters	./\	none	The list of characters setup with this setting are not allowed to be in folder names. Either created with or renamed with these characters.
display_domain	true	false	Forces on the configf.tpl to display the domain setting for the first host instead of the IMAP/POP host. Also forces the from address to be user@domain. NOTE: Using this setting will also disable the HOST setting on the login screen. Not required on version 2.0b+
display_pop	true	false	This changes the default for main account to be: 'user@pophost' on the menubar pulldown list.
disk_quota	100000	1000000	Initial disk quota for new users. Users quotas can be changed by modifying setting in each users user.dat file. Given in bytes. This is only used for POP folders.
domain	acme.com	this host	Used to create the EMail 'from address' for each user.
enable_inbox_transfer	true	false	This will attempt a copy/move to the inbox as some IMAP servers allow this funciton.
enable_wml	true	false	This enables wml features for WebMail. The changes that occur are: Content-Type for pages sent back to the web server is: text/vnd.wap.wml (Other features with WML will appear in later versions.)
environ_pass	AUTH_PASSWORD or HTTP_AUTHORIZATION	none	This setting and 'environ_user' are used to autologin users using username and password that is supplied in the environment variables setup by the webserver.
environ_user	REMOTE_USER	none	This setting and 'environ_pass' are used to autologin users using username and password that is supplied in the environment variables setup by the webserver.
email_name	Message	EMail Message	This is the name that is display when display the EMail message link. If this is set blank then the link is not added.
empty_trash_on_exit	true	false	Force an "empty trash can" on logout and login (after 12 hours).
escape_imap_pass	true	false	When set to true when talking to the IMAP server the character '\' is replaced with '\\' on password sending only. Some IMAP NT servers need this.
fixed_folders	Trash_Can,Sent	none	This is the list of folders that the user is not allowed to delete or rename.
force_8bit_encoding	true	false	When set to true any email message that is sent the text will be left in is 8bit's and not 'quoted-printable'encoded. This can also be setup on the send page when passed in with the send cmd.
force_addr_bk	personal business	default	This is a multiple setting that will always force the name stated to be displayed as an address book.
force_connection	true	false	This will force the connection to the mail server to be setup. Only needed in version 2.0m and higher on the newuser.tpl
force_delete	true	false	On an empty_trash, this will force all emails in the trashcan to be marked as deleted before the deletion is peformed.
force_empty	true	false	This will force messages to be automatically removed straight away.
force_imap_redownload	true	false	When set to true will force the headers to be downloaded again when the EMail message body is downloaded. Needed for the 'OpenMail' server, as it changes the boundaries each time it was accessed.
force_imap4rev1	true	false	This will force the IMAP server to use the commands 'BODY[HEADERS]' and 'BODY[TEXT]'.
force_rfc822	true	false	This will force the IMAP server to use the commands 'RFC822.HEADERS' and 'RFC822.TEXT'. Required for some IMAP server's which do not completely implement the IMAP4REV1.
hash_method	2	1	This determines which user profile hashing method is used, 1 or 2. Note! Do not change this on existing systems as user files will not be found after change. You will need to use the manager page to change this.
header_charset	koi8-r	ISO-8859-1	This will replace the default 'ISO-8859-1' character set the setting provided. This can also be setup the send page when passed in with the send cmd.
host_remap	host.dat	(none)	This is the filename where the host lines will be remaped to. Only used to change the host on login. layout: host_name value ie. domain.com mail.domain.com
href_target	target="_blank"	none	Any <a href="...."> inside of an Email will have this also added as part of the link. ie. <a target="_blank" href=".....">
html_limit	2000	none	This is used to limit the number of characters that may be displayed in an EMail message.
imap_alt_fetch	true	false	when see to true it changes the header fetch from: UID FETCH 1:* (FLAGS BODY RFC822.HEADER) to FETCH 1:* (FLAGS BODY RFC822.HEADER UID) Needed got HP-UX OpenMail server.
imap_list_*	true	false	When set to true, the CGI will change the method of the listing to use '*' instead of '%'.
imap_prefix	/	mail/	This is the default setting for new users for the prefix used when talking to IMAP servers.
imapport	1143	143	IMAP port to connect on.
imaphost	pop.your.domain	this host	The name or number of your IMAP mail server.
imap_host_only	true	false	This allows only IMAP servers to be multi-host.
imap_quota_msg	user quota exceeded	quota	This is the string that it looks for on a failed COPY IMAP command and if it finds it then the failed reason is a disk qouta issue.
ingoing	stats.txt	(none)	The filename stats is appended to, for every header download and EMail download that occurs.
keep_del_flag	true	false	When set to true, is a delete fails then the items is marked as deleted. (on delete and move to trash can)
key	2222-333-44-222	1 month key	Used to enter Registration key.
lang_file	lang.dat	none	This is used to translate the error messages into different languages.
listserver_from	true	false	This is needed for some smtp servers that are expecting 'From username@host' on EMail being sent.
lock_force_wait	true	false	This will force the lock files to timeout before they are removed. (2 seconds on nfs_servers)
lock_timeout	300	600	This is the number of seconds that the Mail folders will be locked for.
log_num	8	4	This is the number of log files which are being rotated.
log_path	/logs/webmail	ini dir	Directory to store the log file in.
log_sent_mail	mail_out.log	none	Any EMail that is sent using WebMail will add one line to this file in the layout. Sent Mail: from: <username> (<hostname/IP address>) (ID=<msgID>)
log_size	1000000	100000	This is the size of the logfile before it is rotated.
login_prg	program "\|\|user\|\|@\|\|host\|\|:\|\|port\|\|"	none	The stated program will run whenever a user logs in.
login_input	error	none	Used in conjuction with 'login_prg' as the fields that are inputed as stdin.
lowercase_host	true	false	this will lowercase the host fields, normally used in conjuction with @pop or @imap settings.
lowercase_password	true	false	Password is always lowercase, so secret is the same as Secret and SECRET.
lowercase_username	true	false	Username is always lowercase, so user ralph is the same as Ralph and RALPH.
managers_ip	1.2.*,2.3.4.5	none	This restrict access to the managers page to valid IP addresses.
managers_password	mysecretpassword or \|filename	none	Password for access to manager.tpl manager page. You can state a file where the managers password is stored.
max_email_rcpt	10	30	The maximum number of people that a message can be sent to in one go.
max_email_size	1000000	none	If the CGI detects an EMail which isn't already downloaded and is equal to or larger than this setting in bytes, will display the 'large.tpl' instead of the 'item.tpl'.
max_email_sends	10	20	The maximum number of messages that can be sent in one day.
max_fetch_accounts	4	12	The maximum number of fetch accounts which 1 user can have. This can not be larger than 12.
max_email_size	1000000	none	If an EMail which is equal to or larger than this amount, a new template called 'large.tpl' will be display asking if the user wants to download such a large email and that it will take a while to perform this action. When force_download=true is also sent this check is ignored.
max_message_display	10	20	The number of EMails which are displayed at one time.
max_pick_size	20	30	The maximum number of address which can be stored in pick list.
max_user_folders	10	unlimited	The number of folders that the users are allowed, excluding the INBOX. This does include the 'trash', 'sent' and 'draft' folders.
max_wml_display	12	unlimited	This is the default number of lines to be displayed on the list page when using WML.
mail_wastebasket	WASTEBASKET	(none)	This the name of the wastebasket that the mail server creates that should be deleted. (IMAP only)
multi_host_allow_@	true	false	When set to true the CGI will stop phassing the user field of the 'multi-host' and leave as entered. So that usernames like: lynden@1.2.3.4 are left alone.
multi_host_autodetect	true	false	This enables the multi-host to automatically check the host which is entered on the configuration page before saving. NOTE: This can cause a long delay on some systems if the domain exists but the port 110/143 does not. This mainly occurs on NT systems.
multi_host_display	2	0	This determines the display in the multi-host pull down menubar. 0 - user@host:port (default) 1 - user@host 2 - user@domain / user@host 3 - reply / user@host
multi_host_size	20	none	This forces the host menubar to a maximum width.
mylock_wait	10	5	This determine how long the CGI will wait in seconds, for the locking file before continuing or generating an error. (Server is Busy)
mylock_timeout	200	120	This determine how long the the lock are allowed to be valid in seconds before they are ignored.
netwin_autologin	<url> <product directory> <extra>	none	Used to setup netwin's products so that they automatically login.
new_login_prg	program "\|\|user\|\|@\|\|host\|\|:\|\|port\|\|" "\|\|pass\|\|"	none	The stated program will run whenever a new user logs in.
new_login_input	error,msg	none	Used in conjuction with 'new_login_prg' as the fields that are inputed as stdin.
new_mail_name	inbox	INBOX	This setting allows the administration to change the name of the INBOX which is displayed to the user.
nfs_server	true	false	If you are running WebMail on a nfs server you must have this set to true. As this is required for the file locking to work correctly.
no_cookies	true	false	When set to true this will disable ALL cookies.
no_email_hr	true	false	When set to true the '<hr>' are not display when viewing Emails.
no_folder_case	true	false	This will make sure that the folder doesn't exist, before creating a new one, ignoring the case in the folder name.
no_folder_sort	true	false	When set to true the list of folders will be sorted.
no_log	true	false	Disable file logging.
no_override_error_tpl	true	false	When displaying the error.tpl (or errorf.tpl) the 'page=' setting is ignored.
no_tcode	true	false	Disable tcode checking.
no_trash	true	false	This will disable delete actions from doing an auto copy to trashcan.
nt_convert_\	true	false	When set to true this will replace '\\' with '\' when decoding the list command. Only needed on some NT IMAP servers that use '\\' as their seperator.
outgoing	stats.txt	(none)	The filename is appended to, for every EMail that is sent out, either sending or draft message etc.
port	1100	110	POP port to connect on
pophost	pop.your.domain	this host	The name or number of your POP mail server
pop_host_only	true	false	This allows only POP servers to be multi-host.
purge_trash	true	false	When set to true and is sent with the empty trash command, this will only delete messages that are marked to be deleted.
read_new	true	false	When a new message is read it loses it new status.
read_wrap	64	85	Automatically wraps displayed email message's lines to X characters wide.
reply_prefix	#	>	This is the character(s) that is attached to the body of any reply to a message.
remove_fwd_inline_text	true	false	When set to true the plain/text attachments are not display inline when a forward_edit command is generated.
remove_inline_text	true	false	When set to true the plain/text attachments are not display inline all the time.
rset	true	false	When set to 'true' when talking to pop server and downloading of the headers the command 'RSET' is used to reset the read flag.
send_wrap	85	60	Automatically wraps email message's lines to X characters wide, before sending them.
set_umask	002	(none)	This will change the umask bits. Needed on some O/S that has setup the umask to be strange, so directories can't be created with executable access.
smtp_auth	LOGIN	(none)	This is the string that the CGI will use when doing an SMTP AUTH command. It will only pass out the username and password, when prompt.
smtp_no_domain	true	false	This will stop the CGI from placing the @domain when sending to the SMTP server. It is only required if using only one server that requires the username to be: username@domain
smtpport	1025	25	The SMTP port to connect on
smtphost	mail.your.domain	this host	The name or IP number of your SMTP mail gateway
spell_seperators	-[]()	(none)	This is just a list of characters the spell check will not use as part of a word.
stated_host	true	false	When set to false it forces the default replay address to be '@domain'. When set to 'true' the default replay address will be '@pophost'. This should be used when users are allowed to select their host.
suffix	/domain.two	none	This suffix will be added to the username entered by the user before being sent to the POP server for login. Usually used with vhost sections. NOTE: DPOP server only needs suffixes for POP logins for virtual domains and only when you have set them as suffix based virtual domains.
templates	/var/spool/webmail	NONE	The directory where you have copied the *.tpl files
time_24hr_format	true	false	Determines whether or not to display time using a 24hr clock.
time_layout	Hr:MM pm	HH:MM:SS	This will change the layout of the time displayed in the list of EMails.
time_offset	nzst	none	This is used when the CGI does not correctly determines the CGI's GMT. Set this to the timezone that the computer is on. This also shows up on the 'cmd=test' page.
timezone	nzst	GST offset	This ini setting is used to default new users to a timezone. The users timezone setting is used to display times in the selected time zone no matter where the Email message was sent. All displayed times are converted to the user timezone setting. (Normally setup on the user options page to change).
top_limit	2	100	Which is used to change the number of 'TOP' commands the CGI sends to the POP server before reading data. This increases the Speed of the process of downloading Email headers.
tpl_set	Number <templates_dir> <nwimg> Name	(setup by install)	This ini setting is uses to setup multiple template sets on one system.
translate_fld	true	false	when set to true the error messages that display the folders name will be translated using the lang.dat file before being displayed to the user.
user_parameter	_usr_*	_*	This determines the prefix to be used on all user settings. These are passed to every template.
valid_host	my.pop.host	none	limits the number of IMAP/POP hosts that users can connect to
valid_to	lynden,.nz	none	limits the number of email addresses that users can send email to
valid_user	lynden,*ralph	none	limits the usernames which may be used to a wildcard list
vagent	Nokia	none	Starts a section of ini settings which apply to a specific user agent. This is normally used for setting up WML settings depending on the phone, but can also be used for netscape and ie settings. Note: vagent sections must follow any general settings.
vagent_match	HTTP_HOST	USR_AGENT	The environment variable which is matched against vagent lines.
vend			Ends a section of ini setting which applies to a particular virtual host
vhost	my.domain.two	none	Starts a section of ini settings which applies to a virtual host my.domain.two Note: vhost sections must follow any general settings.
vhost_match	HTTP_HOST	SERVER_NAME	The environment variable which is matched against vhost lines.
waste_name	rubbish bin	none	The name of the folder into which deleted messages are put
webserver_out	web_sent.log	none	This logs the data that is being sent back to the webserver.
wml_limit	2000	none	This is used to limit the number of characters which may be displayed in an EMail message.
workarea	/var/spool/webmail	templates	The directory which WebMail work files and user subdirectories are created in.
x_mailer	\|\|version\|\| ( \|\|remote_ip\|\| - \|\|user\|\| )	WebMail....	Used to build the X-Mailer: header that is attached to all outgoing EMails from WebMail. To remove the X-Mailer header just leave the setting blank. This will only work on the full version of WebMail. \|\|version\|\|, \|\|remote_ip\|\| and \|\|user\|\| can also be used inside this setting.

download the self extracting archive from netwinsite
webmail20k.exe	# Unzip the self extracting archive to witemp
cd \wmtemp	# Change to temporary unpack directory

mkdir \webmail	# Create a directory for templates
mkdir \inetpub\wwwroot\nwimg	# Create a directory for image files
mkdir \inetpub\wwwroot\nwimg\mail	# Create a directory for image files

copy webmail.exe "\inetpub\scripts"	# Copy CGI
copy webmail.ini "\inetpub\scripts"	# Copy ini
copy tpl\* \webmail	# Copy docs templates etc to destination
copy img\* \inetpub\wwwroot\nwimg\mail	# Copy image files

del \witemp	# Clean out temporary directory

uncompress webmail10h.tar.Z		# Uncompress tar file
tar -xvf webmail10h.tar		# Extract distribution files to WebMail
		# sub-directory
cd webmail		# Change to temporary WebMail sub-directory

After uncompressing and un-tarring the archive.

cd \webmail	# Change to temporary unpack directory

mkdir /var/spool/webmail	# Create a directory for templates
mkdir /home/httpd/html/nwimg	# Create a directory for image files
mkdir /home/httpd/html/nwimg/mail	# Create a directory for image files

copy webmail.CGI /home/httpd/CGI-bin/	# Copy CGI
copy webmail.ini /home/httpd/CGI-bin/	# Copy ini
copy tpl\* /var/spool/webmail	# Copy docs templates etc to destination
copy img\* /home/httpd/html/nwimg/mail	# Copy image files

chown nobody /home/httpd/CGI-bin/webmail*	# Change Ownership of
chown nobody /var/spool/webmail	# WebMail and template
chown nobody /var/spool/webmail/*	# files.

Installation and Setup

Contents

Overview

Templates

NT Installation

Unix Installation

Basic Setup

Default Settings

INI Settings

Date/Time Layouts

Symbol	Example	Explanation
pophost	pop.your.domain	The name or IP number of your POP server
pop_prefix	mail/	The prefix that the POP server uses.
templates	\webmail (or c:/webmail)	The directory where you have copied the *.tpl files
smtphost	mail.your.domain	The name or IP number of your SMTP server
domain	acme.com	Your domain, this will be used to construct EMail addresses
nwimg	/nwimg/mail	The web server relative address of the images