com.ericdaugherty.mail.server.configuration
Interface ConfigurationParameterConstants

All Known Implementing Classes:
ConfigurationManager, DeliveryService

public interface ConfigurationParameterConstants

This interface defines the names for all configuration properties loaded from the configuration file. This interface also serves as documentation for the possible parameters and their expected values.

Descriptions of the parameters are also available in the ConfigurationTool java application included with this distribution.

Author:
Eric Daugherty

Field Summary
static java.lang.String ACTIVATE_AMAVISD
           
static java.lang.String ADD_PCT_RCPT
           
static java.lang.String ALLOWCLEARTEXT
          Controls whether or not clear text passwords are allowed
static int ALWAYS
           
static java.lang.String AMAVISD_FILTERED_SMTPPORT
           
static java.lang.String AMAVISD_INCOMING_DIRECTORY
           
static java.lang.String AMAVISD_LISTEN_ADDRESS
           
static java.lang.String AMAVISD_SMTPPORT
           
static java.lang.String[] CLIENTAUTH_TYPE
          The acceptable types of client-auth in a TLS/SSL context
static java.lang.String CONFIG_ADDRESS
           
static java.lang.String CONFIG_PORT
           
static java.lang.String DEFAULT_MAILBOX
          The default user to deliver mail addressed to local unknown users.
static java.lang.String DEFAULT_SMTP_SERVERS
          The default server to deliver mail addressed to remote users.
static java.lang.String DISABLE_WARNING
           
static java.lang.String DOMAINS
          The domains parameter defines the domain names that this server will accept mail for.
static java.lang.String ENABLE_HELO
           
static java.lang.String ENABLE_SECURITYMANAGER
           
static java.lang.String[] ENABLED_CIPHERS
          The acceptable ciphers for a secure session
static java.lang.String[] ENABLED_PROTOCOLS
          The acceptable protocols for a secure session
static int ENCRYPTEDONLY
           
static java.lang.String EXECUTE_THREADS
          The number of threads that will be allocated to each connection listener for each port.
static java.lang.String EXTERNAL_DELEGATED
           
static java.lang.String FILE_ENCODING
           
static java.lang.String KEYSTORELOCATION
          The keystore complete path
static java.lang.String KEYSTOREPROVIDER
          The keystore provider
static java.lang.String KEYSTORETYPE
          The keystore type
static java.lang.String LISTEN_ADDRESS
          The local IP address that the server will listen on.
static java.lang.String LOCALE_COUNTRY
           
static java.lang.String LOCALE_LANGUAGE
           
static java.lang.String LOGGING_DEFAULT_THRESHOLD
          Defines the default log threshold to use if log4j is not enabled.
static java.lang.String MAIL_RETRIEVAL_MODE
           
static java.lang.String MAIL_TRANSFER_MODE
           
static java.lang.String MAX_ERROR_COUNT
          The maximum total number of errors before the connection is forcibly closed
static java.lang.String MAX_PASS_ATTEMPTS
           
static java.lang.String MAX_VALID_RCPT
           
static java.lang.String MIME8BIT
           
static java.lang.String MIN_PCT_FAIL_RCPT
           
static java.lang.String MIN_TOT_FAIL_RCPT
           
static int NEVER
           
static java.lang.String NOTIFY_DEFAULT
           
static java.lang.String OS_NAME
           
static java.lang.String OUTGOINGSECURE
          Use TLS/SSL if the server being contacted when sending messages supports the "STARTTLS" extension (RFC 3207)
static java.lang.String POP3PORT
          The pop3port parameter defines the port to listen to incoming Pop3 connection on.
static java.lang.String REALM_DEF_PREFIX
          Defines the prefix to realms stored in the properties file.
static java.lang.String REJECT_NON_EXISTENT_LOCAL
           
static java.lang.String RELAY_ADDRESSLIST
          This is the label for the UI
static java.lang.String RELAY_EMAILSLIST
          Enables some email addresses for SMTP Relaying.
