WebMail Pro PHP documentation

Configuring WebMail via settings.xml file

Summary

This article describes each parameter from 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.

<Common> section

<SiteName>AfterLogic WebMail Pro</SiteName>

Default title that will be shown in browser's header (Default domain settings).

<LicenseKey>WM700-XXXXXXXXXXXXXXXXXXXXXXXXXXXX-YYYYYYYYY</LicenseKey>

License key is supplied here.

<AdminLogin>mailadm</AdminLogin>

<AdminPassword>827ccb0eea8a706c4c34a16891f84e7b</AdminPassword>

Administrative credentials. Password is usually stored as MD5 hash, the above value represendts password 12345.

<DBType>MySQL</DBType>

Database engine used. Currently, only MySQL is supported.

<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 />

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 /i18n directory.

<DefaultTimeZone>0</DefaultTimeZone>

Default timezone offset, 0 stands for UTC.

<DefaultTimeFormat>F24</DefaultTimeFormat>

Default time format. Accepted values: F12 (for AM/PM) or F24.

<AllowRegistration>Off</AllowRegistration>

<RegistrationDomains />

<RegistrationQuestions />

<AllowPasswordReset>Off</AllowPasswordReset>

The above options are specific to MailSuite Pro and MTA edition of Aurora. They control user self-signup and password reset features.

<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. Detailed information is available here.

<EnableMobileSync>Off</EnableMobileSync>

This defines whether users are able to use mobile sync. See Mobile sync for details.

<LoginStyleImage />

<AppStyleImage />

Valid for WebMail Pro, MailSuite and Aurora.
If specified, the values denote URL for logos used on login screen and at top-left corner within the interface, respectively. The values are to be supplied via AdminPanel on Branding screen.

<InvitationEmail />

Aurora only; denotes email address used for sending invitations out.

<DefaultTab />

Specifies default screen users are redirected to upon logging in.
Accepted values: Login, Information, Header, Mailbox, SingleMessageView, Compose, SingleCompose, Settings, Contacts, Calendar, FileStorage, Helpdesk, SingleHelpdesk.

<RedirectToHttps>Off</RedirectToHttps>

If this is set to On, users will be automatically redirected to the installation accessed with https:// specified if they attempt to use http://.

<PasswordMinLength>0</PasswordMinLength>

<PasswordMustBeComplex>Off</PasswordMustBeComplex>

The values are used by Password change via LDAP plugin.

<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.

<ShowQuotaBar>Off</ShowQuotaBar>

Defines whether disk space usage information should be rendered in WebMail interface. See Displaying account quota bar for details.

<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 (also referred to as theme) for WebMail appearance. List of skins is supplied in data/settings/config.php file.

<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.

<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>

Defines login page format.
Accepted values:

* Email - full email address is required;

* Login - user should enter username only, while domain part is defined with LoginAtDomainValue;

* Both - mailserver username and email address need to be entered on login screen.

The option is supported starting from v7.1.1.

<LoginSignMeType>DefaultOff</LoginSignMeType>

Defines "Remember me" checkbox behavior.
Accepted values:

* DefaultOff - the option is inactive by default;

* DefaultOn - the option is selected by default;

* Unuse - the option is not displayed.

The option is supported starting from v7.1.1.

<LoginAtDomainValue>somedomain.com</LoginAtDomainValue>

The option is used when login form is configured for entering username only, email address is built by "@" and domain name appended to username.

The option is supported starting from v7.1.1.

<UseLoginWithoutDomain>Off</UseLoginWithoutDomain>

Determines whether email or just its username part should be used as mail server login.

* Off - username is sent as mail server login;

* On - full email address is sent as mail server login.

The option is supported starting from v7.1.1.

<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.

<AllowOpenPGP>On</AllowOpenPGP>

Enables OpenPGP support.

<AllowIdentities>On</AllowIdentities>

Enables identities.

<AllowBodySize>Off</AllowBodySize>

<MaxBodySize>On</MaxBodySize>

<MaxSubjectSize>On</MaxSubjectSize>

Allows for setting limits for length of message body or subject.

<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.

<Layout>Side</Layout>

Legacy value used in previous versions for switching interface layout mode, not used in current version.

<AlwaysShowImagesInMessage>Off</AlwaysShowImagesInMessage>

On for displaying external images, Off for prompting user on this.

<SaveMail>Off</SaveMail>

Always to save sent mails on IMAP (default value), DefaultOn / DefaultOff offer checkbox for saving mails, checked and unchecked by default respectively.

<IdleSessionTimeout>0</IdleSessionTimeout>

Defines amount of time (in minutes) user needs to be inactive before their session is terminated and they're logged out due to inactivity. By default, the value is 0 and logout due to inactivity is not performed.

<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.

<ExternalHostNameOfLocalImap />

<ExternalHostNameOfLocalSmtp />

<ExternalHostNameOfDAVServer />

The above settings are used for mobile sync and denote hostnames for IMAP, SMTP and DAV server respectively. Values like 127.0.0.1 won't work here, mobile devices would require hostname which can be used to access server externally.

<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 as described here.

<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.

<ShowGlobalContactsInAddressBook>On</ShowGlobalContactsInAddressBook>

Valid for WebMail Pro, MailSuite and Aurora.
Enable/disable Global address book feature.

Accepted values: On or Off.
If set to On, global address book settings are available in AdminPanel and the feature can be enabled for specific domain.
If set to Off, global address book feature is disabled globally on the product installation.

<GlobalAddressBookVisibility>20</GlobalAddressBookVisibility>

Valid for WebMail Pro, MailSuite and Aurora.
Denotes default visibility setting for global address book.

Accepted values:
  • Off - global address book is disabled for specific domain;
  • DomainWide - global address book shows users of the same domain;
  • SystemWide - global address book shows users of the entire installation;
  • TenantWide - global address book shows users of current tenant. (Aurora only)
  • <Files> section

    <AllowFiles>On</AllowFiles>

    Enable/disable Files screen.
    Accepted values: On or Off.

    <EnableSizeLimit>On</EnableSizeLimit>

    Enable/disable files size limit.
    Accepted values: On or Off.

    <SizeLimit>0</SizeLimit>

    Denotes file size limit (in Kbytes). If set to 0, there is no limit imposed.

    Advanced configuration

    There's one more configuration file data/settings/config.php available. Read detailed info on configuring lowest level of WebMail Pro functionality.