Configuring WebMail via settings.xml file (WebMail Pro 6)

From AfterLogic Wiki

Jump to: navigation, search

Contents

Summary

Here is described each parameter in data/settings/settings.xml file. The file contains global settings of WebMail Pro. Frequently used options can be set via AdminPanel while others are amended in the file directly. Changes are applied once file is saved and new user session is started.

While Common section defines global application options, rest of the sections define default values for all the domains, and most of those can be overriden for particular domain using AdminPanel.

Unless stated otherwise, detailed description of the configuration options refer to PHP edition of WebMail Pro. Most settings exist in WebMail Pro ASP.NET as well, their design idea and accepted values might be a bit different.

<Common> section

<SiteName>AfterLogic WebMail Pro</SiteName>
Default title that will be shown in browser's header (Default domain settings).
<LicenseKey>WMZZZ-XXXXXXXXXXXXXXXXXXXXXXXXXXXX-YYYYYYYYY</LicenseKey>
License key is supplied here.
<AdminLogin>mailadm</AdminLogin>
<AdminPassword>827ccb0eea8a706c4c34a16891f84e7b</AdminPassword>
Administrative credentials. In current PHP version, MD5 hash of the password is stored; the above value represents password 12345.
<DBType>MySQL</DBType>
Database engine used. MySQL or MSSQL for .NET edition, PHP edition works with MySQL only.
<DBPrefix>webmail_</DBPrefix>
Prefix used for database tables' names. Empty by default, tables are called a_users, awm_messages, acal_events etc.
<DBHost>192.168.0.55</DBHost>
Specify hostname or socket path used for connecting to SQL database.
<DBName>webmail</DBName>
The name of database in SQL server used by WebMail.
<DBLogin>login</DBLogin>
Login for SQL user.
<DBPassword>password</DBPassword>
Password to access SQL database.
<UseSlaveConnection>Off</UseSlaveConnection>
<DBSlaveHost>localhost</DBSlaveHost>
<DBSlaveName />
<DBSlaveLogin>root</DBSlaveLogin>
<DBSlavePassword />
(PHP edition only) These parameters refer to separate read/write access to the database. When UseSlaveConnection is set to On, the first set of credentials will be used to write to the database while *Slave* credentials - to read from it.
<DefaultLanguage>English</DefaultLanguage>
Default interface language. List of languages is obtained by getting filenames from /lang directory.
<DefaultTimeZone>0</DefaultTimeZone>
Default timezone offset. Accepted values are defined in $TIMEZONE array in common/inc_arrays.php file.
<DefaultTimeFormat>F24</DefaultTimeFormat>
Default time format. Accepted values: F12 (for AM/PM) or F24.
<AllowRegistration>Off</AllowRegistration>
<AllowPasswordReset>Off</AllowPasswordReset>
Setting AllowRegistration and AllowPasswordReset to On allows for using password reset and user signup pages when WebMail Pro is integrated with mail server. This is supported out-of-box in MailSuite Pro and is not supported in standalone WebMail Pro.
<EnableMobileSync>Off</EnableMobileSync>
<MobileSyncUrl />
<MobileSyncContactDataBase>card</MobileSyncContactDataBase>
<MobileSyncCalendarDataBase>cal</MobileSyncCalendarDataBase>
This defines whether users are be able to use mobile sync powered by Funambol, required access parameters are supplied. See SyncML support for details.
<EnableLogging>Off</EnableLogging>
<EnableEventLogging>Off</EnableEventLogging>
<LoggingLevel>Full</LoggingLevel>
Activating debug logging and user activity logging (EnableLogging and EnableEventLogging respectively). For debug logs, verbosity level can be set to Full, Warning or Error. Log files are saved in data/logs directory, filename patterns are log_YYYY-MM-DD.txt and events_YYYY-MM-DD.txt respectively.

<WebMail> section

<AllowWebMail>On</AllowWebMail>
Setting this to Off has the effect of turning WebMail off, useful for maintenance.
Accepted values: On or Off.
<IncomingMailProtocol>IMAP4</IncomingMailProtocol>
<IncomingMailServer>localhost</IncomingMailServer>
<IncomingMailPort>143</IncomingMailPort>
<IncomingMailUseSSL>Off</IncomingMailUseSSL>
<OutgoingMailServer>localhost</OutgoingMailServer>
<OutgoingMailPort>25</OutgoingMailPort>
<OutgoingMailAuth>AuthCurrentUser</OutgoingMailAuth>
<OutgoingMailLogin />
<OutgoingMailPassword />
<OutgoingMailUseSSL>Off</OutgoingMailUseSSL>
<OutgoingSendingMethod>Specified</OutgoingSendingMethod>
Mail access configuration used in Default domain settings, they are used automatically unless overrided explicitly.
OutgoingMailAuth defines authentication approach:
  • NoAuth - don't use SMTP authentication;
  • AuthSpecified - always use login and password set in OutgoingMailLogin and OutgoingMailPassword respectively;
  • AuthCurrentUser - use user's login and password for SMTP authentication (default).
    OutgoingSendingMethod is reserved for future use, it's supposed to define approach for sending mail. The only value currently supported is Specified.
