This config section holds settings for the Web interface. This module allows users to read their email or calendar using a web browser.
The following settings can be used in this section:
Enable
You can turn on/off the entire Web interface module using this switch
bool
On/Off, True/False, Yes/No, 1/0
On
Enable=On
WebUIDebug
Extensive debug logging for the Web Interface
bool
On/Off, True/False, Yes/No, 1/0
off
WebUIDebug=off
WebUIURL
The URL you wish to send to users for them to access the web interface. The URL sent to users should correspond to the host and port setup for the web interface. If for example you have set the Port to 8080 and the host is left blank (to bind to all/default NICs), then the URL should be http://hostmachinename:8080 Remember that if external users are to manage their own SPAM then the URL specified must be accessible from outside your local network, and your firewall must be configured to allow incoming TCP (HTTP) connections to this machine on the chosen port. If you leave this setting blank, a URL will be automatically constructed from the machine's hostname and configured port. In some cases this will not be accessible by users outside of your local network, so you will need to specify this if sending alert emails to users external to your network.
text
WebUIURL=http://mail.mydomain.com:8080
Host
the explicit network address or hostname of the network card you wish the server to bind to. Typically you will want to leave this blank to ensure binding to the default network device. Setting this to 127.0.0.1 can render it impossible to connect to the application
text
Host=127.0.0.1
Port
the port you wish the server to bind to. If you are using Hexamail POP3 Downloader as your main email server for your company email, you will typically want to leave this on the default setting of 80
number
8080
Port=80
Integrate
text
hxm
Integrate=hxm
Integrate
text
IISVirtualDirectory
text
hexamailpop3downloader
IISVirtualDirectory=hexamailpop3downloader
Integrate
text
off
Integrate=off
ApacheVirtualDirectory
text
hexamail
ApacheVirtualDirectory=hexamail
Integrate
text
on
Integrate=on
EncodingCharSet
The output character encoding. Usually it is best to use the default ISO-8859-1 unless extended or multibyte characters are required, in which case please use UTF-8
text
UTF-8
EncodingCharSet=UTF-8
Templates
This setting allows you to use the default installed templates. This is useful after an upgrade to check whether new features have been added to the web interface that may be missing in your modified templates.
It can also be useful to temporarily override your modified templates should they contain HTML or javascript bugs or browser incompatibilities.
text
on
Templates=on
Templates
This setting allows you to use modified templates.
text
off
Templates=off
PortEnable
You can optionally enable this protocol
bool
On/Off, True/False, Yes/No, 1/0
true
PortEnable=true
SSLHost
The host binding or NIC to use for SSL communications
text
SSLHost=127.0.0.1
SSLPort
The port to use for SSL communications
number
80 - 32000
443
SSLPort=443
SSLPortEnable
You can optionally enable this protocol over a secure channel using SSL. If you do not specify a certificate name using the SSLCertificate configuration parameter in the config file (.cfg) one will be created automatically for you. However, as this is an auto-created certificate it will not be signed by a certification authority and may cause warnings in the clients used to connect to this server. If the users of the clients accept the warnings, then SSL can be used immediately. If you do not wish users to see these warnings you need to obtain and install a valid, signed, SSL certificate for your server from a provider such as Thawte, or Verisign. You must then specify the certificate name in the SSLCertificate parameter of the configuration file.
bool
On/Off, True/False, Yes/No, 1/0
false
SSLPortEnable=false
SSLCertificate
WIN32: Choose a valid suitable certificate from those listed. If none are shown, then there are no suitable certificates installed on the server machine. You can install a certificate using IIS and then use that certificate from Hexamail. Certificates must be suitable for server authentication and secure channel encryption.
LINUX (OpenSSL): Specify the name/full path of a PEM certificate file valid for SSL server usage.
select
SSLPrivateKey
OpenSSL (LINUX) ONLY: You can optionally provide a separate private key PEM file. This must match the public key used of the certificate PEM file.
text
TempIPBlockPeriod
This is how long temporarily blocked IPs are blocked for
number
0 - 999999 minutes
240 minutes
TempIPBlockPeriod=300
AuthMaxFailsAction
You can automatically close the connection and optionally block the IP for clients that fail authentication
This will enable logging of the most recent request to a text file in the working directory
bool
On/Off, True/False, Yes/No, 1/0
Off
DebugRequests=Off
MaxConnections
You can allow a large number of simultaneous connections to provide for large amounts of email users. Set this high if you have lots of users all wishing to connect simultaneously.
number
1 - 256
256
MaxConnections=32
AutoLogoutTime
Sometimes users leave browser open, therefore you may want to decrease this timeout to ensure that if a browser is left open, not used and unattended the user's email session is automatically ended.
600 minutes
AutoLogoutTime=120
TemporaryFolder
If the Web Interface has to make temporary files it stores them in this directory
text
temp/webui
TemporaryFolder=temp/webui
DisallowedIPList
This is the list of disallowed IP addresses that cannot connect to your Web interface. You can use wildcards and ranges (e.g. 192.168.0.0/16, 192.*.*.*, 192.10-50.*.*) or leave blank for no restrictions. By setting this connections from any IP that matches an entry in this list are prevented.
Note that if an IP matches an entry in the allowed IP address it is allowed regardless of matching a disallowed IP
You can throttle the maximum bandwidth allowed for sending email clients to use when communicating with it. Typically you do not need to change this setting.
number
1 - 1000000 kbps
1000000 kbps
MaxRecvBandwidth=64
MaxSendBandwidth
You can throttle the maximum bandwidth allowed for sending responses to email clients. Typically you do not need to change this setting.
number
1 - 1000000 kbps
1000000 kbps
MaxSendBandwidth=64
SessionExpiry
Expiry time for sessions with no activity
number
1 - 9000 minutes
15 minutes
SessionExpiry=15
HSTS
Implement HSTS to force clients to use https. REQUIRES SSL to be setup.