Enable Option

From Messaging Server Technical Reference Wiki
Jump to: navigation, search




Setting an enable option for some server to 1 enables the selected server on start-msg startup. (Note: For some servers, SSL service may be enabled separately using the corresponding enablesslport option.)

Use with rollovermanager

The enable rollovermanager option enables its operation.


The default value in this context is: 1


See also:

Use with dispatcher

The enable Dispatcher option is used to enable the dispatcher daemon. This defaults to the value of the mta.enable (Unified Configuration) or local.imta.enable (legacy configuration) option. When the Dispatcher is enabled, the default for schedule.task:purge.enable (Unified Configuration) or local.schedule.purge.enable (legacy configuration) is 1.


See also:

Use with job controller

The enable Job Controller option is used to enable the Job Controller daemon. This defaults to the value of the mta.enable (Unified Configuration) or local.imta.enable (legacy configuration) option. When the job_controller is enabled, the default for schedule.task:purge.enable (Unified Configuration) or local.schedule.purge.enable (legacy configuration) is 1. In addition, the default for schedule.task:return_job.enable (Unified Configuration) or local.schedule.return_job.enable (legacy configuration) is also 1 in this case.


See also:

Use with deploymap

The enable Deployment Map option, deploymap.enable, enables use of the Deployment Map service. Whether to run as a client or server is specified with the run_as_server option. The default is to run as a client.


The default value in this context is: 0


See also:

Use with autorestart

The enable Autorestart option (base.autorestart.enable or more simply autorestart.enable in Unified Configuration, or local.autorestart in legacy configuration) enables automatic restart of failed or frozen (unresponsive) servers including IMAP, POP, MSHTTP, Job Controller, Dispatcher, and MMP servers.


The default value in this context is: 1


See also:

Use with service

(New in 7.0.5) The enable Dispatcher service option controls whether the service is enabled. It defaults to 1, but may be set to 0 to disable a service.


The default value in this context is: 1


See also:

Use with notifytarget

The enable option under notifytarget, notifytarget:target-name.enable, specifies whether to generate notifications for this destination. This defaults to 1. This can also be used to disable the default destination for a JMQ plugin, so notifications are only sent to destinations specified in the ldapdestination attribute in users' directory entries.


The default value in this context is: 1


See also:

Use with ens

The enable ENS option enables the ENS server on start-msg startup. The default value is the value of store.enable (aka local.store.enable in legacy config).


See also:

Use with folderquota

The enable Message Store folderquota option enables quota by folder.


The default value in this context is: 0


See also:

Use with indexer

The enable Indexer option, if set to 1, causes sending some IMAP search and sort commands to ISS, the Indexing and Search Service. The server_host Indexer option must also be set for this to function correctly. The ISS processes search operations based on words rather than substrings so results may not be IMAP standards compliant and may differ from a search performed by the IMAP server.

If the ESEARCH RETURN (ALL) result option is present in the search command, then ISS is used. For all other ESEARCH extension features, the ISS is not used. The ISS is not used if KEYWORD, HEADER, OLDER, YOUNGER, MODSEQ, ANNOTATION, or RECENT appear. At least one of the following search terms: SUBJECT, FROM, TO, CC, BCC, TEXT or BODY must be present for the ISS to be used. If an error occurs from the ISS, then the search may fall back to processing by the IMAP server. See the ISS documentation for details on what searches it supports as it may not support all combinations of AND, OR and NOT operators that IMAP supports. The specific rules of what is sent to the ISS and what is processed locally on the IMAP server may change in future releases.

The bodytextonly option modifies the above rules so that TEXT or BODY must be present or the search will not be sent to the ISS.

As of Messaging Server 7.0.5.30.0, the ISS is used to process IMAP ESEARCH commands with RETURN (ALL) result option. For all other ESEARCH extension features, the ISS is not used.

Also see the debugkeys option's search key to enable IMAP search and sort command related debug.


The default value in this context is: 0


See also:

Use with messagetype

The enable Message Store messagetype option enables the Message Store's message typing feature.


The default value in this context is: 0


See also:

Use with dbreplicate

Tne enable Message Store dbreplicate option enables the mboxlist database replication feature.