<UserQuota>0</UserQuota>
Reserved for future use.
<AutoCheckMailInterval>0</AutoCheckMailInterval>
Specifies interval for automated mailcheck. For instance, if this is set to 10 minutes, WebMail would fetch information about new messages every 10 minutes during user session. WebMail will issue a notification in window/tab title when there are new messages.
Accepted values: 0 (autocheckmail disabled), 1, 5, 10, 15, 30.
<DefaultSkin>AfterLogic</DefaultSkin>
Specifies default skin for WebMail appearance. List of skins is obtained as list of subdirectories under skins dir.
<MailsPerPage>20</MailsPerPage>
Mail list is divided into pages. Each page holds specified number of mail messages to display.
Accepted values: 5, 10, 20, 25, 50, 75, 100.
<EnableMailboxSizeLimit>Off</EnableMailboxSizeLimit>
<MailboxSizeLimit>0</MailboxSizeLimit>
Reserved for future use.
<TakeImapQuota>On</TakeImapQuota>
Setting this to On makes WebMail request mailbox size from IMAP server. This works for IMAP accounts only. Quota is optional IMAP extension and not all IMAP servers support it.
Accepted values: On or Off.
<UseSortImapForDateMode>Off</UseSortImapForDateMode>
By default, IMAP sorting is not used when messages are sorted by date, they are shown in the order as they come from IMAP server - even if IMAP sorting is supported. If this option is set to On, IMAP sorting is utilized for date as well.
Full functionality is available starting from version 6.2.5; prior to it, SORT extension enabled on IMAP server is required.
<AllowUsersChangeInterfaceSettings>On</AllowUsersChangeInterfaceSettings>
This option defines whether users are permitted to adjust look and feel for their accounts, such as skin, language etc.
Accepted values: On or Off.
<AllowUsersChangeEmailSettings>On</AllowUsersChangeEmailSettings>
Depending on this option, users can be permitted or disallowed to change email account access details.
Accepted values: On or Off.
<EnableAttachmentSizeLimit>Off</EnableAttachmentSizeLimit>
Specifies whether to limit attachment size or not. Webserver-level settings might still restrict actual size of attachment.
Accepted values: On or Off.
<AttachmentSizeLimit>0</AttachmentSizeLimit>
Specifies maximum allowed size (in Kbytes) of the file to be attached to the message during composing. If the attachment file size exceeds specified limit, it will be rejected.
<AllowLanguageOnLogin>On</AllowLanguageOnLogin>
Shows (On) or hides (Off) language selector on login page where user can choose interface language before logging in.
<FlagsLangSelect>Off</FlagsLangSelect>
Defines how language selector works. When set to Off, it will be simple dropdown in top right corner. When it's On, full language list is displayed as set of flags below login form.
<LoginFormType>Email</LoginFormType>
Default login page view.
Accepted values:
  • Email - full email address is requested;
  • LoginAtDomainDropdown - user should enter username and select domain part from dropdown menu;
  • LoginAtDomain - user should enter username only, while domain part is defined with LoginAtDomainValue;
  • Login - username is entered and search for matching account is performed. If the account doesn't exist, WebMail tries to create it, and domain part is taken from DefaultDomainValue.
<LoginAtDomainValue>mymaildomain.com</LoginAtDomainValue>
If LoginFormType is set to LoginAtDomain, this value will be displayed and added after username to make a complete email address.
<UseLoginAsEmailAddress>On</UseLoginAsEmailAddress>
Use email as login. Default value is On. When set to Off, username part of email address will be used as mail server login.
<DefaultDomainValue />
This parameter is used for building email address when LoginFormType is set to Login, if WebMail Pro was unable to locate any matching account.
<UseAdvancedLogin>Off</UseAdvancedLogin>
Settings this to On allows for entering custom account access details, such as incoming/outgoing hosts and ports. Both mailbox login and email address are to be supplied in this mode.
<UseCaptcha>Off</UseCaptcha>
A security enhancement feature which protects WebMail interface from automated signups and multiple invalid login attempts. By default captcha appears on 3-rd consequent incorrect login attempt by a particular user. Number of incorrect login attempts is configurable in common/inc_constants.php file:

define('CAPTCHA_COUNT_LIMIT', 3);

Please note that GD extension of PHP is required for this to work.

<UseReCaptcha>Off</UseReCaptcha>
You can use Google's Recaptcha as well. If this is set to On, UseCaptcha setting is ignored.
By default, global keys are defined in common/inc_constants.php file: 
define('RECAPTCHA_PRIVATE_KEY', '6LefZb0SAAAAAK5E2Bh8Cg7XOTf9UkBXgStn8ZXF');
define('RECAPTCHA_PUBLIC_KEY', '6LefZb0SAAAAADpYFCCIQakNCvNJTJVdBLp3gFAW');

