Sun Java System Messaging Server 6 2005Q1 Administration Reference |
Chapter 3
Messaging Server ConfigurationThis chapter lists the configuration parameters for the Messaging Server. These parameters can be set via the configutil command. For a full description and syntax of the configutil command, see configutil.
For information about configuring the MTA, see Chapter 4, "MTA Configuration."
configutil Parameters
Table 3-1 configutil Parameters
Parameter
Description
alarm.msgalarmnoticehost
Machine to which you send warning messages. If not set, localhost will be used. If you are using LMTP, set this to the machine name of the LMTP host.
Default: localhost
alarm.msgalarmnoticeport
The SMTP port to which to connect when sending alarm messages.
Default: 25
alarm.msgalarmnoticercpt
Recipient of alarm notice.
Default: Postmaster@localhost
alarm.msgalarmnoticesender
Address of sender of alarm.
Default: Postmaster@localhost
alarm.msgalarmnoticetemplate
Message template. %s in the template is replaced with the following (in order): sender, recipient, alarm description, alarm instance, alarm current value and alarm summary text
alarm.diskavail.msgalarmstatinterval
Interval in seconds between disk availability checks. Set to 0 to disable checks of disk usage.
Default: 3600
alarm.diskavail.msgalarmthreshold
Percentage of disk space availability below which an alarm is sent.
Default: 10
alarm.diskavail.msgalarmthresholddirection
Specifies whether the alarm is issued when disk space availability is below threshold (-1) or above it (1).
Default: -1
alarm.diskavail.msgalarmwarninginterval
Interval in hours between subsequent repetition of disk availability alarms.
Default: 24
alarm.diskavail.msgalarmdescription
Text for the description field in the disk availability alarm message.
Default: “precentaage mail partition diskspace available.”
alarm.serverresponse.msgalarmdescription
Text for the description field in the server response alarm message.
Default: “server response time in seconds.”
alarm.serverresponse.msgalarmstatinterval
Checking interval (seconds). Set to 0 to disable checking of server response. Default: 600
alarm.serverresponse.msgalarmthreshold
If server response time in seconds exceeds this value, alarm issued.
Default: 10
alarm.serverresponse.msgalarmthresholddirection
Specifies whether alarm is issued when server response time is greater than (1) or less than (-1) the threshold.
Default: 1
alarm.serverresponse.msgalarmwarninginterval
Interval in hours between subsequent repetition of server response alarm.
Default: 24
encryption.nsssl2
Default: no
encryption.nsssl2ciphers
Comma-delineated list of ciphers
encryption.nsssl3
Default: yes
encryption.nsssl3ciphers
Default: rsa_rc4_40_md5, rsa_rc2_40_md5, rsa_des_sha,rsa_rc4_128_md5, rsa_3des_sha
encryption.nsssl3sessiontimeout
Default: 0
encryption.nssslclientauth
Default: 0
encryption.nssslsessiontimeout
Default: 0
encryption.fortezza.nssslactivation
Default: off
encryption.rsa.nssslactivation
Default: on
encryption.rsa.nssslpersonalityssl
Default: Server-Cert
encryption.rsa.nsssltoken
Default: internal
gen.accounturl
Location of the server administration resource for end users.
Default: http://%U@[Hostname]:[AdminPort]/bin/user/admin/bin/enduser
gen.configversion
Configuration version. Default: 4.0.
gen.filterurl
URL for incoming mail (server side) filter.
gen.folderurl
URL for personal folder management.
gen.installedlanguages
Default: en
gen.listurl
URL for mailing list management.
gen.newuserforms
Welcome message for new users.The maximum size is 1 MB.
gen.sitelanguage
Default language tag. Default: en.
local.autorestart
Enable automatic restart of failed or frozen (unresponsive) servers including IMAP, POP, HTTP, job controller, dispatcher, and MMP servers.
Default: Off
local.autorestart.timeout
Failure retry time-out. If a server fails more than twice during this designated period of time, then the system will stop trying to restart this server. If this happens in an HA system, Messaging Server is shutdown and a failover to the other system occurs. The value (set in seconds) should be set to a period value longer than the msprobe interval. (See ocal.schedule.msprobe.)
Default: 600 seconds
local.cgiexeclist
List of pattern string used to match command to be executed.
local.dbstat.captureinterval
Interval to capture db statistics into counters (seconds). Default: 3600.
local.defdomain
Default domain - set by install.
local.enablelastaccess
Enables imsconnutil to provide last log in information.
local.enduseradmincred
Password for end user administrator.
local.enduseradmindn
User id for end user administrator.
local.ens.enable
Enable ens server on start-msg startup.
Default: On
local.ens.port
Set ENS (Event Notification Server) port and/or address.
Syntax: configutil local.ens.port [address:]port
Default: The ENS default
local.hostname
Fully qualified DNS hostname of this mail server.
,local.http.enableuserlist
Enables imsconnutil on Messenger Express service.
local.imap.enableuserlist
Enables imsconnutil on IMAP service.
local.imap.immediateflagupdate
When set to yes, all changes to flags (message status) are updated in the database on disk immediately, instead of being buffered and updated once in a while.
Default: no
local.imta.enable
Enable imta server on start-msg startup.
Default: On
local.imta.hostnamealiases
Defines the list of hosts used to determine the local host name in direct LDAP lookups. The length limit is 1024. This parameter can be overridden with the LDAP_HOST_ALIAS_LIST MTA option.
local.imta.imta_tailor
Location of the imta_tailor file for this MTA instance.
local.imta.lookupandsync
Defines which type of entries should be synched when using the direct LDAP lookup module. Specify 1 for users (default), 2 for groups, or 3 for users and groups.
local.imta.lookupfallbackaddress
When using the direct LDAP lookup module, this parameter allows the last alias lookup to be skipped. Instead the recipient address is rewritten to a fixed address. This parameter is used in conjunction with a SEND_ACCESS mapping rule to return an error code.
local.imta.lookupmaxnbfailed
The MTA does not honor this parameter.
local.imta.mailaliases
List of comma-delineated LDAP attributes that override the default attributes. These attributes should be email addresses that can be routed.
For example: if local.imta.mailaliases=mail,mailAlternateAddress,rfc822mailbox, rfc822mail alias, the MTA will consider these attributes when routing messages.
Default: mailAlternateAddress
local.imta.schematag
Defines the types of LDAP entries that are supported by the MTA. Default: ims50.
local.imta.reverseenabled
Triggers the generation of the reverse database. How the reverse database is actually used is controlled by the USE_REVERSE_DATABASE option.
Default: yes.
local.imta.catchallenabled
Controls whether or not catch all addresses (mail or mailAlternateAddress in the form @domain) are enabled. Default: yes.
local.imta.ssrenabled
Triggers the generation of the server side rule database. How the SSR database is actually used is controlled by the ssr channel keyword.
Default: yes
local.installeddir
Full pathname of software installation directory.
local.instancedir
Full pathname of server instance directory.
local.lastconfigfetch
Last configuration fetch timestamp.
local.ldapbasedn
Root for the config tree in the config LDAP. The config LDAP is read by all the store processes when starting up.
local.ldapcachefile
Location of cached configuration.
local.ldaphost
DN in the configuration directory under which configuration information for a specific server is stored.
local.ldapisiedn
Installed software DN.
local.ldappoolrefreshinterval
Length of time in minutes before LDAP connections are automatically closed then re-established to the LDAP server. Also, length of elapsed time in minutes until the failover directory server reverts back to the primary directory server.
Default: -1 (never refresh)
local.ldapport
LDAP port. Default: 389.
local.ldapsearchtimeout
Timeout, in seconds, for all LDAP searches using ldappool which do not already have a timeout. Connections which time out while searching are also now removed from the pool, making failover possible if an LDAP load balancer is used.
Default: 60
local.ldapsiecred
Server credential.
local.ldapsiedn
Server instance entry DN.
local.ldapuselocal
When set to true, the messaging server will use the information saved in configutil to connect to the config directory (all the local.ldap* parameters). If false, the messaging server will connect to the config directory using the default method, through the admin SDK by getting the parameters from the admin dbswitch.conf file.
Default: false
local.logfile.msgtrace.buffersize
Size of log buffers (in bytes) for message trace logging. Default: 0.
local.logfile.msgtrace.expirytime
Maximum time (in seconds) a message trace logfile is kept. Default: 604800.
local.logfile.msgtrace.flushinterval
Time interval for flushing message trace buffers to log files (in seconds). Default: 60.
local.logfile.msgtrace.logdir
Directory path for message trace log files.
local.logfile.msgtrace.loglevel
Specify a message trace log level:
<Need more info from Scott on what the levels are>
local.logfile.msgtrace.logtype
?
local.logfile.msgtrace.maxlogfiles
Maximum number of message trace files. Default: 10.
local.logfile.msgtrace.maxlogfilesize
Maximum size (bytes) of each message trace log file. Default: 2097152.
local.logfile.msgtrace.maxlogsize
Maximum size of all message trace logfiles. Default: 20971520
local.logfile.msgtrace.minfreediskspace
Minimum amount of free disk space (bytes) that must be available for message trace logging. Default: 5242880.
local.logfile.msgtrace.rollovertime
The frequency in which to rotate message trace logfiles (in seconds). Default: 86400.
local.logfile.tcp_lmtp_server.buffersize
Size of log buffers (in bytes) for LMTP logging. Default: 0.
local.logfile.tcp_lmtp_server.expirytime
Maximum time (in seconds) a LMTP logfile is kept. Default: 604800.
local.logfile.tcp_lmtp_server.flushinterval
Time interval for flushing LMTP buffers to log files (in seconds). Default: 60.
local.logfile.tcp_lmtp_server.logdir
Directory path for LMTP log files.
local.logfile.tcp_lmtp_server.loglevel
Specify a LMTP log level:
<Need more info from Scott on what the levels are>
local.logfile.tcp_lmtp_server.logtype
?
local.logfile.tcp_lmtp_server.maxlogfiles
Maximum number of LMTP files. Default: 10.
local.logfile.tcp_lmtp_server.maxlogfilesize
Maximum size (bytes) of each LMTP log file. Default: 2097152.
local.logfile.tcp_lmtp_server.maxlogsize
Maximum size of all LMTP trace logfiles. Default: 20971520
local.logfile.tcp_lmtp_server.minfreediskspace
Minimum amount of free disk space (bytes) that must be available for LMTP logging. Default: 5242880.
local.logfile.tcp_lmtp_server.rollovertime
The frequency in which to rotate LMTP logfiles (in seconds). Default: 86400.
local.mmp.enable
Enable mmp server on start-msg startup.
Default: On
local.pop.lockmailbox
When set to 1 (on), this parameter limits the number of pop sessions allowed to access a mailbox at a time to one. When set to 0 (off), pop users can access mailboxes in multiple sessions concurrently. For example, configutil -o local.pop.lockmailbox -v 1 will only allow one pop session to access a mailbox at a time.
Default: 0
local.poplogmboxstat
Pop log will show mailbox statistics on login and logout if the value is set to 1.
Default: 0 (off)
local.probe.service.
timeoutSpecifies the number of seconds after which a specified service will time out. The msprobe process uses the timeout value set by this parameter to determine when to time out the specified service.
service can be imap, pop, http, cert, job_controller, smtp, lmtp, mmp or ens.
If this parameter is not configured:
For the SMTP server, the default timeout is 120 seconds.
For other services, the default timeout is the value of the configutil parameter service.readtimeout. If the service.readtimeout parameter is not configured, the default timeout is 30 seconds.
local.probe.service.
warningthresholdSpecifies the value, in number of seconds, of a warning threshold for a specified service. When the response time of the specified service is longer than the specified number of seconds, msprobe sends a warning message to the default log file.
service can be imap, pop, http, cert, job_controller, smtp, lmtp, mmp or ens.
If the local.probe.service.warningthreshold parameter is not configured, msprobe uses the value of the local.probe.warningthreshold parameter.
Example warning messages:
imapd server took over 30 seconds to respond!
smtp server took over 120 seconds to respond!
smtp slowness may be a symptom of DNS problems -- configuring to avoid DNS lookups on incoming connections may improve performance.local.probe.warningthreshold
Specifies the value, in number of seconds, of a warning threshold for all mail services. When the response time of a service (such as IMAP, POP, SMTP, etc.) is longer than the specified number of seconds, msprobe sends a warning message to the default log file.
The default warning threshold is 30 seconds
Example warning messages:
imapd server took over 30 seconds to respond!
smtp server took over 120 seconds to respond!
smtp slowness may be a symptom of DNS problems -- configuring to avoid DNS lookups on incoming connections may improve performance.To set a customized warning threshold for an individual service, use the local.probe.service.warningthreshold parameter.
local.queuedir
Full pathname of spool directory or local queue directory to be monitored by msprobe.
local.report.reportercmd
Command to run in order to generate reports. Default: msg_svr_base/bin/msg/admin/bin/reporter.pl
local.report.runinterval
Interval for job generation process to sleep in between checking for jobs (seconds). Default: 3600.
local.report.counterlogfile.expirytime
Maximum time (in seconds) a logfile is kept. Default: 604800.
local.report.counterlogfile.interval
The frequency that the counter is captured in seconds. Default: 600.
local.report.counterlogfile.logdir
Directory path for log files.
local.report.counterlogfile.loglevel
Default: Notice.
local.report.counterlogfile.maxlogfiles
Maximum number of files. Default: 10.
local.report.counterlogfile.maxlogfilesize
Maximum size (bytes) of each log file. Default: 2097152.
local.report.counterlogfile.maxlogsize
Maximum size of all logfiles. Default: 20971520
local.report.counterlogfile.minfreediskspace
Minimum amount of free disk space (bytes) that must be available for logging. Default: 5242880.
local.report.counterlogfile.rollovertime
The frequency in which to rotate logfiles (in seconds). Default: 86400.
local.report.counterlogfile.separator
Field separator in counter logfile. Default: ‘\t’.
local.report.job.desc.sample
Description for report job sample.
local.report.job.range.sample
Time range of input data.
local.report.job.schedule.sample
The time to start reporting process.
local.report.job.target.sample
Location to send the report.
local.report.job.type.sample
Type of report for this job. Default: listmbox.
local.report.type.cmd.listmbox
Command to execute listmbox report type.
local.report.type.desc.listmbox
Description for listmbox report type.
local.rfc822header.fixcharset
Character set where improperly encoded 8-bit message headers are interpreted by Messenger Express.
local.rfc822header.fixlang
Specifies two-letter language ID where improperly encoded 8-bit message headers are interpreted by Messenger Express. This parameter must be used in conjunction with the fixcharset parameter.
local.sched.enable
Enable sched server on start-msg startup.
Default: On
local.schedule.expire
Interval for running imexpire. Uses UNIX crontab format:
minute hour day-of-month month-of-year day-of-weekThe values are separated by a space or tab and can be 0-59, 0-23, 1-31, 1-12 or 0-6 (with 0=Sunday) respectively. Each time field can be either an asterisk (meaning all legal values), a list of comma-separated values, or a range of two values separated by a hyphen. Note that days can be specified by both day of the month and day of the week. Both will be required if specified. Example, setting the 17th day of the month and Tuesday will require both values to be true.
Interval Examples:
1) Run imexpire at 12:30am, 8:30am, and 4:30pm:
30 0,8,16 * * *2) Run imexpire at weekday morning at 3:15 am:
15 3 * * 1-53) Run imexpire only on Mondays:
0 0 * * 1Default: 0 23 * * * /sbin/imexpire
local.schedule.msprobe
msprobe run schedule. msprobe is a daemon that probes servers to see if they respond to service requests. The value is a crontab-style schedule string (see local.schedule.purge).
Default: 600 seconds
local.schedule.purge
Interval for running purge. Uses UNIX crontab format:
minute hour day-of-month month-of-year day-of-week. See local.schedule.expire above.Default: 0 0,4,8,12,16,20 * * * /opt/SUNWmsgsr/lib/purge -num=5
local.schedule.return_job
Interval for running the return_job. Uses UNIX crontab format:
minute hour day-of-month month-of-year day-of-week.Default: 30 0 * * * /opt/SUNWmsgsr/lib/return_job
local.schedule.taskname
A command and a schedule on which to execute the command. Format:
configutil -o local.schedule.taskname -v “schedule”
taskname is a unique name for this command/schedule combination.
schedule has the format:
minute hour day-of-month month-of-year day-of-week command args
command args can be any Messaging Server command and its arguments. A fully qualified command pathname is required.
minute hour day-of-month month-of-year day-of-week is the schedule for running the command. It follows the UNIX crontab format.
The values are separated by a space or tab and can be 0-59, 0-23, 1-31, 1-12 or 0-6 (with 0=Sunday) respectively. Each time field can be either an asterisk (meaning all legal values), a list of comma-separated values, or a range of two values separated by a hyphen. Note that days can be specified by both day of the month and day of the week and both will be required if specified. For example, setting the 17th day of the month and Tuesday will only run the command on the 17th day of a month when it is Tuesday. See local.schedule.expire for examples of how to set the schedule parameter.
Note that if you modify scheduler, you must either restart the scheduler with the command stop-msg sched and start-msg sched, or you can send SIGHUP to the scheduler process:
kill -HUP scheduler_pid
Default: N/A
local.schedule.userpurge
Schedules purging of users. It uses a crontab-style entry.
minute hour day-of-month month-of-year day-of-week is the schedule for running the command. It follows the UNIX crontab format.
local.servergid
Server groupid in UNIX.
Default: nobody.
local.servername
Server name.
local.serverroot
Server root.
local.servertype
Server type. Default: msg.
local.serveruid
User id of server in UNIX. Default: msgsrv.
local.service.http.filterhiddenmailinglists
Excludes the mgmanhidden attribute from the search filter when set to 0.
Default: 1
local.service.http.gzip.dynamic
Enables or disables compression of dynamic content (for example: request to *.msc. files) delivered to Messenger Express or Communications Express mail clients. This can be disabled if Messenger Express or Communications Express users are getting corrupted content and cannot open their mail pages.
Default: 1 (enable)
local.service.http.gzip.static
Enables or disables compression of static content (for example: html files) delivered to Messenger Express or Communications Express mail clients. This can be disabled if Messenger Express or Communications Express users are getting corrupted content and cannot open their mail pages.
Default: 1 (enable)
local.service.http.maxcollectmsglen
Maximum message size the server collects from a remote POP mailbox. If any message in the mailbox to be collect exceeds this size, the collection will halt when that message is encountered.
local.service.http.maxldaplimit
Sets the maximum LDAP lookup limit.
Default: 500
local.service.http.proxy
Enables the Messenger Express Multiplexor on a Messaging Server proxy machine (when set to 1). This specialized server acts as a single point of connection to Messenger Express (the HTTP access service) when managing multiple mail servers.
Default: 0
local.service.http.proxy.port.hostname
Configures the port number of the back-end Messenger Express (HTTP) server with the Messaging Multiplexor.
local.service.http.rfc2231compliant
Enables WebMail’s RFC-2231 encoder so that the attachment filename will be encoded in the method defined by RFC-2231.
local.service.http.showunreadcounts
Shows unread count in parentheses after the folder name. Setting this parameter affects server performance.
local.service.http.smtpauthpassword
Password for end user AUTH SMTP user.
local.service.http.smtpauthuser
User id for end user AUTH SMTP user.
This parameter allows someone using Messenger Express to receive the same authenticated SMTP messages that they would normally receive using another web browser. In order for this to work, the user ID and password given to the mshttpd must be a store administrator; they must exist in the store.admins list (for example, admin and admin). After setting these parameters, any mail received from a local user should have the word “Internal” appearing next to the “From:” header in the Message View window.
local.service.pab.alwaysusedefaulthost
Enables one PAB server to be used.
Default: False
local.service.pab.attributelist
Add new attributes to a personal address book entry. With this parameter, you can create an attribute that does not already exist.
Default: pabattrs.
local.service.pab.enabled
Enable or disable PAB feature.
Default: 1
local.service.pab.ldapbasedn
Base DN for PAB searches.
Default: o=pab
local.service.pab.ldapbinddn
Bind DN for PAB searches.
local.service.pab.ldaphost
Hostname where Directory Server for PAB resides.
local.service.pab.ldappasswd
Password for user specified by local.service.pab.ldapbinddn.
local.service.pab.ldapport
Port number of the PAB Directory Server.
local.service.pab.maxnumberofentries
Maximum number of entries a single PAB can store.
Default: 500
local.service.pab.migrate415
Enables PAB migration when set to “on”. The default value is “off”.
local.service.proxy.serverlist
Message store server list. Takes a space-separated strings. Not configured by default
local.service.proxy.admin
Default store admin login name. Not configured by default
local.service.proxy.adminpass
Default store admin password. Not configured by default.
local.service.proxy.admin.hostname
Store admin login name for a specific host. Not configured by default.
local.service.proxy.adminpass.hostname
Store admin password for a specific host. Not configured by default.
local.smsgateway.enable
Enable sms server on start-msg startup.
Default: On
local.snmp.enable
Enable snmp server on start-msg startup.
Default: On
local.store.backup.exclude
Specifies mailboxes to be excluded from a backup operation. You can specify a single mailbox or a list of mailboxes separated by the ‘%’ character.
For example:
Trash
Trash%Bulk Mail%Third Class Mail
You can override the local.store.backup.exclude setting and back up an excluded folder by specifying its full logical name during the operation. For example, if the Trash folder is excluded in the following user mailbox, you can back up Trash by specifying
/primary/user/user1/trash
local.store.checkdiskusage
Stops messages from being delivered to a message store partition when the partition fills more than a specified percentage of available disk space. If disk usage goes higher than the specified threshold, the store daemon
When disk usage falls below the threshold, the partition is unlocked, and messages are again delivered to the store.
Allowable values: yes, no
Default: yes
local.store.diskusagethreshold
Specifies the disk-usage threshold for the partition-monitoring feature. (For details about this feature, see local.store.checkdiskusage.) The value of local.store.diskusagethreshold is a percentage from 1 to 99.
Default: 99
local.store.expire.cleanonly1
For backward compatibility. Perform purge only, do not perform imexpire.
Default: false
local.store.expire.loglevel
Specify a log level:
1 = log summary for the entire expire session.
2 = log one message per mailbox expired.
3 = log one message per message expired.Default: 1
local.store.expire.workday1
For backward compatibility. Perform expire/cleanup on this day of the week.
Values: 0-6 (0= Sunday)Default: None
local.store.maxlogs
Specifies a maximum number of allowable accumulated log files. When the total number of active log files equals or exceeds the value of local.store.maxlogs, msprobe sends a critical message to the default log file and alerts the administrator to restart the message store servers immediately. If autorestart is enabled, the message store servers are restarted automatically when the number of log files has exceeded the value of local.store.maxlogs.
The default value of local.store.maxlogs is 8.
local.store.notifyplugin.noneInbox.enable
Determines whether all folders generate notifications or if only the INBOX generates notifications:
0 = changes to the INBOX (only the INBOX) generate event notifications.
1=changes to any and every folder generate event notifications.
local.store.quotaoverdraft
Allows overdraft of message store quota. Accepted values are “on” and “off.” Off - rejects messages that would push the message store over its quota. On - allows messages to be delivered to the users until the usage is over the quota limit, at which time messages are deferred or bounced, the quota warning message is sent, and the quota grace period timer starts.
Default: off
local.store.relinker.enabled
Enables real-time relinking of messages in the append code, and stored purge. The relinker command-line tool may be run even if this option is off, however since stored will not purge the repository, relinker -d must be used for this task. Turning this option on affects message delivery performance in exchange for the disk space savings.
Default: no
local.store.relinker.maxage
Maximum age in hours for messages to be kept in the repository, or considered by the relinker command-line. -1 means no age limit, that is, only purge orphaned messages from the repository. For relinker it means process existing messages regardless of age. Shorter values keep the repository smaller thus allow relinker or stored purge to run faster and reclaim disk space faster, while longer values allow duplicate message relinking over a longer period of time, for example, when users copy the same message to the store several days apart, or when running a migration over several days or weeks.
Default: 24
local.store.relinker.minsize
Minimum size in kilobytes for messages to be considered by run-time or command-line relinker. Setting a non-zero value gives up the relinker benefits for smaller messages in exchange for a smaller repository.
Default: 0
local.store.relinker.purgecycle
Approximate duration in hours of an entire stored purge cycle. The actual duration depends on the time it takes to scan each directory in the repository. Smaller values will use more I/O and larger values will not reclaim disk space as fast. 0 means run purge continuously without any pause between directories. -1 means don’t run purge in stored (then purge must be performed using the relinker -d command).
Default: 24
local.store.serversidewastebasket
Enables server side wastebasket. Accepted values are: “yes” and “no.”
Default: no
local.store.sharedfolders
Disables listing of sharedfolders with “*” as its pattern. You can still select the shared folder, but you cannot list it with a “*”.
Default: on
local.store.snapshotdirs
Number of separate snapshots to store on disk. Minimum is 2. Recommend enough to be sure you have a good database back by the time you figure out the current one is beyond repair.
Default: 3
local.store.snapshotinterval
Interval of time between snapshots. Unit of time is in minutes. It is recommended that you perform this procedure at least once a day.
Default: 0.
local.store.snapshotpath
Specifies the path in which to copy the mboxlist directory. Permissions must be set for the message store owner. Snapshots will be placed in subdirectories.
local.store.deadlock.autodetect
Sets whether all or just one thread resolves deadlock. Default: no.
local.store.deadlock.checkinterval
Specifies the sleep length (in microseconds) before lock_detect is set again. Default: 1000.
local.supportedlanguages
Languages supported by server code.
local.tmpdir
Default value for service.http.spooldir.
local.ugldapbasedn
Root of the user/group configuration tree in the Directory Server.
local.ugldapbindcred
Password for the user/group administrator.
local.ugldapbinddn
DN of the user/group administrator.
local.ugldaphasplainpasswords
Sets whether the user/groups LDAP server is configured to store user passwords in plaintext and readable to the server. Default: no.
local.ugldaphost
LDAP server for user lookup.
local.ugldapport
LDAP port. Default: 389.
local.ugldapuselocal
If set to yes, the ugldap config data will be stored in the local config file. Otherwise, it is stored in LDAP.
Default: yes
local.watcher.enable
Enable watcher on start-msg startup. Watcher is a daemon that monitors Messaging Server and restarts services that fail. Refer to local.auto.restart and the Sun Java System Messaging Server Administration Guide for details
Default: On
local.watcher.port
Watcher listen port.
Default: 49994
local.webmail.sieve.port
The port of the web container where the Mail Filter has been deployed.
local.webmail.sso.cookiedomain
Specifies the value to include in the domain field of any SSO cookie that is sent back to the client.
local.webmail.sso.enable
Performs all SSO functions, including accepting and verifying SSO cookies presented by the client when the login page is fetched. It returns an SSO cookie to the client for a successful login and responds to requests from other SSO partners to verify its own cookies. If set to zero, the server does not perform any SSO functions. The default is 0. This parameter takes an integer value.
local.webmail.sso.id
Specifies the application ID value when formatting SSO cookies set by the WebMail server. The default is NULL. This parameter takes a string value.
local.webmail.sso.prefix
Specifies the prefix value when formatting SSO cookies set by the WebMail server. Only SSO cookies with this prefix value are recognized by the server; all other SSO cookies are ignored. The default is NULL. This parameter takes a string value.
local.webmail.sso.singlesignoff
Clears all SSO cookies on the client with prefix values matching the value configured in local.webmail.sso.prefix when the client logs out. If set to 0, the WebMail server only clears its own SSO cookie. The default is 0.
logfile.*.buffersize
Size of log buffers (in bytes). Default: 0. * can be one of the following components: admin, default, http, imap, imta, pop.
logfile.*.expirytime
Amount of time logfile is kept (in seconds). Default: 604800. * can be one of the following components: admin, default, http, imap, imta, pop.
logfile.*.flushinterval
Time interval for flushing buffers to log files (in seconds). Default: 60. * can be one of the following components: admin, default, http, imap, imta, pop.
logfile.*.logdir
Directory path for log files. * can be one of the following components: admin, default, http, imap, imta, pop.
logfile.*.loglevel
* can be one of the following components: admin, default, http, imap, imta, pop.
logfile.*.logtype
* can be one of the following components: admin, default, http, imap, imta, pop.
logfile.*.maxlogfiles
Maximum number for files. Default: 10. * can be one of the following components: admin, default, http, imap, imta, pop.
logfile.*.maxlogfilesize
Maximum size (bytes) of each log file. Default: 2097152. * can be one of the following components: admin, default, http, imap, imta, pop. The maxlogfilesize is limited to 2 gigabytes.
logfile.*.maxlogsize
Maximum size of all logfiles. Default: 20971520. * can be one of the following components: admin, default, http, imap, imta, pop. The maximum limit of logfile.name.maxlogsize is (18446744073709551615-logfile.name.logsize).
logfile.*.minfreediskspace
Minimum amount of free disk space (bytes) that must be available for logging. Default: 5242880. * can be one of the following components: admin, default, http, imap, imta, pop.
logfile.*.rollovertime
The frequency in which to rotate logfiles (in seconds). Default: 86400. * can be one of the following components: admin, default, http, imap, imta, pop.
logfile.*.syslogfacility
Specifies whether or not logging goes to syslog. * can be one of the following components: admin, default, http, imap, imta, pop.
The values can be user, mail, daemon, local0 to local7, or none. If the value is set, messages are logged to the syslog facility corresponding to the set value and all other log file service options are ignored.
Default: none (logging uses the Message Server log files).
logfiles.admin.alias
Default:|logfile|admin
logfiles.default.alias
Default:|logfile|default
logfiles.http.alias
Default:|logfile|http
logfiles.imap.alias
Default:|logfile|imap
logfiles.imta.alias
Default:|logfile|imta
logfiles.pop.alias
Default:|logfile|pop
sasl.default.auto_transition
Boolean. When set and a user provides a plain text password, the password storage format will be transitioned to the default password storage method for the directory server. This can be used to migrate from plaintext passwords to APOP, CRAM-MD5 or DIGEST-MD5.
Default: False
sasl.default.ldap.has_plain_passwords
Boolean to indicate directory stores plaintext passwords which enables APOP, CRAM-MD5 and DIGEST-MD5.
Default: False
sasl.default.ldap.searchfilter
This is the default search filter used to look up users when one is not specified in the inetDomainSearchFilter for the domain. The syntax is the same as inetDomainSearchFilter (see schema guide).
Default: (&(uid=%U)(objectclass=inetmailuser))
sasl.default.ldap.searchfordomain
By default, the authentication system looks up the domain in LDAP following the rules for domain lookup (ref. needed) then looks up the user. However, if this option is set to “0" rather than the default value of “1”, then the domain lookup does not happen and a search for the user (using the sasl.default.ldap.searchfilter) occurs directly under the LDAP tree specified by local.ugldapbasedn. This is provided for compatibility with legacy single-domain schemas, but use is not recommended for new deployments as even a small company may go through a merger or name change which requires support for multiple domains.
sasl.default.mech_list
A space-separated list of SASL mechanisms to enable. If non-empty, this overrides the sasl.default.ldap.has_plain_passwords option as well as the service.imap.allowanonymouslogin option. This option applies to all protocols (IMAP, POP, SMTP).
Default: False
sasl.default.transition_criteria
No longer supported or used. See sasl.default.auto_transition.
service.imap.allowanonymouslogin
This enables the SASL ANONYMOUS mechanism for use by IMAP.
Default: False
service.{imap|pop|http}.plaintextmincipher
If this is > 0, then disable use of plaintext passwords unless a security layer (SSL or TLS) is activated. This forces users to enable SSL or TLS on their client to login which prevents exposure of their passwords on the network. The MMP has an equivalent option RestrictPlainPasswords.
NOTE: the 5.2 release of messaging server would actually check the value against the strength of the cipher negotiated by SSL or TLS. That feature has been eliminated to simplify this option and better reflect common-case usage.
Default: 0
service.authcachesize
The number of concurrent users/entries in the cache during the service.authcachettl time interval. The unit is in “entries” and each entry takes 60 bytes.
Default: 10000
service.authcachettl
Cache entry TTL in seconds. Default: 900.
service.dcroot
Root of DC tree in Directory Server. Default: o=Internet.
service.defaultdomain
Used to determine whether the domain is the default domain or a hosted domain.
service.dnsresolveclient
Sets whether or not to reverse name lookup client host. Default: no.
service.http.allowadminproxy
Sets whether or not to allow admin to proxy auth. Default: no.
service.http.allowanonymouslogin
Sets whether or not to allow anonymous login. Default: no.
service.http.connlimits
Maximum number of connections per IP address.
The syntax is:
realm1,realm2,...
where a realm has the form of address ranges and maximum number of connections expressed as:
IP “|” MASK “:” NUM
There should be at least 1 realm of the form:
0.0.0.0|0.0.0.0:n
to cover the default case.
service.http.domainallowed
Access filters for HTTP services.
service.http.domainnotallowed
Deny filters for HTTP services.
service.http.enable
Enable http server on start-msg startup.
Default: On
service.http.enablesslport
Sets whether or not the service is started on a sslport. If both service.http.enable and service.http.enablesslport are turned off, then stored does not try to monitor http. Default: yes.
service.http.extraldapattrs
Extra LDAP attributes for customization.
service.http.fullfromheader
Sets whether or not to send complete “from” header. Default: no.
service.http.idletimeout
Timeout, in minutes, for the low-level http connection (which is different from the webmail session). Lower values will use fewer socket handles and higher values cause less overhead when the client needs to recreate the connection.
Default: 3.
service.http.ipsecurity
Sets whether or not to restrict session access to login IP addresses. If set to yes, when the user logs in, the server remembers which IP address the user used to log in. Then it only allows that IP address to use the session cookie it issues to the user. Default: yes.
service.http.maxmessagesize
Maximum message size client is allowed to send. Default: 5242880.
service.http.maxpostsize
Maximum http post content length. Default: 5242880.
service.http.maxsessions
Maximum number of sessions per server process. Default: 6000.
service.http.maxthreads
Maximum number of threads per server process. Default: 250.
service.http.numprocesses
Number of processes. Default: 1.
service.http.plaintextmincipher
Sets plain text login allowance. Specify 0 to allow plain text login always. Specify -1 to never allow plain text login. Specify 40 or 128 to require login using encryption using 40 or 128 bit key. Default: 0.
service.http.port
Server port number. Default: 80.
service.http.proxydomainallowed
Access filters for proxy authentication to the HTTP service.
service.http.resourcetimeout
Time, in seconds, after which mshttpd flushes cached session data from memory. Lower values will use less memory and higher values incur less overhead from resynchronizing from the session db. For correct session expiration this timeout is never higher than half the session timeout (mshttpd enforces this).
Default: 900.
service.http.sessiontimeout
Webmail client session timeout in seconds. Default: 7200
service.http.smtphost
SMTP relay host. If you are using LMTP, set this to the machine name of the LMTP host.
Default: localhost
service.http.smtpport
SMTP relay port. Default: 25.
service.http.sourceurl
Webmail server URL.
service.http.spooldir
Spool directory for outgoing client mail.
service.http.sslcachesize
Number of SSL sessions to be cached. Default: 0.
service.http.sslport
SSL server port number. Default: 443.
service.http.sslsourceurl
Webmail server URL.
service.http.sslusessl
Sets whether or not to enable SSL. Default: yes.
service.imap.allowanonymouslogin
Allows anonymous login. Default: no.
service.imap.banner
IMAP protocol welcome banner.
service.imap.connlimits
Maximum number of connections per IP address.
The syntax is:
realm1,realm2,...
where a realm has the form of address ranges and maximum number of connections expressed as:
IP “|” MASK “:” NUM
There should be at least 1 realm of the form:
0.0.0.0|0.0.0.0:n
to cover the default case.
service.imap.domainallowed
Access filters for IMAP services.
service.imap.domainnotallowed
Deny filters for IMAP services.
service.imap.enable
Enable imap server on start-msg startup.
Default: On
service.imap.enablesslport
Sets whether or not service is started on sslport. Default: yes.
service.imap.idletimeout
Idle timeout (in minutes). Default: 30.
service.imap.maxsessions
Maximum number of sessions per server process. Default: 4000.
service.imap.maxthreads
Maximum number of threads per server process. Default: 250.
service.imap.numprocesses
Number of processes. Default: 1.
service.imap.plaintextmincipher
Sets plain text login allowance. Specify 0 to allow plain text login always. Specify -1 to never allow plain text login. Specify 40 or 128 to require login using encryption using 40 or 128 bit key. Default: 0.
service.imap.port
Server port number. Default: 143.
service.imap.sslcachesize
Number of SSL sessions to be cached. Default: 0.
service.imap.sslport
SSL server port number. Default: 993.
service.imap.sslusessl
Sets whether or not SSL is enabled. Default: yes.
service.listenaddr
The IP address on which to listen.
service.loginseparator
The character to be used as the login separator. Default: @.
service.plaintextloginpause
The pause interval after successful login. Default: 0.
service.pop.allowanonymouslogin
Sets whether or not anonymous login is allowed. Default: no.
service.pop.banner
POP protocol welcome banner.
service.pop.connlimits
Maximum number of connections per IP address.
The syntax is:
realm1,realm2,...
where a realm has the form of address ranges and maximum number of connections expressed as:
IP “|” MASK “:” NUM
There should be at least 1 realm of the form:
0.0.0.0|0.0.0.0:n
to cover the default case.
service.pop.domainallowed
Access filters for POP services.
service.pop.domainnotallowed
Deny filters for POP services.
service.pop.enable
Enable pop server on start-msg startup.
Default: On
service.pop.enablesslport
Sets whether or not service is started on sslport. Default: yes.
service.pop.idletimeout
Idle timeout (in minutes). Default: 10.
service.pop.maxsessions
Maximum number of sessions per server process. Default: 600.
service.pop.maxthreads
Maximum number of threads per server process. Default: 250.
service.pop.numprocesses
Number of processes.
service.pop.plaintextmincipher
Sets plain text login allowance. Specify 0 to allow plain text login always. Specify -1 to never allow plain text login. Specify 40 or 128 to require login using encryption using 40 or 128 bit key. Default: 0.
service.pop.port
POP server port number. Default: 110.
service.pop.sslport
SSL server port number. Default: 992.
service.pop.sslusessl
Sets whether or not to enable SSL. Default: yes.
service.readtimeout
Period that msprobe waits after sending an request that goes unfulfilled before restarting a service. See local.schedule.msprobe.
Default: 30 seconds
service.sslpasswdfile
Password for each keyfile.
store.admins
Space separated list of user ids with Message Store Administrator privileges.
store.cleanupage
Age (in hours) of expired or expunged message before purge will permanently remove it.
Default: None
store.dbcachesize
Mailbox list database cache size. Default: 8388608
store.dbtmpdir
The “mailbox list database temporary directory” - defined by the store.dbtmpdir configutil parameter - is a directory which is very heavily accessed. At install time, the value of this parameter is not defined and defaults to a subdirectory underneath the msg_svr_base location. If the disks that house the mboxlist database temporary directory are not fast enough at very large sites, performance problems might occur.
As part of their performance and tuning steps, sites should take a note of this and define a value for this parameter which either points to a memory mapped file system, or which points to a location on a fast file system.
store.defaultacl
Default ACL.
store.defaultmailboxquota
Default mailbox quota, if not specified in user account. The mailbox quota is the total size of the mailbox in bytes. Accepts an integer value.
Default: -1 (infinite).
store.defaultmessagequota
Default message quota, if not specified in user account. The message quota is the number of messages. Accepts an integer value.
Default: -1 (infinite).
store.defaultpartition
Default partition.
store.diskflushinterval
Default: 15
store.expirerule.rulename.attribute
A criteria for an imexpire rule. A rule consists of a set of attributes including a folder pattern, an exclusive flag, and one or more expiration criteria. Attributes (defaults):
exclusive (yes/no). Specifies if this an exclusive rule.
folderpattern (POSIX regular expression). The folders affected by this rule.
messagecount (integer). Number of messages in a folder.
foldersize (integer in bytes). Size of an over-sized message.
messagedays (integer in days). Days that a message should remain in mail storage..
messagesize (integer in bytes). Size of an over-sized message.
messagesizedays (integer in days). Days an over-sized message should remain in a folder
seen (and/or). Seen is a message status flag. This attribute set to and specifies that the message must be seen and other criteria must be met before the rule is fulfilled. Set to or, this attribute specifies that the message only need to be seen or another criteria be met before the rule is fulfilled.
deleted (and/or). Deleted is a message status flag. This attribute set to and specifies that the message must be seen and other criteria must be met before the rule is fulfilled. Set to or, this attribute specifies that the message only need to be seen or another criteria be met before the rule is fulfilled.
Only one attribute per line can be specified. See the Sun Java System Messaging Server Administration Guide for details and examples.
Default: Not applicable.
store.expirerule.*.exclusive
When this parameter is set to ‘yes,’ it is the only rule applied even if other rules match the given criteria.
Default: no
store.expirerule.*.folderpattern
Folders by which the rules apply
store.expirerule.*.foldersizebytes
Maximum number of bytes in a folder.
store.expirerule.*.messagecount
Upper limit on number of messages to be kept in the specified folders.
store.expirerule.*.messagedays
Upper limit on how long a message is kept in the specified folders.
store.expirerule.*.messagesize
Maximum number of bytes in a message.
store.expirerule.*.messagesizedays
Length of time messagesize message can stay.
store.expirestart
For Messaging Server backward compatibility, not recommended for Sun Java System Messaging Server. imexpire start time. Format: 0-23 (represents hour)
Default: None.
store.partition.*.messagepath
Controls the message file directory path.
Default location: msg_svr_base/data/store/partition/primary
store.partition.*.path
Controls the store index file directory path.
Default location: msg_svr_base/data/store/partition/primary
store.partition.primary.path
Full path name of the primary partition
Default: msg_svr_base/store/
partition/primarystore.quotaenforcement
Turns quotaenforcement on or off.
Default: on.
store.quotaexceededmsg
Message to be sent to user when quota exceeds store.quotawarn.
The message must contain a header (with at least a subject line), followed by $$, then the message body. The $ represents a new line. Depending on the shell that you are using, it might be necessary to append a \ before $ to escape the special meaning of $. ($ is often the escape character for the shell.)
There is support for the following variables:
[ID] - userid
[DISKUSAGE] - disk usage
[NUMMSG] - number of messages
[PERCENT] - store.quotawarn percentage
[QUOTA] - mailquota attribute
[MSGQUOTA] - mailmsgquota attribute
For example, to enable this parameter, you can set the following configuration variables:
configutil -o store.quotaexceededmsg
Subject: Overquota Warning$$[ID],$$Your mailbox size has exceeded [PERCENT] of its alloted quota.$Disk Usage: [DISKUSAGE]$Number of Messages: [NUMMSG]$Mailquota: [QUOTA]$Message Quota: [MSGQUOTA]$$-Postmasterconfigutil -o store.quotanotification -v on
Default: null
store.quotaexceededmsginterval
Interval (in days) to wait before sending another quotaexceededmsg. Accepts an integer value.
Default: 7.
store.quotagraceperiod
Time (in hours) the mailbox is over quota before the server starts bouncing the messages. Messages will remain in the queue until one of the following:
Default: 120.
store.quotanotification
Enables quota notification for the Message store. Accepted values are “on” and “off”.
Default: on
store.quotawarn
Percentage of quota that is exceeded before clients are warned. Default: 90.
store.serviceadmingroupdn
DN of service administrator group.
store.umask
umask Default: 077