Domain Specific Settings

Domain specific settings

Note: Most 'matching' settings take wild card lists as parameters, for example "fred*" will match "freddy" and "fred@bob". And "1.2.*,2.3.*" will match 1.2.4.4 and 2.3.99.100.

Domain Name

This is the name of this virtual domain of the mail server. The mail server supports any number of virtual domains. See this page for a discussion on different types of virtual domains.

Virtual Domain IP

This is the IP number of this virtual domain. You will also need to configure your operating system and network to respond to this IP address. Doing this for specific operating systems is described on this page in more detail.

fallback - Fallback Email address or account

Specifies a default account to deliver Email to, this is sent to a non existent account. If not defined, the Email will be bounced. Setting fallback to "/dev/null" will drop messages (both UNIX and Windows).

fallback_relay - Fallback host to relay non existent accounts to

Specifies a default host to send messages to that are not found in the local user database. This allows you to transition between two mail systems, as new accounts are created the emails will be delivered to SurgeMail, and ones that don't exist will be sent on to the old system automatically. There are several options to make this work using servers that only accept mail if they can do a reverse lookup.

create_block - Block new users from this IP

Stops users from specific IP addresses from registering in this domain (assuming that you have allowed users to register themselves). Use this to stop known spammers from re-registering on your system.

create_user - Method for adding new users

Can be one of, "open, Email, manager". Open = anyone can create their own account. Email = anyone create their own account but must have an existing working Email account to complete the process. Manager = anyone can create an account but the account is not activated until the manager approves it via an Email that they receive.

create_max - Maximum signups from one IP in a day

This setting stops spammers registering hundreds of accounts on your system before sending out a lot of spam. A setting of 2-3 is probably a good idea.

create_subdomain - Allows users to create an account that belongs to it's own unique domain.

If true, allows users to create accounts with a unique subdomain i.e. firstname@lastname.domain

create_reqd - Required fields for new users

A comma separated list of field names. Allowable field names are the "field" value(s) of the g_authent_info setting.

For example, if your setting is:
       name,phone
then when a new user is created they will be forced to fill in the name and phone fields in the registration form.

create_repass - User enters password twice on creation

If true, this will show a "Password Again" input in addition to the "Password" input on the user signup page, the user is required to type the password in twice and the passwords are compared to ensure they are identical.

create_tpl_dir - Relative path to user create pages

The relative path from the web directory to the user creation and user self management pages, these pages are typically called na_*.htm and stored in the /web directory. If you want a different look and feel for a domain simply set this and copy the pages to a directory in /web then modify them.

For example, if your setting is:
       otherdomain/

Then you would:
       cd /surgemail/web
       mkdir otherdomain
       copy na_*.htm otherdomain
       cd otherdomain
       notepad na_login.htm

dmail_drop_path - Path for drop files to automatically convert

Path for dmail / sendmail style drop files to automatically convert. This allows you to import delivered but unpopped mail from standard drop files. While this is set, a check is done whether a drop file needs to be imported each time a user logs on. Any mail is converted on the fly and added to the user's surgemail inbox.

dmail_bin_path - Path for dmail bin files to automatically convert

Path for dmail style bin files to automatically convert. This allows you to import delivered but unpopped mail from dmail bin and mailbox files. While this is set, a check is done whether this import needs to be done each time a user logs on. Any mail is converted on the fly and added to the user's surgemail inbox.

dmail_hash - Hashing scheme used by dmail_drop_path and dmail_bin_path

Dmail style hashing scheme used by dmail_drop_path and dmail_bin_path.

user_max - Maximum user allowed in this domain

This setting specifies the maximum number of users in this domain. Domain admins and users are blocked from adding more users than specified in this setting. The admin can still add users.

user_sms - Enable users to setup SMS notifications

This setting allows users to setup an SMS notification of email whose subject matches the user defined keyword.

expire_age - Expire undeleted mail older than specified age

Use this to trim messages that are not read by users. The deleted messages are replaced with a single message explaining which items have been deleted (with from, subject, date of each message deleted so that anything really important can be recovered). You should define both age and size to enable expiration.

Currently expire ONLY affects 'newmail' i.e. mail that is waiting to be read not mail stored in IMAP folders.

expire_size - Expire undeleted mail larger than specified size (units=bytes)

Use this to trim messages that are not read by users, the deleted messages are replaced with a single message explaining which items have been deleted (with from, subject, date of each message deleted so that anything really important can be recovered). You should define both age and size to enable expiration.

host_alias - Alias name(s) for this virtual domain

When a user sends to 'bob@xx.your.domain.name' or 'bob@yy.your.domain.name' you need to have the alias host names 'xx.your.domain.name' etc, defined or the mail server will reject the message. Wild card's can be used for this setting. Example: host_alias "*.your.domain.name"

manager_email - Managers Email

This is the manager's Email address for this domain. When users register themselves, if you have set create_user to the 'manager' method, an Email will be sent to this Email address to await confirmation of the user creation.

manager_username - Managers user name

Specifies the local user who has manager rights for this domain, this user can add/remove users, etc, and do general administration tasks within this virtual domain using the web admin tool http://your.server:7025

mailbox_path - Path to mailbox maildir (inbox) files

Specifies the root directory for users in this domain for their incoming mail messages and mail folders (for IMAP), maildir structure is used and hashing will also be applied so if you specify d:\spool, then 'bob's Email will appear in d:\spool\xx\yy\bob\mdir... where 'xx' and 'yy' are hashing numbers for that user. (Hashing is required to keep directory performance at a high level when you have millions of users).

old_pophost - Old pop host for pop intercept mode based migration

Specifies an old POP host that can be used when migrating users from an old mailserver to a new mailserver. This will create a local accounts with a identical username/passwords and retrieve all mail from the old server for the old account when the user logs into surgemail for the first time and they are not yet in the surgemail user database. Mail on the old server is deleted.

pop_welcome - Welcome message for POP/IMAP

This is the string displayed to the user when they connect to this domain, before they login. The same string is also used in IMAP response. See also smtp_welcome.

prefix - Prefix for usernames in database

This prefix is used in the userdatabase to distinguish these virtual domain users. This setting is for backward compatibility and not generally recommended. It is better to store user@domain.name in the userdatabase rather than just 'username'.

quota_default - Default Email quota for users

This setting allows you to limit disk usage of each user, a setting of 10mb is typical. The main reason for this setting is to stop a single user who is being mail bombed using up all your disk space, so even if you don't want to limit disk use you should still set some limit, e.g. 100000000 (100mb)

redirect - Redirect Email to another account

This redirects mail from one user to another. The destination can be a full Email address with another domain name.

alias_file - Alias file

In addition, each domain has it's own 'alias' file (domain.name/alias.dat). You can create alias files using the same syntax as used in Unix systems /etc/aliases. The format is:
username:   destination
bob:            fred@domain.com
joe:             joesmith
This file only exists for backward compatibility.

redirect_cc - CC & Redirect Email to another account

This carbon copy redirects a message so the original user receives it as well as the new user you have specified. This is good for keeping a record of incoming emails for a particular account.

smtp_welcome - Welcome message for SMTP

This is the string displayed to the user when they connect to this domain, before they login. See also pop_welcome

url_host - Hostname to use in url's to this domain

This hostname is used in URL's to then user.cgi in the email sent to user upon signup, the email sent to the manager when a user signs up and is the host passed to webmail when auto-logging a user in. If your auto-logins are failing because of a "cannot connect error" then you may need to set this to the correct host.