<AllowNewUsersRegister>On</AllowNewUsersRegister>
Setting this to Off would restrict new users from accessing WebMail. Default value is On. In most cases, there's no need to change this.
<AllowUsersAddNewAccounts>On</AllowUsersAddNewAccounts>
This option allows or forbids creating multiple email accounts per user.
<AllowIdentities>Off</AllowIdentities>
Reserved for future use.
<StoreMailsInDb>Off</StoreMailsInDb>
Deprecated.
<AllowInsertImage>On</AllowInsertImage>
Allow users to include images into the message text via DHTML editor. Set to On by default.
Accepted values: On or Off.
<AllowBodySize>Off</AllowBodySize>
<MaxBodySize>600</MaxBodySize>
Enable or disable max body size of composing message (in characters).
<MaxSubjectSize>255</MaxSubjectSize>
Maximum subject size for a message. Set to 0 for unlimited.
<Layout>Side</Layout>
Switching between two layout modes.
Accepted values: Side or Bottom.
<AlwaysShowImagesInMessage>Off</AlwaysShowImagesInMessage>
On for displaying external images, Off for prompting user on this.
<SaveMail>Always</SaveMail>
Defines whether sent messages are placed to Sent Items folder.
Accepted values: Always, DefaultOn, DefaultOff.
Unless this option's value is set to Always, user can choose the behavior when sending particular mail out.
<IdleSessionTimeout>0</IdleSessionTimeout>
Default session timeout (in seconds). Webserver-level settings might still restrict actual value of timeout. 0 stands for persistent session while browser window is open.
<DetectSpecialFoldersWithXList>On</DetectSpecialFoldersWithXList>
By default, WebMail Pro detects special folders (also known as system ones) based on their name in IMAP folder tree. In case if IMAP server supports XLIST extension, setting this to On allows for detecting special folders even if they're called in non-standard (e.g. localized) manner.
<EnableLastLoginNotification>Off</EnableLastLoginNotification>
With this set to On, the information about previous login will be displayed in user interface.

<Calendar> section

<AllowCalendar>On</AllowCalendar>
Enable/disable Calendar screen.
Accepted values: On or Off.
<ShowWeekends>Off</ShowWeekends>
Accepted values: On or Off.
<WorkdayStarts>9</WorkdayStarts>
<WorkdayEnds>18</WorkdayEnds>
Accepted values: 0...23.
<ShowWorkDay>On</ShowWorkDay>
Accepted values: On or Off.
<WeekStartsOn>Sunday</WeekStartsOn>
Accepted values: Sunday or Monday.
<DefaultTab>Month</DefaultTab>
Accepted values: Day, Week, Month.
<AllowReminders>On</AllowReminders>
Allows for using reminders, assuming the script responsible for this feature is configured. The feature is available in both PHP and ASP.NET editions.
<EnableOutlookSync>On</EnableOutlookSync>
Allows for using Outlook Sync plugin.
<AutoAddInvitation>On</AutoAddInvitation>
Invitation sent from calendar are accepted automatically, event will be added to recipient's calendar. With this option set to Off, recipient's confirmation is required.
<CalDAVUrl>http://127.0.0.1/dav/principals/</CalDAVUrl>
Reserved for future use.

<Contacts> section

<AllowContacts>On</AllowContacts>
Enable/disable Contacts screen.
Accepted values: On or Off.
<ContactsPerPage>20</ContactsPerPage>
Accepted values: 5, 10, 20, 25, 50, 75, 100.

<PersonalAddressBook>
   <Mode>Sql</Mode>
</PersonalAddressBook>
Accepted values: Off, Sql, Ldap (Ldap is reserved for future versions).

<GlobalAddressBook>
   <Mode>Sql</Mode>
   <Sql>
      <Visibility>DomainWide</Visibility>
   </Sql>
</GlobalAddressBook>

Accepted Mode values: Off, Sql, Ldap (Ldap is reserved for future versions).

Global AddressBook Visibility values:
• Off - Global Address Book is disabled, domains settings are ignored;
• SystemWide - Global Address Book is enabled between all the domains, regardless of settings for each particular domain;
• DomainWide - Global Address Book is configured on per-domain basis.

<ShowGlobalContactsInAddressBook>Off</ShowGlobalContactsInAddressBook>
With this option set to On, global address book is displayed as additional tab in Contacts screen of user account.

<StorageTypes> section

This section contains a number of options, all of those are set to db by default. These settings are affected when reconfiguring WebMail Pro PHP to make it work without using a database.

Advanced configuration

In PHP edition, there's one more configuration file available. Read detailed info on configuring lowest level of WebMail Pro functionality.

Last edit: 2012/2/29

WebMail Pro PHP documentation
WebMail Pro .NET documentation

Installation

Configuring WebMail

Customization

Synchronization

Clustering

Integration

See Also

Retrieved from "http://jp.afterlogic.com/wiki/Configuring_WebMail_via_settings.xml_file_(WebMail_Pro_6)"