static java.lang.String RELAY_POP_BEFORE_SMTP
          Enables the POP3 login as a valid address for SMTP Relaying.
static java.lang.String RELAY_POP_BEFORE_SMTP_TIMEOUT
          This setting only applies when RELAY_POP_BEFORE_SMTP is set to true.
static java.lang.String SASL_DIGEST_MD5_CIPHERS
           
static java.lang.String SASL_DIGEST_MD5_ENABLE
           
static java.lang.String SASL_GSS_ENABLE
           
static java.lang.String SASL_GSS_KDC
           
static java.lang.String SASL_GSS_KEYTAB
           
static java.lang.String SASL_GSS_PRINCIPAL
           
static java.lang.String SASL_GSS_REALM
           
static java.lang.String SASL_GSS_STOREKEY
           
static java.lang.String SASL_GSS_USEKEYTAB
           
static java.lang.String SASL_QOP
           
static java.lang.String SECURE_EXECUTE_THREADS
          The number of threads that will be allocated to each secure connection listener for each port.
static java.lang.String SECUREACTIVE
          Controls whether or not the secure server modules will be activated
static java.lang.String SECUREPOP3PORT
          The pop3port parameter defines the port to listen to incoming Pop3 connection on.
static java.lang.String SECURESMTPPORT
          The smtpport parameter defines the port to listen to incoming SMTP connection on.
static java.lang.String SMTP_DELIVERY_INTERVAL
          The server stores incoming SMTP messages on disk before attempting to deliver them.
static java.lang.String SMTP_DELIVERY_THRESHOLD
          The server picks the messages from the disk in order to deliver them.
static java.lang.String SMTP_MAX_MESSAGE_SIZE
          This setting limits the size of incoming SMTP messages.
static java.lang.String SMTPDIRECTORY
          The directory used to store incoming messages.
static java.lang.String SMTPPORT
          The smtpport parameter defines the port to listen to incoming SMTP connection on.
static java.lang.String STANDARDPOP3SECURE
           
static java.lang.String STANDARDSMTPSECURE
          A parameter that toggles TLS/SSL use on standard ports.
static java.lang.String TESTING_DESTINATION
           
static java.lang.String TRUSTSTORELOCATION
          The truststore complete path
static java.lang.String TRUSTSTOREPROVIDER
          The truststore provider
static java.lang.String TRUSTSTORETYPE
          The truststore type
static java.lang.String USER_DEF_PREFIX
          Defines the prefix to usernames stored in the properties file.
static java.lang.String USER_FILE_FORWARDS
          The USER_PROPERTY_PREFIX<user@domain.com>.<forwardAddresses>=<value> property defines a comma separated list of addresses that mail to this user will be forwarded to.
static java.lang.String USER_PROPERTY_PREFIX
          Defines the prefix for user properties usernames stored in the properties file.
static java.lang.String USERSDIRECTORY
          The directory used to store the user accounts.
static java.lang.String VERIFY_IP
           
 

Field Detail

MAIL_TRANSFER_MODE

static final java.lang.String MAIL_TRANSFER_MODE
See Also:
Constant Field Values

MAIL_RETRIEVAL_MODE

static final java.lang.String MAIL_RETRIEVAL_MODE
See Also:
Constant Field Values

LISTEN_ADDRESS

static final java.lang.String LISTEN_ADDRESS
The local IP address that the server will listen on. If this property is not set, or is invalid, the server will listen on all addresses.

See Also:
Constant Field Values

SMTPDIRECTORY

static final java.lang.String SMTPDIRECTORY
The directory used to store incoming messages.

See Also:
Constant Field Values

USERSDIRECTORY

static final java.lang.String USERSDIRECTORY
The directory used to store the user accounts.

See Also:
Constant Field Values

CONFIG_ADDRESS

static final java.lang.String CONFIG_ADDRESS
See Also:
Constant Field Values

CONFIG_PORT

static final java.lang.String CONFIG_PORT
See Also:
Constant Field Values