The default value in this context is: 0


See also:

Use with msghash

The enable Message Store msghash option enables message hash database.


The default value in this context is: 0


See also:

Use with mta

The enable MTA option, mta.enable (Unified Configuration) or local.imta.enable (legacy configuration), provides a default setting for the dispatcher.enable option and the job_controller.enable option. The mta.enable option is deprecated in favor of the two more explicit enable options.

The default if this option is not explicitly set is 0, but initial configuration may set this option to enable the MTA, as appropriate.


The default value in this context is: 0


See also:

Use with metermaid

The enable MeterMaid option enables the MeterMaid service on start-msg startup.


The default value in this context is: 0


See also:

Use with the MMP

The enable MMP option enables the MMP service on start-msg startup. The default if this option is not set is 0, but initial configuration may set the option to enable the MMP, as appropriate.

To actually run a proxy server, note that the proxy server must have a tcp_listen block defined with at least one non-zero port specified within that block; see in particular the tcp_ports and ssl_ports tcp_listen block options.


The default value in this context is: 0


See also:

Use with pab

The enable PAB option enables or disables the Personal Address Book (PAB) feature.


The default value in this context is: 0


See also:

Use with purge

The enable Message Store purge option, store.purge.enable (Unified Configuration) or local.purge.enable (legacy configuration), enables the purge server on start-msg startup. Initial configuration normally sets this option based on the setting of the enable Message Store option, store.enable (Unified Configuration) or local.store.enable (legacy configuration).

If store.enable is 0, the value of this option is ignored and the impurge daemon is not started. If store.enable is 1, the impurge daemon will run unless this option is explicitly set to 0.

Note that a setting of store.purge.enable=1 (whether set explicitly, or in effect due to store.enable=1) enables the Message Store impurge process to run as a daemon (server) process. Alternatively, it is possible to instead disable such a daemon process, store.purge.enable=0, and instead configure the Scheduler to execute an impurge command periodically, using a Scheduler task. impurge cannot be executed manually by an administrator, nor run by the Scheduler, if it is already running as a daemon process; attempting to run it again will result in an error in the Messaging Server default log file along the lines of:


[24/Feb/2009:14:47:15 +1100] hostname impurge[17986]: General Error: Could not get purge session lock. Possibly another impurge is running

See also:

Use with relinker

The enable Message Store relinker option enables real-time re-linking 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.


The default value in this context is: 0


See also:

Use with schedule

The enable Scheduler option, schedule.enable (Unified Configuration) or local.sched.enable (legacy configuration), enables the Scheduler service on start-msg startup. This option defaults to 0 if not set, but initial configuration normally enables the option.


The default value in this context is: 0

Use with smime

The enable S/MIME option controls whether the S/MIME features are available to Web Client Mail users who have permission to use them.


The default value in this context is: 0


See also:

Use with sms_gateway

The enable SMS gateway option, sms_gateway.enable (Unified Configuration) or local.smsgateway.enable (legacy configuration), enables the SMS service on start-msg startup.


The default value in this context is: 0


See also:

Use with snmp

The enable SNMP option, snmp.enable (Unified Configuration) or local.snmp.enable (legacy configuration), enables the SNMP subagent on start-msg startup.

This option applies to both the Net-SNMP based SNMP subagent, and the legacy SNMP subagent for Solaris 9 and earlier.


The default value in this context is: 0


See also:

Use with store

The enable Message Store option, store.enable (Unified Configuration) or local.store.enable (legacy configuration), enables the Message Store when starting services. This option defaults to 0 if not set, but initial configuration normally enables the option.


The default value in this context is: 0


See also:

Use with typequota

The enable Message Store typequota option is checked only if Message Store message typing has been enabled (store.messagetype.enable is 1). When Message Store message typing has been enabled, then setting store.typequota.enable enables quota by message type. To set different quotas for different message types, see the quotaroot Message Store messagetype mtindex option.


The default value in this context is: 0


See also:

Use with watcher

