Hexamail Server Configuration Reference [Developer]
[Developer]
This config section holds settings for the Developer REST module. This module allows applications to integrate using REST
The following settings can be used in this section:
Enable
You can turn on/off the REST module using this switch
bool
On/Off, True/False, Yes/No, 1/0
on
Enable=on
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 Server as your main email server for your company email, you will typically want to leave this on the default setting of 80
number
1880
Port=80
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
1443
SSLPort=443
Password
The password is used to ensure that only the authorized administrator of the
Hexamail service can use the REST interface to configure Hexamail Server.
encryptedtext
SessionExpiry
Expiry time for sessions with no activity
number
1 - 9000 minutes
15 minutes
SessionExpiry=15
DebugRequests
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
MaxRecvBandwidth
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
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.