POP3PORT

static final java.lang.String POP3PORT
The pop3port parameter defines the port to listen to incoming Pop3 connection on. By default, this value should be 110.

See Also:
Constant Field Values

SMTPPORT

static final java.lang.String SMTPPORT
The smtpport parameter defines the port to listen to incoming SMTP connection on. By default, this value should be 25.

See Also:
Constant Field Values

LOCALE_COUNTRY

static final java.lang.String LOCALE_COUNTRY
See Also:
Constant Field Values

LOCALE_LANGUAGE

static final java.lang.String LOCALE_LANGUAGE
See Also:
Constant Field Values

FILE_ENCODING

static final java.lang.String FILE_ENCODING
See Also:
Constant Field Values

OS_NAME

static final java.lang.String OS_NAME
See Also:
Constant Field Values

DOMAINS

static final java.lang.String DOMAINS
The domains parameter defines the domain names that this server will accept mail for. All domains not listed here will will either be relayed or ignored. To configure mulitiple domains, just seperate each domain with a comma.

See Also:
Constant Field Values

EXECUTE_THREADS

static final java.lang.String EXECUTE_THREADS
The number of threads that will be allocated to each connection listener for each port.

See Also:
Constant Field Values

MIME8BIT

static final java.lang.String MIME8BIT
See Also:
Constant Field Values

DEFAULT_MAILBOX

static final java.lang.String DEFAULT_MAILBOX
The default user to deliver mail addressed to local unknown users.

See Also:
Constant Field Values

DEFAULT_SMTP_SERVERS

static final java.lang.String DEFAULT_SMTP_SERVERS
The default server to deliver mail addressed to remote users.

See Also:
Constant Field Values

RELAY_POP_BEFORE_SMTP

static final java.lang.String RELAY_POP_BEFORE_SMTP
Enables the POP3 login as a valid address for SMTP Relaying.

See Also:
Constant Field Values

RELAY_POP_BEFORE_SMTP_TIMEOUT

static final java.lang.String RELAY_POP_BEFORE_SMTP_TIMEOUT
This setting only applies when RELAY_POP_BEFORE_SMTP is set to true. This setting defines the timeout period (in minutes) between when a user (ip address) last authenticated with the POP3 server and when they will no longer be able to send SMTP mail to remote domains. This option defaults to 10 minutes.

See Also:
Constant Field Values

RELAY_ADDRESSLIST

static final java.lang.String RELAY_ADDRESSLIST
This is the label for the UI

See Also:
Constant Field Values

RELAY_EMAILSLIST

static final java.lang.String RELAY_EMAILSLIST
Enables some email addresses for SMTP Relaying.

See Also:
Constant Field Values

SMTP_DELIVERY_INTERVAL

static final java.lang.String SMTP_DELIVERY_INTERVAL
The server stores incoming SMTP messages on disk before attempting to deliver them. This setting determines how often (in seconds) the server checks the disk for new messages to deliver. The smaller the number, the faster message will be processed. However, a smaller number will cause the server to use more of your system's resources.

See Also:
Constant Field Values

SMTP_DELIVERY_THRESHOLD

static final java.lang.String SMTP_DELIVERY_THRESHOLD
The server picks the messages from the disk in order to deliver them. If some message cannot be delivered to remote SMTP server at that moment, because of some error, then the message will be kept on the disk for later delivery attempt. However server can't retry delivery indefinitely, therefore following config entry will set maximum number of retries before the server gives up on the message and moves it from smtp spool directory to failed directory.

See Also:
Constant Field Values

SMTP_MAX_MESSAGE_SIZE

static final java.lang.String SMTP_MAX_MESSAGE_SIZE
This setting limits the size of incoming SMTP messages. This setting (in megabytes) will cause emails over the max size to be rejected.

See Also:
Constant Field Values

USER_DEF_PREFIX

static final java.lang.String USER_DEF_PREFIX
Defines the prefix to usernames stored in the properties file. A username should be stored as: USER_DEF_PREFIX<user@domain.com>=<password>

See Also:
Constant Field Values

REALM_DEF_PREFIX

static final java.lang.String REALM_DEF_PREFIX
Defines the prefix to realms stored in the properties file.

See Also:
Constant Field Values

USER_PROPERTY_PREFIX

static final java.lang.String USER_PROPERTY_PREFIX
Defines the prefix for user properties usernames stored in the properties file. A user property should be stored as: USER_PROPERTY_PREFIX<user@domain.com>.<property name>=<value>

See Also:
Constant Field Values

USER_FILE_FORWARDS

static final java.lang.String USER_FILE_FORWARDS
The USER_PROPERTY_PREFIX<user@domain.com>.<forwardAddresses>=<value> property defines a comma separated list of addresses that mail to this user will be forwarded to.

See Also:
Constant Field Values

LOGGING_DEFAULT_THRESHOLD

static final java.lang.String LOGGING_DEFAULT_THRESHOLD
Defines the default log threshold to use if log4j is not enabled.

See Also:
Constant Field Values

STANDARDSMTPSECURE

static final java.lang.String STANDARDSMTPSECURE
A parameter that toggles TLS/SSL use on standard ports.

See Also:
Constant Field Values

STANDARDPOP3SECURE

static final java.lang.String STANDARDPOP3SECURE
See Also:
Constant Field Values

SECUREACTIVE

static final java.lang.String SECUREACTIVE
Controls whether or not the secure server modules will be activated

See Also:
Constant Field Values

ALLOWCLEARTEXT

static final java.lang.String ALLOWCLEARTEXT
Controls whether or not clear text passwords are allowed

See Also:
Constant Field Values

ALWAYS

static final int ALWAYS
See Also:
Constant Field Values

ENCRYPTEDONLY

static final int ENCRYPTEDONLY
See Also:
Constant Field Values

NEVER

static final int NEVER
See Also:
Constant Field Values

SECUREPOP3PORT

static final java.lang.String SECUREPOP3PORT
The pop3port parameter defines the port to listen to incoming Pop3 connection on. By default, this value should be 995.

See Also:
Constant Field Values

SECURESMTPPORT

static final java.lang.String SECURESMTPPORT
The smtpport parameter defines the port to listen to incoming SMTP connection on. By default, this value should be 465.

See Also:
Constant Field Values

OUTGOINGSECURE

static final java.lang.String OUTGOINGSECURE
Use TLS/SSL if the server being contacted when sending messages supports the "STARTTLS" extension (RFC 3207)

See Also:
Constant Field Values

SECURE_EXECUTE_THREADS

static final java.lang.String SECURE_EXECUTE_THREADS
The number of threads that will be allocated to each secure connection listener for each port.

See Also:
Constant Field Values

KEYSTORELOCATION

static final java.lang.String KEYSTORELOCATION
The keystore complete path

See Also:
Constant Field Values

KEYSTOREPROVIDER

static final java.lang.String KEYSTOREPROVIDER
The keystore provider

See Also:
Constant Field Values

KEYSTORETYPE

static final java.lang.String KEYSTORETYPE
The keystore type

See Also:
Constant Field Values

TRUSTSTORETYPE

static final java.lang.String TRUSTSTORETYPE
The truststore type

See Also:
Constant Field Values

TRUSTSTORELOCATION

static final java.lang.String TRUSTSTORELOCATION
The truststore complete path

See Also:
Constant Field Values

TRUSTSTOREPROVIDER

static final java.lang.String TRUSTSTOREPROVIDER
The truststore provider

See Also:
Constant Field Values

ENABLED_CIPHERS

static final java.lang.String[] ENABLED_CIPHERS
The acceptable ciphers for a secure session


ENABLED_PROTOCOLS

static final java.lang.String[] ENABLED_PROTOCOLS
The acceptable protocols for a secure session


ENABLE_SECURITYMANAGER