The enable Watcher option, watcher.enable (Unified Configuration) or local.watcher.enable (legacy configuration), enables the Watcher service on start-msg startup. The Watcher service is a daemon that monitors Messaging Server and restarts services that fail. Refer to autorestart.enable (local.autorestart in legacy configuration) and the Administration Guide for details.

This option defaults to 0 if not set, but initial configuration normally enables the option.


The default value in this context is: 0


See also:

Use with http

The enable MSHTTP option (service.http.enable in legacy configuration) enables the HTTP service on start-msg startup. Note: HTTP over SSL service is enabled/disabled separately using http.enablesslport in Unified Configuration, or service.http.enablesslport in legacy configuration.


The default value in this context is: 1


See also:

Use with imap

The enable IMAP option, (imap.enable in Unified Configuration, or service.imap.enable in legacy configuration), enables the IMAP service on start-msg startup. Note: IMAP over SSL service is enabled/disabled separately using imap.enablesslport in Unified Configuration, or service.imap.enablesslport in legacy configuration.

This option defaults to 0 if not set, but initial configuration may enable the option as appropriate.


The default value in this context is: 0


See also:

Use with pop

The enable POP option, (pop.enable in Unified Configuration, or service.pop.enable in legacy configuration), enables the POP service on start-msg startup. Note: POP over SSL service is enabled/disabled separately using pop.enablesslport in Unified Configuration, or service.pop.enablesslport in legacy configuration.

This option defaults to 0 if not set, but initial configuration may enable the option as appropriate.


The default value in this context is: 0


See also:

Use with isc

The enable ISC option, (isc.enable in Unified Configuration, not available in legacy configuration), enables the ISC service on start-msg startup.

This option defaults to 0 if not set, but initial configuration may enable the option as appropriate.


The default value in this context is: 0


See also:

Use with task

The enable Scheduler task option, schedule.task:name.enable (Unified Configuration) or local.schedule.name.enable (legacy configuration), controls whether a task should be scheduled.

If the Scheduler has been enabled, schedule.enable=1, all tasks default to being scheduled, unless explicitly disabled via schedule.task:task-name.enable=0. That is, the purpose of the task-level enable option is to provide a way to disable tasks.


The default value in this context is: 0


See also:

Use with expire under task

The enable Scheduler task option for the expire task controls whether the expire task should be scheduled. It defaults to the setting of the store.enable option (Unified Configuration) or local.store.enable configutil parameter (legacy configuration).


See also:

Use with msprobe under task

The enable Scheduler task option for the msprobe task controls whether the msprobe task should be scheduled.


The default value in this context is: 1


See also:

Use with purge under task

The enable Scheduler task option for the purge task controls whether the MTA's log file purge task should be scheduled. Defaults to the setting of the mta.enable option (Unified Configuration) or local.imta.enable configutil parameter (legacy configuration). Starting with the 8.0 release, this instead defaults to 1 if any of the following are set: dispatcher.enable option (Unified Configuration), the local.dispatcher.enable configutil parameter (legacy configuration), the job_controller.enable option (Unified Configuration), the local.job_controller.enable configutil parameter (legacy configuration); and otherwise will default to 0. As the new dispatcher and job_controller enable options default to the mta.enable setting, upgrading customers should see no behavior change.


See also:

Use with return_job under task

The enable Scheduler task option for the return_job task controls whether the return_job task should be scheduled. Defaults to the setting of the mta.enable option (Unified Configuration) or local.imta.enable configutil parameter (legacy configuration). Starting with the 8.0 release, the mta.enable option is deprecated so this instead defaults to the value of the job_controller.enable option (Unified Configuration) or the local.job_controller.enable configutil parameter (legacy configuration). As the job_controller.enable option defaults to the value of the mta.enable option, upgrading customers should see no behavior change.


See also:

Use with snapshot under task

The enable Scheduler task option for the snapshot task controls whether the snapshot / verify task should be scheduled. Defaults to the setting of the store.enable option (Unified Configuration) or local.store.enable configutil parameter (legacy configuration).


See also:

Use with snapshotverify under task

The enable Scheduler task option for the expire task controls whether the process log verify task for rolling backups should be scheduled. Defaults to the setting of the store.enable option (Unified Configuration) or local.store.enable configutil parameter.


See also:


See also: