Label
|
Example
|
Default
|
Explanation
|
@imap |
true |
false |
Allows the 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 separated variable that allows other
ini settings to allow $(...) variable replacement. eg, in your
ini file you can have:
allow_$ bob
bob $(workarea)/testing |
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 displayed 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 set up more
than 1 host to allow, by just adding 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 displayed
when viewing an HTML attachment. |
allow_script |
true |
false |
This will allow Scripts to be displayed when
viewing an HTML attachment. |
allow_sender |
true |
false |
When set to true, this will allow the 'sender'
header to be set in the templates. |
allow_style |
true |
false |
This will allow <style> tags to be displayed
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
appear when inline images are turned off. |
answer_update |
true |
false |
When set to true, it will use the new answering
flag method where, only when the reply message is sent is the message
flagged as answered. The variable 'answered' is used to store
the UID of the message. |
attach_target |
target="_blank" |
none |
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 because 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_create_folders |
Trash_Can,Sent,Drafts |
none |
This will automatically create these folders
for any new users. |
auto_delete |
lynden* 0
*@temp 1
* 30 |
none |
This setting is used to determine when accounts
will be automatically removed if not logged in for x number of
days. You are allowed multiple settings. When set to 0 days this
account will never be removed. |
auto_logout_mins |
200 |
60 |
Time since last activity for logged in user
before cache of new mail messages is purged |
auto_timezone |
true |
false |
When set to 'true' this will automatically account
for daylight savings when display dates to the user. |
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 multiple
IP's and you want to make sure that the CGI, when talking to the
Mail server, looks like it is coming from one 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_add_tpl |
body_add.tpl |
blank |
Will phase specified template file and then
attach the result to the end of all outgoing Email messages. |
body_sig_spaces |
1 |
0 |
This setting is for the number of lines
between the body of the Email and the user's signature. |
bulletin_dflt_time |
14 |
7 |
This is the default time that is set up 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 kept. If this is not defined then bulletins will not work. |
bulletin_users |
lynden, ralph, admin* |
none |
This is the list of users that are allowed to
send bulletins to WebMail users. |
bypass_email_decode |
true |
false |
When set to true, this will stop Email addresses
that are located inside an Email message, from being converted.
|
cache_control |
no-cache |
(none) |
This is used to set a Cache-Control page header:
cache_control no-cache
converts to:
Cache-Control: no-cache
when sending page headers like the 'content-type' of the data
to the webserver. |
cgi_path |
http://my.com/CGI-bin/webmail.cgi |
env var |
This sets the cgi_path. It is only needed if
theWeb Server does not set the appropriate environment variable
for CGIs |
check_suffix |
true |
false |
When set to true it will check that if there
is already a suffix on the username it will not add it again. |
cookie_path |
|
(none) |
This sets up the cookie path of the cookies
sent out by the CGI. |
cookie_key_enable |
true |
false |
When set to true it will encode passwords with
a random key generated by the CGI. |
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. |
create_sub_folders
delete_sub_folders |
/
/ |
(none) |
This will create the sub folders needed,
and the delete will remove any sub folders. |
cvt_host_file |
cvt_host.dat |
(none) |
This sets a file (in the templates directory)
used to convert hosts when creating user directories,
file layout is:
<current.host> <destination.host>
eg:
my.new.pop.host my.old.pop.host |
cvt_cwmail_live
cwmail_workarea
cwmail_hash_method
cwmail_host_num
cwmail_folder
cwmail_pophost
webmail_host
cwmail_no_dist_list
cwmail_allow_dash
cwmail_allow_dot
cwmail_allow_slash
|
See 'Upgrading from CWMail/DMailWeb' on the FAQ page
|
(none) |
These settings are used to convert cwmail users
on the fly when they login to webmail, if they haven't already
been converted over. |
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_new_user |
true |
false |
When set to true, it will log failure to create
user.new files. |
debug_external_book |
true |
false |
When set to true, a file called 'external.log'
is created 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 in alpha-numeric 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 quota problem occurs. |
delete_sub_folders |
true |
false |
The value of this is the folder separator being
used:
ie. delete_sub_folders /
delete_sub_folders.
What will happen is that if you delete a folder, it will also remove
ALL sub folders as well.. |
delta_cookie |
true |
false |
When set to true all cookies use 'Max-Age=..'
instead of 'expires=..' in all cookies |
dictionary |
spanish.dat |
words.dat |
This is used to default what words.dat file
will use for the spell checker. |
disable_imap_checking |
true |
false |
If your IMAP server supports multiple connections
to the same folder, 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'
this setting is needed. |
disable_user_locking |
true |
(none) |
This will stop the CGI from performing 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 set up with this setting
are not allowed to be in folder names. Either created with, or
renamed with these characters. |
disallow_profile_characters |
*(: |
#&@~/." |
The list of characters set up with this setting
are not allowed to be in profile names. |
display_domain |
true |
false |
Forces 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 the main account to
be:
'user@pophost' on the menubar pulldown list. |
disk_quota |
100000 |
1000000 |
Initial disk quota for new users. User quotas
can be changed by modifying the setting in each user's user.dat
file. Given in bytes. This is only used for POP accounts and doesn't
include the Inbox. |
do_base_dir |
/var/spool/webmail/do/ |
(none) |
Specifies the directory where scripts used by
||do(..)|| template commands are kept. |
domain |
acme.com |
this host |
Used to create the Email 'from address' for
each user. |
domain_select |
true |
(none) |
When set up this will display a pulldown list
on the login page of all of the domains setup by Surgemail, allowing
the user to select the domains to use. |
enable_cmd_log |
true |
false |
When set to true this will allow this to work:
./webmail.cgi -enable_cmdlog c:\webmail\log\cmd.log
./webmail.cgi -disable_cmdlog c:\webmail\log\cmd.log
Allowing you to start the 'cmd.log' file' and to be turned on and off
as needed. |
enable_imap_quota |
true |
false |
When used it will attempt to use the IMAP quota
system if the IMAP server supports this feature. |
enable_inbox_transfer |
true |
false |
This will attempt a copy/move to the inbox as
some IMAP servers allow this function. |
enable_flag_all |
true |
false |
When set to true, when using IMAP, this will flag all
the emails. before a delete happens. Only used with: 'purge_trash
true' ini setting. |
enable_ns_wysiwyg |
true |
false |
When set to true will display the netscape wysiwyg
interface |
enable_stdout_blocking |
true |
false |
When set to true it will make the stdout output
blocking. |
enable_user_encode |
true |
false |
When set to true it user profile directories
that have '/\:*?"<>|!' will be encoded. |
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.) |
enable_wml_html |
true |
false |
This will make any HTML attachments display
inline when using wap with all the HTML code stripped off. |
enable_wml_text |
true |
false |
This will make any text attachments display
inline when using wap. |
enable_wml_rfc822 |
true |
false |
This will make any message/rfc822 attachments
display inline when using wap. |
enable_xml |
true |
false |
When set to true it will replace all '&' with
'&' to follow the xml RFC. |
enforce_new |
true |
false |
When set to true this new flag will be lost
between mail checks instead of session logins. |
environ_pass |
AUTH_PASSWORD or HTTP_AUTHORIZATION |
none |
This setting and 'environ_user' are used to
autologin users using username and password that are 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 are supplied
in the environment variables setup by the webserver. |
email_name |
Message |
Email Message |
This link is displayed when WebMail displays an RFC 822 type
message. If set blank, the link is not added.
|
empty_spam_on_exit |
true |
false |
When set to true when the user login/logout
their SPAM folder will be emptyed. |
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. |
external_book |
external_addressbook_name |
none |
This ini setting should be set to the name of
the external address book module you are using, if you are using
an external address book with WebMail |
fetch_autodetect |
true |
false |
When set to true, this will check the fetch
account when created
and if it fails will not add to the fetch list. Possible Message
responses:
Failed to Connect to 1.2.3.4
Connected to 1.2.3.4 did not
detect IMAP/POP server
Username/Password was
invalid |
fetch_man_timeout |
30 |
20 |
This is the timeout for connecting to fetch
accounts when using manual fetching. |
fetch_timeout |
15 |
10 |
This is the timeout for connecting to fetch
accounts when using automatic fetching (default). |
fixed_folders |
Trash_Can,Sent |
none |
This is the list of folders that the user is
not allowed to delete or rename. |
folder_uft7_encode |
true |
false |
When set to true when the CGI is talking to
the IMAP server folder names are UTF-7 Encoded. This allows non-standrad
characters in folder names |
force_8bit_encoding |
true |
false |
When set to true, the text of any Email message
that is sent, will be left in it's 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 set up. 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
performed. |
force_empty |
true |
false |
This will force messages to be automatically
removed straight away. |
force_imap_read_reload |
true |
false |
When set to true, will force the "Read"
message flags to be updated on every check for new mail. |
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 servers
which do not completely implement the IMAP4REV1. |
friends_only |
true |
false |
When set to true this will display the friends
link. (see below for 'netwin_autologin' ini setting that is also
needed) |
from_use_dflt_reply |
true |
false |
when set to true this will use the default reply
address instead of building it. (for the 'from:' email header.) |
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
to the setting provided. This can also be set up on the send page
when passed in with the send cmd. |
hide_stop_attach |
true |
false |
When set to true this will hide any links to
files which are not allowed to downloaded by webmail. |
host_remap |
host.dat |
(none) |
This is the filename where the host lines will
be remapped 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 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 set 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
imaphost_backup |
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. If it finds it, the failed reason is a disk
quota issue. |
ingoing |
stats.txt |
(none) |
The filename stats is appended to for every
header download and Email download that occur. |
include_inbox_size |
stats.txt |
(none) |
When set to true the INBOX size is also included
when it comes to the amount of disk space the user has used. (POP
only). |
inbox_folder |
Bob |
Inbox |
This is the name of the folder that is to be
used for INBOX emails. |
invalid_user |
*john*,*f??k*,bob |
(none) |
Lists the usernames that are not allowed to
be used in WebMail |
keep_del_flag |
true |
false |
When set to true, and the delete fails, items
are 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. |
lock_wait_time |
1 |
2 |
The amount of time in seconds to wait for file
locks when "lock_force_wait" is true in the ini file. |
log_environ |
HTTP_X_NOKIA_BEARER |
(none) |
A setting that allows you to log the number
of times a particular environment variable was passed in. |
log_login_users |
true |
false |
When set to true this will enable the logging
of the number of users that login within a month. |
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_emails |
true |
false |
When set to true it will create a log file and
append 1 byte each email that is sent out. Filename: email_sent_MM_YY.dat |
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. |
log_template |
item.tpl |
(none) |
A setting that allows you to log the number
of times a particular template file was used. Filename: template_MM_YY.dat |
log_user wild_username debug socket |
log_user lynden@* webimap.log d:\webimap\socket.log |
none |
This allows selective user information be logged
into separate files or just a selected person.
wild_username: Can be of a wild list of users without any spaces.
lynden@*,john*@domain.com
debug: will use the 'log_path' ini setting.
socket: will not.
If 'debug' or 'socket' are set to 'none' then that will not be
logged
ie. log_user lynden@* webimap.log none |
login_prg |
program "||user||@||host||:||port||" |
none |
The stated program will run whenever a user
logs in. |
login_input |
error |
none |
Used in conjunction with 'login_prg' as the
fields that are input as stdin. |
lowercase_host |
true |
false |
this will lowercase the host fields, normally
used in conjunction 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. |
main_timeout |
15 |
20 |
This is the timeout for connecting to the main
account. |
managers_ip |
1.2.*,2.3.4.5 |
none |
This restricts access to the manager's 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 manager's password is stored. |
max_download |
50 |
200 |
When using a POP account this setting limits
the number of new messages to be downloaded on 1 reload mail command. |
max_imap_download |
200 |
(none) |
This is the max number of new mail webmail will
download at a give time from the mail server. (defaults to be
off). |
max_email_rcpt |
10 |
30 |
The maximum number of people that a message
can be sent to in one go. |
max_email_sends |
10 |
20 |
The maximum number of messages that can be sent
in one day. |
max_email_size |
1000000 |
not used |
If an Email is equal to or larger than this
amount, a new template called 'large.tpl' will be displayed asking
if the user wants to download such a large Email, and informing
them that it will take a while to perform this action.
When force_download=true is also sent this check is ignored. |
max_fetch_accounts |
4 |
12 |
The maximum number of fetch accounts which one
user can have. This can not be larger than 12. |
max_imap_single_download |
1 |
30 |
Defaults to 30, but some broken IMAP servers
require this to be set to 1. |
max_memory |
60 |
30 |
This is the amount of memory WebMail is allowed
to use before it will exit. (in Megabytes) |
max_message_display |
10 |
20 |
The number of Emails which are displayed at
one time. |
max_pick_size |
20 |
30 |
The maximum number of addresses which can be
stored in a 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 is the name of the wastebasket that the
mail server creates that should be deleted. (IMAP only) |
modify_from |
true |
false |
When set to true the 'from' address will display
when writing an email for the user to change. |
multi_host_allow_@ |
true |
false |
When set to true, the CGI will stop phasing
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. |
multihost_timeout |
20 |
10 |
This is the timeout for checking multihost accounts. |
mylock_wait |
10 |
5 |
This determines how long the CGI will wait,
in seconds, for the locking file before either continuing or generating
an error.
(Server is Busy) |
mylock_timeout |
200 |
120 |
This determines how long the locks are allowed
to be valid for, in seconds, before they are ignored. |
msisdn_header |
MSISDN |
(none) |
Requires 'msisdn_path' ini setting also. These
settings are used to store cookies on WAP (or Web) for customers
that have gateways that do not support cookies, but provide an
MSISDN or unique variable for each phone. |
msisdn_path |
/var/spool/webmail/msisdn |
(none) |
Requires 'msisdn_header' ini setting also. These
settings are used to store cookies on WAP (or Web) for customers
that have gateways that do not support cookies, but provide an
MSISDN or unique variable for each phone. |
netwin_autologin
netwin_autologin_id
|
[<id>] <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 conjunction with 'new_login_prg' as
the fields that are input 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 an NFS server,
you must have this set to true, as this is required for the file
locking to work correctly. |
no_cookie_domain |
true |
false |
When set to true the domain section is not sent
for all cookies. |
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 displayed
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 not
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. |
no_trash_quota |
true |
false |
When set to true, the trash can will NOT be part
of the disk quota. And so trash can has no quota. Normally ONLY
used if you also are emptying the trash on exit as well.
NOTE: Only works with POP accounts. |
not_allowed_attach |
*.exe,*.doc,*.pdf,*.xls |
(none) |
This is a comma separated list of wild card
names of files that are not allowed to be attached. |
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 separator. |
outgoing |
stats.txt |
(none) |
The filename is appended to for every Email
that is sent out, either sending or draft message etc. |
override_prefix |
true |
(none) |
This will override the imap prefix setting within
the user.dat file. |
port |
1100 |
110 |
POP port to connect on |
pophost
pophost_backup |
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 when it 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's new
status. |
read_wrap |
64 |
85 |
Automatically wraps displayed Email message's
lines to X characters wide. |
reply_prefix |
# |
> |
These are the character(s) that are attached
to the body of any reply to a message. |
require_cookies |
false |
(default) |
When set to true, cookies are used to determine
whether a user is logged in. When set to false, these cookies
are not used. When no setting is present, if a user has
cookies enabled, cookies are required from that user while he/she
is logged in. If the user does not have cookies enabled, cookies
are not required. |
remove_dfltreply_prefix |
true |
false |
When set to true ,if WebMail is creating the
default email address for a new user and the pop host has one
of the following prefixes:
imap. pop. pop3.
mail. webmail. www.
It will remove the prefix when creating the default reply address.
|
remove_fwd_inline_text |
true |
false |
When set to true, the plain/text attachments
are not displayed inline when a forward_edit command is generated. |
remove_inline_text |
true |
false |
When set to true, the plain/text attachments
are not displayed inline all the time. |
remove_none |
true |
false |
When set to true will stop the '(none)' from
being display in the pick list.. |
rset |
true |
false |
When set to 'true', the command 'RSET' is used
to reset the read flag when talking to pop server and downloading
of the headers . |
cookie_secure |
true |
false |
Forces all cookies to have the secure flag, only serving the cookies on https connections. |
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 have setup the umask to be strange, so directories can't
be created with executable access. |
show_tpl_names |
true |
false |
When set to 'true', adds an html comment at
the top of each page parsed out stating the name of the template
(also happens for ||include|| files). |
smtp_auth |
LOGIN |
(none) |
Having an 'smtp_auth' line in your ini file
will get WebMail to login to your SMTP server (authenticated SMTP).
The value of the ini setting is the string that the CGI will use
to authenticate when doing an SMTP AUTH command. Most SMTP servers
will use 'smtp_auth LOGIN'. WebMail will only pass out the username
and password when prompted by the SMTP server. |
smtp_mail_domain |
your.domain.com |
smtphost ini setting |
Will use this domain when talking to the SMTP
server for the the 'sender' and also the 'Mail From:' smtp command. |
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
smtphost_backup |
mail.your.domain |
this host |
The name or IP number of your SMTP mail gateway |
socket_timeout |
10 |
30 |
This is the timeout setting on mailserver commands.
|
spam_email_address
not_spam_email_address |
spam@domain.com
notspam@domain.com |
(none) |
This is the email address that any spam is sent.
The new command 'cmd=spam_remove-||uidl||' Is used on the item.tpl
to allow users to send the email to the spam address. |
spell_separators |
-[]() |
(none) |
This is just a list of characters that the spell
check will not use as part of a word. |
stated_host |
true |
false |
When set to false it forces the default reply
address to be '@domain'. When set to 'true' the default reply
address will be '@pophost'. This should be used when users are
allowed to select their host. |
stdout_blocking_time |
30 |
60 |
This is the timeout in seconds when talking
to the webserver when "enable_stdout_blocking" is true
in the ini file. |
stop_attach_download |
*.exe,*.com,*sex* |
(none) |
This setting will stop wild card files from
being downloaded.. |
store_bcc |
true |
false |
When set to true it will save the 'bcc' when
saving message as a draft and copies to self folder. |
strip_suffix |
true |
false |
When set to true the 'suffix' is removed when
building the default 'from:', 'sender:' as well as the 'default
reply' fields of an Email. |
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 servers 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 |
HR:MM:SS pm |
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
determine 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 |
GMT offset |
This ini setting is used to default new users
to a timezone. The user's timezone setting is used to display
times in the selected time zone no matter where the Email message
was sent from. All displayed times are converted to the user timezone
setting. (Normally set up to change on the user options page). |
top_limit |
2 |
100 |
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 used to setup multiple template
sets on one system. |
translate_fld |
true |
false |
When set to true, the error messages that display
the folder's name will be translated using the lang.dat file before
being displayed to the user. |
updated_prevnext |
true |
false |
When set will use the new method
of going to the next/prev email, but using the commands: 'nextitem-..'
and 'previtem-..' |
use_http_host |
true |
false |
When set to true it will use 'HTTP_HOST'
environment setting instead of 'SERVER_NAME' to build the ||http_server||
settings. |
use_id_autologin |
true |
false |
When set to true it use the new autologin
method. Only available with use with SurgeMail. |
use_imap_local_search |
true |
false |
When set to true it will use WebMail
search routies instead of using hte IMAP server search commands. |
use_surgehost_http |
true |
false |
When set to true will use HTTP_HOST
for the surgehost.ini file lookups. |
use_x_uidl |
true |
false |
When set to true it will cache the 'UIDL' for
use later. NOTE: Not all Mail servers correctly support this. |
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 apply
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. |
x_originating_ip |
true |
false |
When set to true, this will setup a header like
the following on all outgoing messages:
X-Originating-IP: 1.2.3.4 |