Advanced configuration via config.php file (WebMail Pro 6 PHP)

From AfterLogic Wiki

Basic set of WebMail Pro configuration options is defined in settings.xml file. However, current version of WebMail Pro (PHP) also allows for low-level configuration. The file used for this is data/settings/config.php and it's also used when configuring plugin API (e.g. enabling voice messages support).

Just like settings.xml file, config.php is located in the data directory and thus is not affected during product installation upgrades.

By default, config.php file contains empty array:

<?php
 
return array();

Specifying value for particular configuration options means adding pair of key and value according to regular PHP syntax, e.g.:

<?php
 
return array(
	'plugins.voice-message' => true
);

Below, you'll find a list of options currently supported. In case if the value is not explicitly specified in data/settings/config.php file, default values are retrieved from libraries/afterlogic/common/config.php file. This file is for reference purposes only: do not modify it!

log.log-file

File used for webmail logging.
Default value: "log-$sCurrentDate.txt"

log.event-file

File used for users activity logging.
Default value: "event-$sCurrentDate.txt"

Both the above options use $sCurrentDate value which may be redefined in the same config.php file according to date function syntax:

$sCurrentDate = date('Y-m-d');

log.max-view-size

The setting defines size of the log file extract available through adminpanel (in Kbytes).
Default value: 100

js.use-js-gzip

Defines whether javascript files compression and merging is used.
To speed up loading WebMail Pro interface, JavaScript files are compressed on server. You might need to turn this off, in some cases, particularly if you feel that GZip compression doesn't work on your server as expected.
Default value: true

captcha.limit-count

Number of subsequent login errors which invokes CAPTCHA.
Default value: 3

captcha.recaptcha-private-key, captcha.recaptcha-public-key

Keys for configuring reCaptcha.

socket.connect-timeout

Socket connection timeout limit (in seconds).
Default value: 20

socket.get-timeout

Socket stream access timeout (in seconds).
Default value: 20

webmail.default-inc-charset

Encoding used by default if not specified in a message.
Default value: iso-8859-1

webmail.default-out-charset

Encoding used for composing mails.
Default value: utf-8

webmail.use-prefetch

Defines whether messages are prefetched.
To minimize response time when selecting a message, WebMail Pro fetches messages from server in background.
Default value: true

webmail.use-iframe

The file used to launch WebMail in IFrame (e.g. iframe-webmail.php).
This is especially useful if you embed WebMail Pro into your own web application.
If set to null, WebMail is launched in regular way (not in IFrame).
Default value: null

webmail.rtl-langs

Languages considered to be Right-To-Left ones by WebMail.
Default value: array('Hebrew', 'Arabic')

webmail.xmailer-value

X-Mailer value used in outgoing mails.
Default value: 'AfterLogic WebMail PHP'

webmail.allow-first-character-search

Additional character interface for filtering contacts in address book.
Default value: false

webmail.create-imap-system-folders

Allow creating system folders if those are not found on mail server (IMAP4 only).
WebMail attempts to locate special (system) folders like Trash, Drafts, Sent Items. If particular folder is not found, WebMail can create it, and you can disable this of course.
Default value: true

webmail.forwarded-flag-name

Flag used for marking message as Forwarded (IMAP4 only).
If empty, the functionality is disabled.
Default value: '$Forwarded'

webmail.memory-limit

Memory limit set by WebMail for resource-consuming operations (in Mbytes).
Default value: 200

webmail.time-limit

Time limit set by WebMail for resource-consuming operations (in seconds).
Default value: 3000

webmail.folder-base-limit

Number of prefetched message lists.
Aside from prefetching messages themselves, WebMail Pro would also prefetch first page of message list for every folder. This configuration option limits number of folders scanned.
Default value: 5

webmail.preload-body-size

Max. size of message allowed to be prefetched.
Default value: 76800

webmail.suggest-contacts-limit

Max number of contacts, for autocompletion drop-down.
Default value: 20

webmail.autosave

Enable saving drafts automatically. Saving is performed once a minute, assuming it is supported by particular IMAP server. Works for POP3 accounts as well.
Default value: true

webmail.bodystructure-message-size-limit

Defines upper limit for message size allowed for loading completely (IMAP4 only).
If message size is less then that, it will be loaded in full, partially otherwise (using bodystructure request).
Default value: 20000

contacts.default-primary-email,

Which email should be treated as primary one in contact object.
Supported values: EPrimaryEmailType::Home, EPrimaryEmailType::Business, EPrimaryEmailType::Other
Default value: EPrimaryEmailType::Home

The 'temp.cron-time-...' settings affect functionality of purging folder of temporary files when API method CApiWebmailManager->ClearTempFiles() is called, see clear-tmp.php example for details.

temp.cron-time-to-run

Minimal timeframe between two runs of cron script (in seconds).
Default value: 10800 (3 hours)

temp.cron-time-to-kill

If file is older than this it is considered outdated.
Default value: 10800 (3 hours)

temp.cron-time-file

This file stores information on last launch of the script.
Default value: '.clear.dat'

plugins

Enable plugins in WebMail.
Default value: true

plugins.config.include-all

Force enabling all the plugins.
Default value: false

plugins.webmail

Enable "webmail" plugin if exists. The plugin is mandatory, altering value and removing the plugin is not recommended.
Default value: true

There are also several 'labs.' configuration options, those are experimental and it's not recommended to alter their values.

Last edit: 2012/1/16