static final java.lang.String ENABLE_SECURITYMANAGER
See Also:
Constant Field Values

ENABLE_HELO

static final java.lang.String ENABLE_HELO
See Also:
Constant Field Values

NOTIFY_DEFAULT

static final java.lang.String NOTIFY_DEFAULT
See Also:
Constant Field Values

DISABLE_WARNING

static final java.lang.String DISABLE_WARNING
See Also:
Constant Field Values

EXTERNAL_DELEGATED

static final java.lang.String EXTERNAL_DELEGATED
See Also:
Constant Field Values

CLIENTAUTH_TYPE

static final java.lang.String[] CLIENTAUTH_TYPE
The acceptable types of client-auth in a TLS/SSL context


REJECT_NON_EXISTENT_LOCAL

static final java.lang.String REJECT_NON_EXISTENT_LOCAL
See Also:
Constant Field Values

MAX_ERROR_COUNT

static final java.lang.String MAX_ERROR_COUNT
The maximum total number of errors before the connection is forcibly closed

See Also:
Constant Field Values

MAX_VALID_RCPT

static final java.lang.String MAX_VALID_RCPT
See Also:
Constant Field Values

ADD_PCT_RCPT

static final java.lang.String ADD_PCT_RCPT
See Also:
Constant Field Values

MIN_TOT_FAIL_RCPT

static final java.lang.String MIN_TOT_FAIL_RCPT
See Also:
Constant Field Values

MIN_PCT_FAIL_RCPT

static final java.lang.String MIN_PCT_FAIL_RCPT
See Also:
Constant Field Values

MAX_PASS_ATTEMPTS

static final java.lang.String MAX_PASS_ATTEMPTS
See Also:
Constant Field Values

VERIFY_IP

static final java.lang.String VERIFY_IP
See Also:
Constant Field Values

SASL_QOP

static final java.lang.String SASL_QOP
See Also:
Constant Field Values

SASL_DIGEST_MD5_ENABLE

static final java.lang.String SASL_DIGEST_MD5_ENABLE
See Also:
Constant Field Values

SASL_DIGEST_MD5_CIPHERS

static final java.lang.String SASL_DIGEST_MD5_CIPHERS
See Also:
Constant Field Values

SASL_GSS_ENABLE

static final java.lang.String SASL_GSS_ENABLE
See Also:
Constant Field Values

SASL_GSS_REALM

static final java.lang.String SASL_GSS_REALM
See Also:
Constant Field Values

SASL_GSS_KDC

static final java.lang.String SASL_GSS_KDC
See Also:
Constant Field Values

SASL_GSS_PRINCIPAL

static final java.lang.String SASL_GSS_PRINCIPAL
See Also:
Constant Field Values

SASL_GSS_STOREKEY

static final java.lang.String SASL_GSS_STOREKEY
See Also:
Constant Field Values

SASL_GSS_USEKEYTAB

static final java.lang.String SASL_GSS_USEKEYTAB
See Also:
Constant Field Values

SASL_GSS_KEYTAB

static final java.lang.String SASL_GSS_KEYTAB
See Also:
Constant Field Values

ACTIVATE_AMAVISD

static final java.lang.String ACTIVATE_AMAVISD
See Also:
Constant Field Values

AMAVISD_INCOMING_DIRECTORY

static final java.lang.String AMAVISD_INCOMING_DIRECTORY
See Also:
Constant Field Values

AMAVISD_LISTEN_ADDRESS

static final java.lang.String AMAVISD_LISTEN_ADDRESS
See Also:
Constant Field Values

AMAVISD_SMTPPORT

static final java.lang.String AMAVISD_SMTPPORT
See Also:
Constant Field Values

AMAVISD_FILTERED_SMTPPORT

static final java.lang.String AMAVISD_FILTERED_SMTPPORT
See Also:
Constant Field Values

TESTING_DESTINATION

static final java.lang.String TESTING_DESTINATION
See Also:
Constant Field Values