Options Summary
Last updated July 2021
This section displays all configuration file options visible in the following scopes; global, domain, host, binding, binding_group, security, pathway, pathway_group, listener, listen, peer, threadpool, debug_flags and cluster. Module-specific options are documented in the module documentation and options specific to Mobile Momentum are documented in the Mobile Momentum documents. Listener options are listed here but for a separate table of listener-specific options see Table 9.25, “listener options” and for a separate list of cluster options see Table 7.1, “ Cluster options ”. Options are sorted alphabetically by name. If an option functions as a scope, this is indicated by (scope). The Type column indicates the MTA type of a given option. Options of type na do not directly apply to either a sending or receiving MTA. If an option has a default value, it is shown in the Default column followed by a version number, if there has been a change to the default value. If the value of an option cannot be changed at runtime, the Default column will show (non-dynamic). The Version column shows when an option was introduced. Options that are not valid in version 3.0 or higher are not shown.
| Option/Description | Type | Default | Version | Scopes |
|---|---|---|---|---|
| _unsafe_spool – Allow dangerous spool semantics to be used | na | false | 3.0 | global |
| accept_queue_backlog – The accept queue backlog | receiving | 0 | 3.0 | control_listener, eccluster_listener, ecstream_listener, esmtp_listener, http_listener, listen, msgcserver_listener, xmpp_listener |
| adaptive_adjustment_interval – Throttle the adaptive adjustment interval | sending | 60 | 3.0 | binding, binding_group, domain, global |
| adaptive_alert_email_destination – The address where adaptive alerts should be sent | sending | 3.0 | binding, binding_group, domain, global | |
| adaptive_alert_email_sender – Set the sender address of the alert email | sending | NULL | 3.0.17 | binding, binding_group, domain, global |
| adaptive_attempt_threshold – The minimum delivery attempts over a period during which bounce stats are collected and suspensions attempted | sending | 2000 (3.2) | 3.0 | binding, binding_group, domain, global |
| adaptive_backstore_leveldb (scope) – Use LevelDB as the backing store for Adaptive Delivery | sending | 3.6 | global | |
| adaptive_backstore_riak (scope) – Define the characteristics of the Riak backing store | sending | 3.6 | global | |
| adaptive_body_timeout – Set the bounds for the adaptive option | sending | 3.0 | binding, binding_group, domain, global | |
| adaptive_default_suspension – The amount of time to suspend a domain | sending | 4 hours | 3.0 | binding, binding_group, domain, global |
| adaptive_default_suspension_enabled – Enables and disables adaptive_rejection_rate_suspension_percentage | sending | false | 3.6.11 | binding, binding_group, domain, global |
| adaptive_ehlo_timeout – Set the bounds for the adaptive option | sending | 3.0 | binding, binding_group, domain, global | |
| adaptive_enabled – Whether to enable the adaptive module for a specific scope | sending | false | 3.0 | binding, binding_group, domain, global |
| adaptive_fbl_volume_threshold – The minimum total delivered mail count over a period during which FBL stats are collected | sending | 20000 | 3.2 | binding, binding_group, domain, global |
| adaptive_idle_timeout – Set the bounds for the adaptive option | sending | 3.0 | binding, binding_group, domain, global | |
| adaptive_mailfrom_timeout – Set the bounds for the adaptive option | sending | 3.0 | binding, binding_group, domain, global | |
| adaptive_max_deliveries_per_connection – Set the bounds for the adaptive option | sending | 3.0 | binding, binding_group, domain, global | |
| adaptive_max_outbound_connections – Set the bounds for the adaptive option | sending | 3.0 | binding, binding_group, domain, global | |
| adaptive_max_recipients_per_batch – Set the bounds for the adaptive option | sending | 3.0 | binding, binding_group, domain, global | |
| adaptive_max_recipients_per_connection – Set the bounds for the adaptive option | sending | 3.0 | binding, binding_group, domain, global | |
| adaptive_max_resident_active_queue – Set the bounds for the adaptive option | sending | 3.0 | binding, binding_group, domain, global | |
| adaptive_max_retries – Set the bounds for the adaptive option | sending | 3.0 | binding, binding_group, domain, global | |
| adaptive_max_retry_interval – Set the bounds for the adaptive option | sending | 3.0.17 | binding, binding_group, domain, global | |
| adaptive_notification_events – Configure the events that will trigger an email notification | sending | throttle suspension blackhole | 3.5.6, 3.6.1 | binding, binding_group, domain, global |
| adaptive_notification_interval – The throttle for adaptive alert notification emails | sending | 3600 | 3.0 | binding, binding_group, domain, global |
| adaptive_outbound_throttle_messages – Set the bounds for the adaptive option | sending | 3.0 | binding, binding_group, domain, global | |
| adaptive_positive_adjustment_interval – Throttle positive adjustments to adaptive changes | sending | 3600 | 3.0 | binding, binding_group, domain, global |
| adaptive_rcptto_timeout – Set the bounds for the adaptive option | sending | 3.0 | binding, binding_group, domain, global | |
| adaptive_rejection_rate_suspension_percentage – The rate at which messages are rejected | sending | 20 | 3.0 | binding, binding_group, domain, global |
| adaptive_retry_fuzz – Allow greater control over bulk message retries in cases where all messages for a domain have to be retried | sending | 4096 | 3.0.26 | binding, binding_group, domain, global |
| adaptive_retry_interval – Set the bounds for the adaptive option | sending | 3.0 | binding, binding_group, domain, global | |
| adaptive_rset_timeout – Set the bounds for the adaptive option | sending | 3.0 | binding, binding_group, domain, global | |
| adaptive_scope – Define the scope applicable to adaptive delivery | sending | auto | 3.3 | binding, binding_group, domain, global |
| adaptive_sweep_rule (scope) – Set the thresholds and actions for adaptive fbl and bounce rules | sending | 3.2 | binding, binding_group, domain, global | |
| adaptive_sweep_rule_enabled – Enable or disable adaptive_sweep_rule in a specified scope | sending | 1 | 3.2 | binding, binding_group, domain, global |
| address – Set the SNMP IP address and port | na | (non-dynamic) | 3.0 | snmp |
| address_metrics_cleanse_interval – The interval for refreshing address metrics | sending | 3600 | 3.0 | global |
| address_metrics_lifetime – The TTL of address metrics | sending | 1800 | 3.0 | global |
| alias_schemes – Enable named alias expansion schemes | both | 3.0 | domain, global, pathway, pathway_group | |
| allow_ip_literal – Allow IP addresses in email addresses | receiving | true | 3.0 | esmtp_listener, global, listen, pathway, pathway_group, peer |
| allow_null_envelope_sender – Allow the null envelope sender in email addresses | receiving | true | 3.0 | esmtp_listener, global, listen, pathway, pathway_group, peer |
| allow_trailing_whitespace_in_commands – Allow trailing white space at the end of an SMTP command | receiving | false | 3.0.26 | esmtp_listener, global, listen, pathway, pathway_group, peer |
| always_allow – When set to true, authentication is considered to have succeeded, unless always_deny is set | receiving | false | 3.0 | control_listener, esmtp_listener, http_listener, listen, pathway, pathway_group, peer |
| always_deny – If set to true, authentication is considered to have failed | receiving | false | 3.0 | control_listener, esmtp_listener, http_listener, listen, pathway, pathway_group, peer |
| apn_expiry – Define the number of seconds after which an APNs notification is no longer valid | sending | yes (non-dynamic) | 3.5.5 | binding, binding_group, domain, global |
| arp_all_hosts – Whether or not to aggressively send out ARP information to ensure that the network knows about the IP address assignment (cluster-specific) | na | true | 3.0.13 | cluster |
| async_bounce_rendering – Which thread pool to use for bounce rendering | sending | true | 3.0 | global |
| authcrammd5parameters – Configure CRAM-MD5 authentication | receiving | 3.0 | control_listener, esmtp_listener, listen, pathway, pathway_group | |
| authdigestmd5parameters – Configure DIGEST-MD5 authentication | receiving | 3.0 | control_listener, esmtp_listener, http_listener, listen, pathway, pathway_group, peer, xmpp_listener | |
| authloginparameters – Configure clear text login authentication | receiving | 3.0 | control_listener, esmtp_listener, listen, pathway, pathway_group | |
| authorization (scope) – Configure the console commands applicable to users | na | 3.0 | global | |
| authorizationparameters – AuthorizationParameters dictionary points to authorization information | receiving | 3.0 | control_listener, esmtp_listener, listen | |
| authplainparameters – Configure plain text login authentication | receiving | 3.0 | esmtp_listener, http_listener, listen, pathway, pathway_group, xmpp_listener | |
| backlog – The maximum number of jobs that can be queued up for a pool | na | 0 (non-dynamic) | 3.0 | threadpool |
| banner_hostname – Specifies the banner hostname that will be displayed to the remote client upon connecting | receiving | 3.0 | esmtp_listener, listen, pathway, pathway_group, peer | |
| bind_address – Source address for outbound connections | sending | 3.0 | binding, binding_group, global | |
| binding (scope) – Configure binding-specific options | sending | 3.0 | binding_group, global | |
| binding_group (scope) – Logically group a set of bindings | sending | 3.0 | global | |
| blackhole – Blackhole mail | sending | false | 3.0 | binding, binding_group, domain, global |
| body_timeout – Network timeout once the DATA phase is complete | sending | 600 | 3.0 | binding, binding_group, domain, global |
| bounce_behavior – Configure the action taken when a message is classified as a bounce | sending | pass | 3.0 | domain, global |
| bounce_cache_size – Set the maximum size of the bounce classification cache | na | 16384 | 3.6.9 | global |
| bounce_cache_ttl – Set the maximum TTL for the bounce classification cache | na | 60 | 3.6.9 | global |
| bounce_domains – Configure the list of domains eligible for bounce processing | receiving | 3.0 | global, pathway, pathway_group | |
| bounce_pattern – Configure the pattern that inbound email addresses must match to be considered bounces | sending | 3.0 | domain, global | |
| bounce_suppress_list – Configure a list of email addresses that may not be considered original recipients | sending | 3.0 | global | |
| bounces_inline_original – How much of the original message to include in MDNs | sending | headers | 3.0 | binding, binding_group, domain, global |
| capabilities – Selectively retain root capabilities | na | (non-dynamic) | 3.0 | security |
| chroot – chroot to a secure environment | na | (non-dynamic) | 3.0 | security |
| clear_mail_queue_maintainers – Reschedule the mail queue maintainer | both | false, true (3.6) | 3.0 | global |
| cluster_group – The DuraVIP™ system coordinates IP ownership responsibilities via the cluster_group extended virtual synchrony group (cluster-specific) | na | ec_cluster | 3.0 | cluster |
| cluster_max_outbound_connections – Set the maximum number of outbound connections for a domain (cluster-specific) | sending | -1 | 3.0 | binding, domain, global, host |
| cluster_outbound_throttle_connections – Limit the rate at which connections are established (cluster-specific) | sending | 3.0 | binding_group, domain, global | |
| cluster_outbound_throttle_messages – Limit the rate at which messages are delivered (cluster-specific) | sending | 3.0 | binding_group, domain, global | |
| cluster_scope_max_outbound_connections – Provide traffic shaping for outbound connections (cluster-specific) | sending | 3.0.16 | binding, binding_group, domain, global, host | |
| cluster_server_max_outbound_connections – Set the maximum number of outbound connections (cluster-specific) | sending | 3.0 | binding, binding_group, global | |
| codes – adaptive_sweep_rule bounce or fbl codes | sending | 3.2 | adaptive_sweep_rule | |
| community – Set the SNMP Community option value to the desired SNMP community the agent is to join | na | public (non-dynamic) | 3.0 | snmp |
| concurrency – Define number of available threads | receiving | 0 | 3.0 | control_listener, eccluster_listener, ecstream_listener, esmtp_listener, http_listener, listen, threadpool, xmpp_listener |
| connect_timeout – Set the connection timeout | sending | 300 | 3.0 | binding, binding_group, domain, global |
| connect_timeout_to_delay – Time interval before moving mail into the delayed queue | sending | 900 | 3.0 | binding, binding_group, domain, global |
| connection_allocation_aggressiveness – Tune the aggressiveness for establishing new connections to domains | sending | normal | 3.0 | binding, binding_group, domain, global |
| context – Use to set arbitrary connection context key value pairs | receiving | 3.0 | esmtp_listener, listen, pathway, pathway_group, peer | |
| control_cache – The name of the cache file storing asynchronous responses | na | 3.0 | logs | |
| control_client_timeout – Network timeout for Momentum control client connections | na | 60 | 3.0 | global |
| control_group – The cluster console manager utilizes this group to issue cluster-wide configuration commands (cluster-specific) | na | ec_console | 3.0 | cluster |
| control_listener (scope) – The listener for incoming control connections | na | 3.0 | global | |
| critical – Set the debug level | na | ALL | 3.0 | debug_flags |
| crypto_engine – Enable hardware cryptography acceleration | both | 3.0 | global | |
| crypto_lock_method – Change the locking method used by the TLS layer | both | EC_SSL_DEFAULTLOCK (non-dynamic) | 3.0 | global |
| debug – Set the debug level | na | 3.0 | debug_flags | |
| debug_flags (scope) – Configure debug verbosity | na | 3.0 | global | |
| debug_level – Set the module debug level (applicable to all modules) (cluster-specific) | na | error | 3.0 | cluster |
| default_binding – Control the default binding | sending | normal | 3.0 | global |
| default_charset – Control the character set | both | us-ascii | 3.0 | global, pathway, pathway_group |
| delay_dsn_max_retry_interval – Maximum interval for sending DSNs to the sender of a message that has not yet been delivered | sending | 43200 | 3.0 | binding, binding_group, domain, global |
| delay_dsn_retry_interval – Base interval for sending DSNs to the sender of a message that has not yet been delivered | sending | 3600 | 3.0 | binding, binding_group, domain, global |
| delayed_binding_domain_fuzz – The time period to spread scheduled messages over when a bulk requeue is necessary | sending | 0 | 3.0.26 | binding, binding_group, global |
| delayed_queue_scan_interval – How often to call the maintainer for a domain | sending | 15 | 3.0 | global |
| delivery_method – Set the delivery method | sending | ESMTP (3.0), SMTP (2.2) | 3.0 | binding, binding_group, domain, global |
| delivery_pool – Associate an eventloop with mail delivery | sending | (non-dynamic) | 3.6 | global |
| delivery_response_timeout – Time to wait for a response to an outbound request | sending | 5000 | 3.5.6 | binding, domain, global |
| dir_mode – The octal representation of the file permissions | na | 3.0 | logs | |
| disable_chunked – An option used with aggregators who do not support chunked transfer-coding (Mobile Momentum) | both | false | 3.1.4 | http_listener, listen, pathway, pathway_group, peer |
| disable_nagle_algorithm – Disable nagle algorithm on sockets | both | false | 3.0 | control_listener, eccluster_listener, ecstream_listener, esmtp_listener, global, http_listener, listen, xmpp_listener |
| disk_queue_drain_rate – Control the rate at which messages are spooled in on start-up | both | 100 | 3.0 | global |
| dkim – Enable or disable signing messages | sending | 3.0 | binding, binding_group, domain, global | |
| dns_cache_purge_interval – How often the DNS response cache is scanned for stale entries | sending | 60 | 3.0 | global |
| dns_expire_interval – How often to check for domains with expired DNS information | sending | 10 | 3.0 | global |
| dns_failures_to_purge – Configure the maximum number of DNS lookups | sending | 10 | 3.0 | domain, global |
| dns_fallback_to_tcp – Whether or not to fail over to TCP in place of UDP | both | false | 3.0.22 | global |
| domain (scope) – Configure domain-specific options | sending | 3.0 | binding, binding_group, global | |
| domain_for_unqualified_recipient_addresses – Configure a domain which will be used to resolve delivery for unqualified addresses | receiving | 3.0 | esmtp_listener, global, listen, pathway, pathway_group, peer | |
| domain_for_unqualified_sender_address – Configure a domain which will be used to substitute for unqualified sender addresses | receiving | 3.0 | esmtp_listener, global, listen, pathway, pathway_group, peer | |
| domainkeys – Enable or disable domainkeys signing | sending | 3.0 | binding, binding_group, domain, global | |
| drop_body_after_trans_fail – Number of retry attempts before freeing message memory | sending | 3 | 3.0 | binding, binding_group, domain, global |
| duravip_balance_set_size – When balancing DuraVIP™s, how many to process as a batch in response to a balance request (cluster-specific) | na | 1 | 3.0 | cluster |
| duravip_follow – Specify the binding a listener should follow (cluster-specific) | receiving | 3.0 | listen | |
| duravip_preference – Specify a DuraVIP™ preference (cluster-specific) | both | 3.0 | binding, listen | |
| eccluster_listener (scope) – Control communication between cluster nodes (cluster-specific) | na | 3.0.15 | global | |
| ecstream_idle_time – The number of seconds of inactivity before a client is disconnected (ECStream only) | receiving | 300 | 3.0 | ecstream_listener, listen, pathway, pathway_group, peer |
| ecstream_listener (scope) – The listener for incoming ECSTREAM connections | receiving | 3.0 | global | |
| ecstream_max_batch_size – The maximum number of ECStream messages to accept before dropping back into the scheduler (ECStream only) | receiving | 10000 | 3.0 | ecstream_listener, listen, pathway, pathway_group, peer |
| ecstream_port – Configure the port for ecstream deliveries | sending | 1825 | 3.2 | binding, binding_group, domain, global |
| ecstream_timeout – The amount of time to wait for an ecstream connection to be established | sending | 600 | 3.2 | binding, binding_group, domain, global |
| ehlo_hostname – Set the hostname used for EHLO in outbound mail | sending | hostname | 3.0 | binding, binding_group, domain, global |
| ehlo_timeout – Network timeout for EHLO | sending | 300 | 3.0 | binding, binding_group, domain, global |
| enable – Enable or disable a listener scope | receiving | true | 3.0 | control_listener, eccluster_listener, ecstream_listener, esmtp_listener, http_listener, listen, msgcserver_listener, xmpp_listener |
| enable_authentication – Whether or not to enable authentication | receiving | 3.0 | control_listener, esmtp_listener, http_listener, listen, pathway, pathway_group, peer | |
| enable_authorization – Whether or not to enable authorization for console commands | receiving | 3.0 | control_listener, listen, peer | |
| enable_duravip – Whether to enable Durable MultiVIP© bindings (cluster-specific) | both | 3.0 | binding, listen | |
| enable_fbl_header_insertion – Enable or disable fbl header insertion | sending | 3.0 | binding, binding_group, domain, global | |
| enabled – Whether or not the module is enabled (cluster-specific) | na | true | 3.0 | cluster |
| error – Set the debug level | na | ALL | 3.0 | debug_flags |
| esmtp_listener (scope) – The listener for incoming SMTP connections | receiving | 3.0 | global | |
| event_loop – Associate a listener with an eventloop | sending | (non-dynamic) | 3.6 | ecstream_listener, esmtp_listener, listen |
| eventloop (scope) – Define a pool of event loops to enable multiple event loop configuration | both | (non-dynamic) | 3.6 | global |
| events_per_iter – Employ when using a Concurrency greater than 1 | receiving | 0 | 3.0 | control_listener, eccluster_listener, ecstream_listener, esmtp_listener, http_listener, listen, xmpp_listener |
| exclude_vctx_conn – Exclude validation connection context keys from being journaled in the spool metadata | both | 3.0 | binding, binding_group, domain, global | |
| exclude_vctx_mess – Exclude validation message context keys from being journaled in the spool metadata | both | 3.0 | binding, binding_group, domain, global | |
| expensive_batch_assessment – Treat messages as equal even if the bodies or headers have been modified since reception | receiving | false | 3.0 | global |
| file_mode – File access rights in octal notation | na | 0660 | 3.0 | control_listener, eccluster_listener, ecstream_listener, esmtp_listener, http_listener, listen, msgcserver_listener, xmpp_listener |
| file_mode – The octal representation of the file permissions (cluster logs) | na | 3.0 | logs | |
| force_fsync – Ensure that data is synced to disk on reception | receiving | false | 3.0 | global |
| fully_resolve_before_smtp – Resolve all MX and A records before attempting delivery | sending | true | 3.0 | binding, binding_group, domain, global |
| gateway – Configure a static SMTP route for mail | sending | 3.0 | binding, binding_group, domain, global | |
| gcm_application_id – Define the package name of the Android application allowed to received notifications | sending | 3.5.5 | binding, binding_group, domain, global | |
| gcm_authorization_token_id – The authorization token that permits sending Google push notifications | sending | 3.5.5 | binding, binding_group, domain, global | |
| gcm_delay_while_idle – Whether or not to send the notification immediately if a device is idle | sending | false | 3.5.5 | binding, binding_group, domain, global |
| gcm_dry_run – Test a request without actually sending a message | sending | false | 3.5.5 | binding, binding_group, domain, global |
| gcm_ttl – Default Time To Live for notifications | sending | -1 | 3.5.5 | binding, binding_group, domain, global |
| generate_bounces – Generate MDNs if mail is failed after reception | sending | true | 3.0 | binding, binding_group, domain, global |
| generate_bounces_for_multi_recipient_policy_rejections – Generate MDNs after reception for policy rejections | receiving | true | 3.0 | global, pathway, pathway_group |
| generate_delay_dsn – Generate DSNs if mail is delayed | sending | false | 3.0 | binding, binding_group, domain, global |
| group – Group identity to assume after startup | na | ecuser (non-dynamic) | 3.0 | security |
| growbuf_size – The size of an element in a growbuf chain | na | 16384 | 3.0 | global |
| heartbeat_start_delay – Seconds to wait after startup before the cluster heartbeat is activated (cluster-specific) | na | 15 | 3.0 | cluster |
| heartbeats_per_sec – How often to send a heartbeat (cluster-specific) | na | 1 | 3.0 | cluster |
| high_action – The action when the high threshold is met and the number of delivery attempts exceeds the adaptive_attempt_threshold | sending | "suspend" "4 hours" | 3.2 | adaptive_sweep_rule |
| high_threshold – The high threshold value for the sum of the rates of the bounce codes or FBL categories | sending | 10 | 3.2 | adaptive_sweep_rule |
| host (scope) – Configure host-specific options | sending | 3.0 | binding, binding_group, global | |
| host_failure_retry – Time to wait before attempting a retry | sending | 120 | 3.0 | domain, global |
| hostname – Override the system configured hostname | both | 3.0 | global | |
| http_basic_auth – Define the user credentials when using basic HTTP authentication | both | 3.5.6 | binding, binding_group, domain, global | |
| http_host – Define the HTTP host | sending | 3.5.6 | binding, binding_group, domain, global | |
| http_listener (scope) – The listener used with the REST injector | sending | 3.1.4 | global | |
| http_method – Define the HTTP method to use | sending | POST | 3.5.6 | binding, binding_group, domain, global |
| http_uri – Define the HTTP URI that you wish to connect to | sending | 3.5.6 | binding, binding_group, domain, global | |
| http_version – Define the HTTP version to use | sending | 1.1 | 3.5.6 | binding, binding_group, domain, global |
| idle_time – The number of seconds of inactivity before a client is disconnected | receiving | 0 | 3.0 | esmtp_listener, http_listener, listen, pathway, pathway_group, peer, xmpp_listener |
| idle_timeout – Time to maintain idle outbound connections | sending | 5 | 3.0 | binding, binding_group, domain, global |
| if_check_interval – How often to run through a maintenance cycle (cluster-specific) | na | 30 | 3.0 | cluster |
| if_down_limit – How long to wait before deciding to bring an IP online (cluster-specific) | na | 4 | 3.0 | cluster |
| inbound_throttle_messages – Rate limit inbound mail | receiving | 3.0 | global, pathway, pathway_group | |
| info – Set the debug level | na | 3.0 | debug_flags | |
| initial_hash_buckets – Set the number of hash buckets used by the system | na | 32 | 3.1 | global |
| inline_transfail_processing – How to handle transient failure processing | sending | 1 | 3.0 | global |
| keep_message_dicts_in_memory – Preserve memory representation of metadata when memory is low | both | false (non-dynamic) | 3.0 | global |
| large_message_threshold – Consider a message large when its size exceeds this amount | both | 131072 | 3.0 | global |
| legacy_message_threshold – The maximum size allowed for messages being passed to legacy modules | both | 1048576 | 3.0 | global |
| license – Specify an alternate license location | na | /opt/msys/ecelerity/etc (non-dynamic) | 3.0 | global |
| listen (scope) – Specify the socket that a listener listens on | receiving | 3.0 | control_listener, ecstream_listener, esmtp_listener, http_listener, msgcserver_listener, xmpp_listener | |
| listen_backlog – The listen backlog | receiving | 500 (3.0) | 3.0 | control_listener, eccluster_listener, ecstream_listener, esmtp_listener, http_listener, listen, xmpp_listener |
| listener_sessions – Specifies the maximum number of concurrent sessions that can be established to a listener | receiving | 0 | 3.0 | esmtp_listener, listen, pathway, pathway_group, peer |
| lmtp_port – Configure the port for LMTP deliveries | sending | 2003 | 3.0 | binding, binding_group, domain, global |
| local_changes_file – The file for writing local configuration changes | na | /opt/msys/ecelerity/etc/local_changes.conf | 3.0 | global |
| local_changes_only – Whether there is a file for writing local configuration change | na | false | 3.0 | global |
| log_active_interval – Used to tune centralized logging (cluster-specific) | na | 1 | 3.0 | cluster |
| log_group – Whether or not panic log messages are broadcast over spread (cluster-specific) | na | 3.0 | cluster | |
| log_idle_interval – The amount of time to sleep before looking for another segment (cluster-specific) | na | 10 | 3.0 | cluster |
| log_requests_to_paniclog – Whether to log REST injection requests | sending | false | 3.1.4 | http_listener, listen, pathway, pathway_group, peer |
| logfile – Describe the full path to the log file | na | 3.0 | logs | |
| logs – Define the location of the cluster manager logs (cluster-specific) | na | 3.0 | cluster | |
| logs (scope) – Configure centralized log files on the cluster manager | na | 3.0 | global | |
| low_action – The action when the high threshold is not met but the low threshold is met | sending | "throttle" "down" | 3.2 | adaptive_sweep_rule |
| low_threshold – The low threshold value for the sum of the rates of the bounce codes or FBL categories | sending | 5 | 3.2 | adaptive_sweep_rule |
| mail_queue_check_vm_interval – How often to apply memory management reduction on mail queues | both | 60 | 3.0 | global |
| mailerdaemon – Set the From: address for MDNs | sending | 3.0 | binding, binding_group, domain, global | |
| mailfrom_timeout – Timeout after MAIL FROM | sending | 300 | 3.0 | binding, binding_group, domain, global |
| maintainer_pool – Create an eventloop for maintainers | both | (non-dynamic) | 3.6 | global |
| malloc2mmap_threshold – Use mmap when allocations exceed this amount | na | 4092 | 3.0 | global |
| manager (scope) – Define managers for subclusters | na | 3.0 | logs | |
| masterdb_file – Specify an alternate path for the statistics permastore | na | /var/log/ecelerity/ecdb (non-dynamic) | 3.0 | global |
| match_cache_life – Set the maximum number of seconds that the match cache will be valid | na | 0 | 3.0 | global |
| match_cache_size – The size of the cache that holds the results of looking up matching scopes | na | 16384 | 3.0 | global |
| max_deliveries_per_connection – Maximum number of messages to deliver before closing a connection | sending | 0 | 3.0 | binding, binding_group, domain, global |
| max_dns_ttl – Set the maximum DNS TTL | sending | 4294967295 | 3.0 | global |
| max_idle – The maximum number of seconds a log file may be left open | na | 3.0 | logs | |
| max_message_size – The maximum number of bytes allowed in a single message | receiving | 0 | 3.0 | esmtp_listener, listen, pathway, pathway_group, peer |
| max_open – The maximum number of concurrently open log files | na | 3.0 | logs | |
| max_outbound_connections – Set the maximum number of outbound connections | sending | 32 | 3.0 | binding, binding_group, domain, global, host |
| max_receptions_per_connection – The maximum number of messages allowed in a single session | receiving | 0 | 3.0 | esmtp_listener, global, listen, pathway, pathway_group, peer |
| max_recipients_per_batch – The maximum number of recipients to send in a single outbound message transaction | sending | 100 | 3.0 | binding, binding_group, domain, global |
| max_recipients_per_connection – The maximum number of recipients to send on a connection | sending | 0 | 3.0 | binding, binding_group, domain, esmtp_listener, global, listen, peer |
| max_recipients_per_message – The maximum number of recipients allowed in a message | receiving | 0 | 3.0 | esmtp_listener, listen, pathway, pathway_group, peer |
| max_request_size – Limit the size of an HTTP request | both | 3.1.4 | http_listener, listen, pathway, pathway_group, peer | |
| max_resident_active_queue – Threshold above which messages are not held in memory | sending | 250 | 3.0 | binding, binding_group, domain, global |
| max_resident_messages – Threshold above which messages are not held in memory | sending | 32768 | 3.0 | binding, binding_group, global |
| max_resident_transfails – If the transient failure queue grows beyond this size, messages are swapped out of memory | sending | 100 | 3.0 | global |
| max_retries – Override the system configured max_retries | sending | 3.0 | binding, binding_group, domain, global | |
| max_retry_interval – Maximum retry interval | sending | 43200 | 3.0 | binding, binding_group, domain, global |
| max_timed_events_per_iter – The maximum numer of timed events per scheduler iteration | na | 1024 | 3.0.22 | global |
| mbus_daemon (deprecated) – The port that the messaging bus listens on (cluster-specific) | na | 4803 | 3.0 | cluster |
| mcmt_reception – Configure a listener to accept the Multi-Channel Message Type (Mobile Momentum) | both | passthru | 3.1.4 | esmtp_listener, listen, pathway, pathway_group, peer |
| mdn_failures_notify – Mailbox to which to send null recipient MDNs | sending | 3.0 | binding, binding_group, domain, global | |
| memory_goal – Configure physical memory usage goal | na | 90 | 3.0 | global |
| memory_hwm – Configure physical memory usage high-water mark | na | 95 | 3.0 | global |
| message_expiration – Time to live for messages | sending | 86400 | 3.0 | binding, binding_group, domain, global |
| migrate_connections_between_sibling_domains – Optimize connections for sibling domains | both | true | 3.4 | global |
| mime_parse_large_messages_during_reception – Configure whether large messages are parsed upon reception or just in time | receiving | true | 3.0 | global |
| min_dns_ttl – Override DNS TTLs smaller than this value | sending | 0 | 3.0 | global |
| mx_failures_fallback_to_a – Configure the maximum number of times an MX lookup will be attempted | sending | 3 | 3.0 | domain, global |
| mx_failures_to_delay – Number of consecutive failures before a domain is auto-delayed | sending | 50 | 3.0 | domain, global |
| never_attempt_expired_messages – Never attempt delivery of expired messages | sending | false | 3.0 | binding, binding_group, domain, global |
| never_retry – Whether or not to retry delivery of failed messages | sending | false | 3.0 | binding, binding_group, domain, global |
| nodeaddr – The canonical cluster address for the node (cluster-specific) | na | 3.0 | cluster | |
| nodename – Override the node name that is used to canonically identify this cluster node (cluster-specific) | na | 3.0 | cluster | |
| notice – Set the debug level | na | 3.0 | debug_flags | |
| only_use_best_mx_for_relay_domains – If this is set to true only the lowest numerical priority MXs are used | sending | true | 3.0 | global |
| open_relay – Whether the MTA is an open relay or not | receiving | false | 3.0 | esmtp_listener, listen, pathway, pathway_group, peer |
| opendkim_sign – Whether or not to enable OpenDKIM signing | sending | true (non-dynamic) | 3.6 | binding, binding_group, domain, global |
| outbound_throttle_connections – Limit the rate at which connections are established | sending | 3.0 | binding, binding_group, domain, global | |
| outbound_throttle_messages – Limit the rate at which messages are delivered | sending | 3.0 | binding, binding_group, domain, global | |
| pathway (scope) – A grouping of inbound configuration options | receiving | 3.0.23 | global, pathway_group | |
| pathway – A means for associating a Listener with a pathway scope | receiving | 3.0.23 | ecstream_listener, esmtp_listener, listen, peer | |
| pathway_group (scope) – A container for pathway scopes | receiving | 3.0.23 | global | |
| pcre_cache_size – Set the maximum size of the ec_pcre_compile cache | na | 100 | 3.0 | global |
| pcre_cache_ttl – Set the maximum TTL for the ec_pcre_compile cache | na | 300 | 3.0 | global |
| peer (scope) – Create an ACL within a specific listener | receiving | 3.0 | control_listener, ecstream_listener, esmtp_listener, http_listener, listen, xmpp_listener | |
| permastore_interval – The frequency for saving various statistics | na | 300 | 3.0 | global |
| pidfile – Set the PID file path | na | /var/run/ecelerity.pid (non-dynamic) | 3.0 | global |
| pool_name – Associate a threadpool with a listener | receiving | 3.0 | control_listener, eccluster_listener, ecstream_listener, esmtp_listener, http_listener, listen, xmpp_listener | |
| prefer_ipv6_mxs - Prefer IPv6 addresses over IPv4 addresses at a given MX priority level | sending | false | 3.6.12 | global |
| privileges – Selectively retain root capabilities (Solaris) | na | (non-dynamic) | 3.0 | security |
| prohibited_hosts – Prevent mail from being delivered to invalid destinations | sending | 3.0 | global | |
| rcptto_timeout – Timeout after RCPT TO | sending | 300 | 3.0 | binding, binding_group, domain, global |
| received_hostname – The hostname that is placed in the received headers | receiving | 3.0 | esmtp_listener, listen, pathway, pathway_group, peer | |
| reconfig_message – The message if the configuration has changed | receiving | 4.3.2 Reconfiguration in progress | 3.0 | esmtp_listener |
| relay_domains – Configure the list of domains for which Momentum relays mail | receiving | 3.0 | global, pathway, pathway_group | |
| relay_for_sending_domains – Domains that may use the MTA as a relay | receiving | 3.0 | esmtp_listener, listen, pathway, pathway_group, peer | |
| relay_hosts – Configure the list of hosts for which Momentum relays mail | receiving | 3.0 | esmtp_listener, global, listen, pathway, pathway_group, peer | |
| remote_smtp_port – Set the port to be used for SMTP deliveries | sending | 25 | 3.0 | binding, binding_group, domain, global |
| replicate (scope) – Define the cluster replication framework (cluster-specific) | na | 3.0 | cluster | |
| require_ehlo – Reject mail from clients that do not say HELO | receiving | false | 3.0 | esmtp_listener, global, listen, pathway, pathway_group, peer |
| reserve_maintenance_interval – How often to perform mail queue maintenance | sending | 15 | 3.0 | global |
| resolv_conf – Specify a custom resolv.conf file | sending | 3.0 | global | |
| response_transcode_pattern – The regex pattern for comparison to a server response | sending | 3.0 | binding, binding_group, domain, global | |
| response_transcode_replace – The replacement string for a server response | sending | 3.0 | binding, binding_group, domain, global | |
| retry_interval – Base retry interval | sending | 1200 | 3.0 | binding, binding_group, domain, global |
| rfc2821_allow_whitespace_in_envelope – Permit trailing white space before the final CRLF | receiving | false | 3.0.26 | global, pathway, pathway_group |
| rfc2821_pedantic_address_rules – Allow relaxation of enforcement of the rfc2821 address rules | receiving | true | 3.0 | global, pathway, pathway_group |
| rfc2822_date_header – Allow relaxation of enforcement of the rfc2822 address rules | receiving | ifneeded | 3.0 | global, pathway, pathway_group |
| rfc2822_lone_lf_in_body – Allow relaxation of enforcement of the rfc2822 address rules | receiving | ignore | 3.0 | global, pathway, pathway_group |
| rfc2822_lone_lf_in_headers – Allow relaxation of enforcement of the rfc2822 address rules | receiving | pedantic | 3.0 | global, pathway, pathway_group |
| rfc2822_max_line_length – Allow relaxation of enforcement of the rfc2822 address rules | receiving | ignore | 3.0 | global, pathway, pathway_group |
| rfc2822_max_line_length_policy – Determine how non-RFC-compliant line lengths are handled | receiving | none | 3.0.26 | global, pathway, pathway_group |
| rfc2822_messageid_header – Allow relaxation of enforcement of the rfc2822 address rules | receiving | ifneeded | 3.0 | global, pathway, pathway_group |
| rfc2822_missing_headers – Allow relaxation of enforcement of the rfc2822 address rules | receiving | reject | 3.0 | global, pathway, pathway_group |
| rfc2822_trace_headers – Allow relaxation of enforcement of the rfc2822 address rules | receiving | true | 3.0 | global, pathway, pathway_group |
| role (scope) – Define a role within an authorization stanza | na | 3.0 | authorization | |
| routes – Configure message routing | sending | 3.0 | domain, global | |
| rset_timeout – Set the timeout after RSET | sending | 30 | 3.0 | binding, binding_group, domain, global |
| scheduler – Override the default IO scheduler | na | (non-dynamic) | 3.0 | global |
| scope_max_outbound_connections – Provide traffic shaping for outbound connections | sending | 3.2 | binding, binding_group, domain, global | |
| security (scope) – Scope for defining which permissions are retained by which user | na | (non-dynamic) | 3.0 | global |
| send_8bitmime – Enable advertising of 8BITMIME when sending mail | sending | no | 3.0 | binding, binding_group, domain, global |
| server_max_file_descriptors – Sets the maximum number of file descriptors usable by the system | na | 3000000 | 3.0 | global |
| server_max_outbound_connections – Sets the maximum number of outbound connections | sending | 20000 | 3.0 | binding, binding_group, global |
| server_reserve_outbound_connections – Sets the server-wide connection limit reserve | sending | 200 | 3.0 | global |
| service_sessions – The maximum number of concurrent sessions that can be established to all listeners | receiving | 0 | 3.0 | esmtp_listener, listen, pathway, pathway_group, peer |
| signing_stats – Control how signing statistics are recorded | sending | all | 3.0.17 | global |
| siv_throttle_cache_size – Set the maximum number of named throttles | both | 100, 1000 (3.0.24) | 3.0 | global |
| smtp_extensions – Array of SMTP extensions | receiving | 3.0 | esmtp_listener, listen, pathway, pathway_group, peer | |
| snmp (scope) – Simple Network Management Protocol Support scope options | na | (non-dynamic) | 3.0 | global |
| snmp_traps (scope) – Enable and configure generation of SNMP traps | na | (non-dynamic) | 3.0 | global |
| soft_bounce_drain_rate – How many soft bounces to place into the mail queues in a single scheduler iteration | sending | 100 | 3.0 | global |
| spool_mode – Set the file mode for newly created spool files | na | 0640 (non-dynamic) | 3.0 | global |
| spoolbase – Set the base directory for the spool | na | /var/spool/ecelerity (non-dynamic) | 3.0 | global |
| ssl_lock_method – The SSL lock method | na | mutex (3.0.17) (non-dynamic) | 3.0 | global |
| stack_size – The stack space for a threadpool | na | 0 (non-dynamic) | 3.0 | threadpool |
| starttls_injection_policy – Protect against SMTP injections prior to TLS | receiving | reject | 3.3 | esmtp_listener, listen, pathway, pathway_group, peer |
| state – Whether to enable the SNMP agent | na | 1 (non-dynamic) | 3.0 | snmp |
| state – Whether to enable generation of SNMP traps | na | 0 (non-dynamic) | 3.0 | snmp_traps |
| static_banner – The banner that is displayed to the remote client | receiving | 3.0 | esmtp_listener, listen, pathway, pathway_group, peer | |
| subcluster (deprecated) – The name of the subcluster (cluster-specific) | na | 3.0 | cluster | |
| supplemental_groups – Supplemental groups to assume after startup | na | (non-dynamic) | 3.0 | security |
| suspend_delivery – Prevent outbound mail delivery | sending | false | 3.0 | binding, binding_group, domain, global |
| syscontact – Set the SNMP SysContact option value | na | (non-dynamic) | 3.0 | snmp |
| sysdescription – Set the SNMP SysDescription option value | na | (non-dynamic) | 3.0 | snmp |
| syslocation – Set the SNMP SysLocation option value | na | (non-dynamic) | 3.0 | snmp |
| tcp_buffer_size – Maximum tcp buffer size for outbound connections | sending | 32768 | 3.0 | cluster, global |
| tcp_recv_buffer_size – The size of the TCP receive buffer size | receiving | 4096 | 3.0 | control_listener, eccluster_listener, ecstream_listener, esmtp_listener, http_listener, listen, xmpp_listener |
| tcp_send_buffer_size – The size of the TCP send buffer | receiving | 4096 | 3.0 | control_listener, eccluster_listener, ecstream_listener, esmtp_listener, http_listener, listen, xmpp_listener |
| threadpool (scope) – Configure thread pool specific options | na | 3.0 | global | |
| timeout – The timeout for idle control connections on Control_Listeners | receiving | 60 | 3.0 | control_listener |
| timestampformat – Set the timestamp format used when logging to stderr | na | [%a %d %b %Y %H:%M:%S] | 3.0 | global |
| tls – Determine whether to use a TLS connection for outbound mail | sending | no | 3.0 | binding, binding_group, domain, global |
| tls_allow_renegotiation – Whether to enable OpenSSL TLS renegotiation | both | true | 3.5.4 | ecstream_listener, esmtp_listener, http_listener, listen, listen, pathway, pathway_group, peer, xmpp_listener |
| tls_ca – Certificate authority for outbound mail | sending | 3.0 | binding, binding_group, domain, global | |
| tls_certificate – Certificate to use for inbound and outbound mail | both | 3.0 | binding, binding_group, domain, ecstream_listener, esmtp_listener, global, http_listener, listen, pathway, pathway_group, peer, xmpp_listener | |
| tls_ciphers – Allowable ciphers for a TLS session | both | 3.0 | binding, binding_group, domain, ecstream_listener, esmtp_listener, global, http_listener, listen, pathway, pathway_group, peer, xmpp_listener | |
| tls_client_ca – Certificate authority for inbound mail | receiving | 3.0 | ecstream_listener, esmtp_listener, global, http_listener, listen, pathway, pathway_group, peer, xmpp_listener | |
| tls_dhparams_file – Specifies DHE parameters that add per-session randomness to the encryption | both | 3.6.6 | global | |
| tls_enable_dhe_ciphers – Controls whether or not DHE ciphers are available | both | true | 3.6.6 | global |
| tls_ifavailable_fallback – Determine the behavior if TLS negotiation fails | sending | true | 3.5.10, 3.6.4 | binding, binding_group, domain, global |
| tls_key – the TLS key to use for outbound mail or inbound mail | both | 3.0 | binding, binding_group, domain, ecstream_listener, esmtp_listener, global, http_listener, listen, pathway, pathway_group, peer, xmpp_listener | |
| tls_protocols – Allowable ciphers for TLS inbound and outbound sessions | both | 3.6.6 | binding, binding_group, domain, ecstream_listener, esmtp_listener, global, http_listener, listen, pathway, pathway_group, peer | |
| tls_verified_peer_can_relay – Verification that peer can relay | receiving | false | 3.0 | ecstream_listener, esmtp_listener, listen, pathway, pathway_group, peer |
| tls_verified_peer_is_authorized – Mark requests that use a verified SSL Client certificate as being authorized | sending | false | 3.1.4 | http_listener, listen, pathway, peer |
| tls_verify – Specify how to handle the remote certificates | sending | no | 3.0 | binding, binding_group, domain, global |
| tls_verify_mode – Determine whether a TLS certificates is required | receiving | 3.0 | ecstream_listener, esmtp_listener, http_listener, listen, pathway, pathway_group, peer, xmpp_listener | |
| topology (scope) – Define the cluster network topology (cluster-specific) | na | 3.0 | cluster | |
| trace_smtp_mode – Set the default permissions of trace files | sending | 0640 (non-dynamic) | 3.0 | global |
| transfail_drain_rate – The maximum number of messages to pop off the transient failure queue in a single scheduler iteration | sending | 100 | 3.0 | global |
| transform_8bitmime_content – Enable 8BITMIME downconversion when sending mail | sending | ifneeded (3.1.6) | 3.0 | binding, binding_group, domain, global |
| trap_destination – Destination for SNMP trap | na | (non-dynamic) | 3.0 | snmp_traps |
| trap_interval – Frequency of SNMP trap generation | na | 60 (non-dynamic) | 3.0 | snmp_traps |
| unconditional_rebind – Whether the full set_binding logic is invoked or not (cluster-specific) | na | true | 3.0 | cluster |
| unlink_on_spool_in_failure – Whether or not to remove malformed messages | receiving | true | 3.0 | global |
| use_iflist_cache – Whether or not to cache the list of interfaces configured by the system | sending | 0 (non-dynamic) | 3.0 | global |
| use_ipv6 – Affects the selection of IPv6 hosts in the SMTP client | sending | false | 3.0 | global |
| use_mmap – Use mmap when spooling messages from disk | na | false | 3.0 | global |
| use_sendfile – Use sendfile() when sending mail | sending | false | 3.0 | global |
| use_ssl – Whether to use SSL verification | receiving | false | 3.0 | ecstream_listener, esmtp_listener, http_listener, listen, pathway, pathway_group, peer |
| user – User identity to assume after startup | na | ecuser (non-dynamic) | 3.0 | security |
| view_balance_interval – How often DuraVIP™ views are subject to balancing (cluster-specific) | na | 10 | 3.0 | cluster |
| view_broadcast_interval – How often to speculatively broadcast a view announcement to the cluster (cluster-specific) | na | 0 | 3.0 | cluster |
| view_mature_time – How long a DuraVIP™ view needs to remain unchanged before considering it "mature" (cluster-specific) | na | 5 | 3.0 | cluster |
| warning – Set the debug level | na | 3.0 | debug_flags | |
| watch_interval – Interval for watched system variables for SNMP traps | na | 10 (non-dynamic) | 3.0 | snmp_traps |
| watch_variables – SNMP traps watch variables | na | (non-dynamic) | 3.0 | snmp_traps |
| watchdog_interval (deprecated) – If Momentum is unresponsive for this length of time, it will be restarted | na | 60 | 3.0 | global |
| xclient – Use the XCLIENT extension to SMTP for outbound mail | sending | no | 3.0 | binding, binding_group, domain, global |
| xmpp_dialback_secret – Use when verifying the XMPP server dialback key (Mobile Momentum) | both | 3.4 | domain | |
| xmpp_listener (scope) – The listener for incoming XMPP connections (Mobile Momentum) | receiving | 3.4 | global | |
| xmpp_role – Define whether a domain is an XMPP server or client (Mobile Momentum) | both | 3.4 | domain |
This section displays all options of the specified type sorted alphabetically.
| Option/Description | Type | Default | Version | Scopes |
|---|---|---|---|---|
| adaptive_adjustment_interval – Throttle the adaptive adjustment interval | sending | 60 | 3.0 | binding, binding_group, domain, global |
| adaptive_alert_email_destination – The address where adaptive alerts should be sent | sending | 3.0 | binding, binding_group, domain, global | |
| adaptive_alert_email_sender – Set the sender address of the alert email | sending | NULL | 3.0.17 | binding, binding_group, domain, global |
| adaptive_attempt_threshold – The minimum delivery attempts over a period during which bounce stats are collected and suspensions attempted | sending | 2000 (3.2) | 3.0 | binding, binding_group, domain, global |
| adaptive_backstore_leveldb (scope) – Use LevelDB as the backing store for Adaptive Delivery | sending | 3.6 | global | |
| adaptive_backstore_riak (scope) – Define the characteristics of the Riak backing store | sending | 3.6 | global | |
| adaptive_body_timeout – Set the bounds for the adaptive option | sending | 3.0 | binding, binding_group, domain, global | |
| adaptive_default_suspension – The amount of time to suspend a domain | sending | 4 hours | 3.0 | binding, binding_group, domain, global |
| adaptive_default_suspension_enabled – Enables and disables adaptive_rejection_rate_suspension_percentage | sending | false | 3.6.11 | binding, binding_group, domain, global |
| adaptive_ehlo_timeout – Set the bounds for the adaptive option | sending | 3.0 | binding, binding_group, domain, global | |
| adaptive_enabled – Whether to enable the adaptive module for a specific scope | sending | false | 3.0 | binding, binding_group, domain, global |
| adaptive_fbl_volume_threshold – The minimum total delivered mail count over a period during which FBL stats are collected | sending | 20000 | 3.2 | binding, binding_group, domain, global |
| adaptive_idle_timeout – Set the bounds for the adaptive option | sending | 3.0 | binding, binding_group, domain, global | |
| adaptive_mailfrom_timeout – Set the bounds for the adaptive option | sending | 3.0 | binding, binding_group, domain, global | |
| adaptive_max_deliveries_per_connection – Set the bounds for the adaptive option | sending | 3.0 | binding, binding_group, domain, global | |
| adaptive_max_outbound_connections – Set the bounds for the adaptive option | sending | 3.0 | binding, binding_group, domain, global | |
| adaptive_max_recipients_per_batch – Set the bounds for the adaptive option | sending | 3.0 | binding, binding_group, domain, global | |
| adaptive_max_recipients_per_connection – Set the bounds for the adaptive option | sending | 3.0 | binding, binding_group, domain, global | |
| adaptive_max_resident_active_queue – Set the bounds for the adaptive option | sending | 3.0 | binding, binding_group, domain, global | |
| adaptive_max_retries – Set the bounds for the adaptive option | sending | 3.0 | binding, binding_group, domain, global | |
| adaptive_max_retry_interval – Set the bounds for the adaptive option | sending | 3.0.17 | binding, binding_group, domain, global | |
| adaptive_notification_events – Configure the events that will trigger an email notification | sending | throttle suspension blackhole | 3.5.6, 3.6.1 | binding, binding_group, domain, global |
| adaptive_notification_interval – The throttle for adaptive alert notification emails | sending | 3600 | 3.0 | binding, binding_group, domain, global |
| adaptive_outbound_throttle_messages – Set the bounds for the adaptive option | sending | 3.0 | binding, binding_group, domain, global | |
| adaptive_positive_adjustment_interval – Throttle positive adjustments to adaptive changes | sending | 3600 | 3.0 | binding, binding_group, domain, global |
| adaptive_rcptto_timeout – Set the bounds for the adaptive option | sending | 3.0 | binding, binding_group, domain, global | |
| adaptive_rejection_rate_suspension_percentage – The rate at which messages are rejected | sending | 20 | 3.0 | binding, binding_group, domain, global |
| adaptive_retry_fuzz – Allow greater control over bulk message retries in cases where all messages for a domain have to be retried | sending | 4096 | 3.0.26 | binding, binding_group, domain, global |
| adaptive_retry_interval – Set the bounds for the adaptive option | sending | 3.0 | binding, binding_group, domain, global | |
| adaptive_rset_timeout – Set the bounds for the adaptive option | sending | 3.0 | binding, binding_group, domain, global | |
| adaptive_scope – Define the scope applicable to adaptive delivery | sending | auto | 3.3 | binding, binding_group, domain, global |
| adaptive_sweep_rule (scope) – Set the thresholds and actions for adaptive fbl and bounce rules | sending | 3.2 | binding, binding_group, domain, global | |
| adaptive_sweep_rule_enabled – Enable or disable adaptive_sweep_rule in a specified scope | sending | 1 | 3.2 | binding, binding_group, domain, global |
| codes – adaptive_sweep_rule bounce or fbl codes | sending | 3.2 | adaptive_sweep_rule | |
| high_action – The action when the high threshold is met and the number of delivery attempts exceeds the adaptive_attempt_threshold | sending | "suspend" "4 hours" | 3.2 | adaptive_sweep_rule |
| high_threshold – The high threshold value for the sum of the rates of the bounce codes or FBL categories | sending | 10 | 3.2 | adaptive_sweep_rule |
| low_action – The action when the high threshold is not met but the low threshold is met | sending | "throttle" "down" | 3.2 | adaptive_sweep_rule |
| low_threshold – The low threshold value for the sum of the rates of the bounce codes or FBL categories | sending | 5 | 3.2 | adaptive_sweep_rule |
This section displays all options of the specified type sorted alphabetically.
| Option/Description | Type | Default | Version | Scopes |
|---|---|---|---|---|
| async_bounce_rendering – Which thread pool to use for bounce rendering | sending | true | 3.0 | global |
| bounce_behavior – Configure the action taken when a message is classified as a bounce | sending | pass | 3.0 | domain, global |
| bounce_cache_size – Set the maximum size of the bounce classification cache | na | 16384 | 3.6.9 | global |
| bounce_cache_ttl – Set the maximum TTL for the bounce classification cache | na | 60 | 3.6.9 | global |
| bounce_domains – Configure the list of domains eligible for bounce processing | receiving | 3.0 | global, pathway, pathway_group | |
| bounce_pattern – Configure the pattern that inbound email addresses must match to be considered bounces | sending | 3.0 | domain, global | |
| bounce_suppress_list – Configure a list of email addresses that may not be considered original recipients | sending | 3.0 | global | |
| bounces_inline_original – How much of the original message to include in MDNs | sending | headers | 3.0 | binding, binding_group, domain, global |
| generate_bounces – Generate MDNs if mail is failed after reception | sending | true | 3.0 | binding, binding_group, domain, global |
| generate_bounces_for_multi_recipient_policy_rejections – Generate MDNs after reception for policy rejections | receiving | true | 3.0 | global, pathway, pathway_group |
| generate_delay_dsn – Generate DSNs if mail is delayed | sending | false | 3.0 | binding, binding_group, domain, global |
| inline_transfail_processing – How to handle transient failure processing | sending | 1 | 3.0 | global |
| mailerdaemon – Set the From: address for MDNs | sending | 3.0 | binding, binding_group, domain, global | |
| mdn_failures_notify – Mailbox to which to send null recipient MDNs | sending | 3.0 | binding, binding_group, domain, global | |
| never_retry – Whether or not to retry delivery of failed messages | sending | false | 3.0 | binding, binding_group, domain, global |
| soft_bounce_drain_rate – How many soft bounces to place into the mail queues in a single scheduler iteration | sending | 100 | 3.0 | global |
| transfail_drain_rate – The maximum number of messages to pop off the transient failure queue in a single scheduler iteration | sending | 100 | 3.0 | global |
This section displays all options of the specified type sorted alphabetically.
| Option/Description | Type | Default | Version | Scopes |
|---|---|---|---|---|
| arp_all_hosts – Whether or not to aggressively send out ARP information to ensure that the network knows about the IP address assignment (cluster-specific) | na | true | 3.0.13 | cluster |
| control_cache – The name of the cache file storing asynchronous responses | na | 3.0 | logs | |
| control_group – The cluster console manager utilizes this group to issue cluster-wide configuration commands (cluster-specific) | na | ec_console | 3.0 | cluster |
| debug_level – Set the module debug level (applicable to all modules) (cluster-specific) | na | error | 3.0 | cluster |
| dir_mode – The octal representation of the file permissions | na | 3.0 | logs | |
| duravip_balance_set_size – When balancing DuraVIP™s, how many to process as a batch in response to a balance request (cluster-specific) | na | 1 | 3.0 | cluster |
| enabled – Whether or not the module is enabled (cluster-specific) | na | true | 3.0 | cluster |
| file_mode – The octal representation of the file permissions (cluster logs) | na | 3.0 | logs | |
| heartbeat_start_delay – Seconds to wait after startup before the cluster heartbeat is activated (cluster-specific) | na | 15 | 3.0 | cluster |
| heartbeats_per_sec – How often to send a heartbeat (cluster-specific) | na | 1 | 3.0 | cluster |
| if_check_interval – How often to run through a maintenance cycle (cluster-specific) | na | 30 | 3.0 | cluster |
| if_down_limit – How long to wait before deciding to bring an IP online (cluster-specific) | na | 4 | 3.0 | cluster |
| log_active_interval – Used to tune centralized logging (cluster-specific) | na | 1 | 3.0 | cluster |
| log_group – Whether or not panic log messages are broadcast over spread (cluster-specific) | na | 3.0 | cluster | |
| log_idle_interval – The amount of time to sleep before looking for another segment (cluster-specific) | na | 10 | 3.0 | cluster |
| logfile – Describe the full path to the log file | na | 3.0 | logs | |
| logs – Define the location of the cluster manager logs (cluster-specific) | na | 3.0 | cluster | |
| logs (scope) – Configure centralized log files on the cluster manager | na | 3.0 | global | |
| manager (scope) – Define managers for subclusters | na | 3.0 | logs | |
| max_idle – The maximum number of seconds a log file may be left open | na | 3.0 | logs | |
| max_open – The maximum number of concurrently open log files | na | 3.0 | logs | |
| mbus_daemon (deprecated) – The port that the messaging bus listens on (cluster-specific) | na | 4803 | 3.0 | cluster |
| nodeaddr – The canonical cluster address for the node (cluster-specific) | na | 3.0 | cluster | |
| nodename – Override the node name that is used to canonically identify this cluster node (cluster-specific) | na | 3.0 | cluster | |
| replicate (scope) – Define the cluster replication framework (cluster-specific) | na | 3.0 | cluster | |
| subcluster (deprecated) – The name of the subcluster (cluster-specific) | na | 3.0 | cluster | |
| topology (scope) – Define the cluster network topology (cluster-specific) | na | 3.0 | cluster | |
| unconditional_rebind – Whether the full set_binding logic is invoked or not (cluster-specific) | na | true | 3.0 | cluster |
| view_balance_interval – How often DuraVIP™ views are subject to balancing (cluster-specific) | na | 10 | 3.0 | cluster |
| view_broadcast_interval – How often to speculatively broadcast a view announcement to the cluster (cluster-specific) | na | 0 | 3.0 | cluster |
| view_mature_time – How long a DuraVIP™ view needs to remain unchanged before considering it "mature" (cluster-specific) | na | 5 | 3.0 | cluster |
This section displays all options of the specified type sorted alphabetically.
| Option/Description | Type | Default | Version | Scopes |
|---|---|---|---|---|
| delivery_response_timeout – Time to wait for a response to an outbound request | sending | 5000 | 3.5.6 | binding, domain, global |
| http_basic_auth – Define the user credentials when using basic HTTP authentication | both | 3.5.6 | binding, binding_group, domain, global | |
| http_host – Define the HTTP host | sending | 3.5.6 | binding, binding_group, domain, global | |
| http_method – Define the HTTP method to use | sending | POST | 3.5.6 | binding, binding_group, domain, global |
| http_uri – Define the HTTP URI that you wish to connect to | sending | 3.5.6 | binding, binding_group, domain, global | |
| http_version – Define the HTTP version to use | sending | 1.1 | 3.5.6 | binding, binding_group, domain, global |
This section displays all options of the specified type sorted alphabetically.
| Option/Description | Type | Default | Version | Scopes |
|---|---|---|---|---|
| accept_queue_backlog – The accept queue backlog | receiving | 0 | 3.0 | control_listener, eccluster_listener, ecstream_listener, esmtp_listener, http_listener, listen, msgcserver_listener, xmpp_listener |
| context – Use to set arbitrary connection context key value pairs | receiving | 3.0 | esmtp_listener, listen, pathway, pathway_group, peer | |
| control_listener (scope) – The listener for incoming control connections | na | 3.0 | global | |
| disable_chunked – An option used with aggregators who do not support chunked transfer-coding (Mobile Momentum) | both | false | 3.1.4 | http_listener, listen, pathway, pathway_group, peer |
| eccluster_listener (scope) – Control communication between cluster nodes (cluster-specific) | na | 3.0.15 | global | |
| ecstream_listener (scope) – The listener for incoming ECSTREAM connections | receiving | 3.0 | global | |
| esmtp_listener (scope) – The listener for incoming SMTP connections | receiving | 3.0 | global | |
| http_listener (scope) – The listener used with the REST injector | sending | 3.1.4 | global | |
| listen (scope) – Specify the socket that a listener listens on | receiving | 3.0 | control_listener, ecstream_listener, esmtp_listener, http_listener, msgcserver_listener, xmpp_listener | |
| listen_backlog – The listen backlog | receiving | 500 (3.0) | 3.0 | control_listener, eccluster_listener, ecstream_listener, esmtp_listener, http_listener, listen, xmpp_listener |
| listener_sessions – Specifies the maximum number of concurrent sessions that can be established to a listener | receiving | 0 | 3.0 | esmtp_listener, listen, pathway, pathway_group, peer |
| max_request_size – Limit the size of an HTTP request | both | 3.1.4 | http_listener, listen, pathway, pathway_group, peer | |
| mcmt_reception – Configure a listener to accept the Multi-Channel Message Type (Mobile Momentum) | both | passthru | 3.1.4 | esmtp_listener, listen, pathway, pathway_group, peer |
| timeout – The timeout for idle control connections on Control_Listeners | receiving | 60 | 3.0 | control_listener |
| tls_verified_peer_is_authorized – Mark requests that use a verified SSL Client certificate as being authorized | sending | false | 3.1.4 | http_listener, listen, pathway, peer |
This section displays all options of the specified type sorted alphabetically.
| Option/Description | Type | Default | Version | Scopes |
|---|---|---|---|---|
| critical – Set the debug level | na | ALL | 3.0 | debug_flags |
| debug – Set the debug level | na | 3.0 | debug_flags | |
| debug_flags (scope) – Configure debug verbosity | na | 3.0 | global | |
| error – Set the debug level | na | ALL | 3.0 | debug_flags |
| info – Set the debug level | na | 3.0 | debug_flags | |
| log_requests_to_paniclog – Whether to log REST injection requests | sending | false | 3.1.4 | http_listener, listen, pathway, pathway_group, peer |
| notice – Set the debug level | na | 3.0 | debug_flags | |
| response_transcode_pattern – The regex pattern for comparison to a server response | sending | 3.0 | binding, binding_group, domain, global | |
| response_transcode_replace – The replacement string for a server response | sending | 3.0 | binding, binding_group, domain, global | |
| signing_stats – Control how signing statistics are recorded | sending | all | 3.0.17 | global |
| timestampformat – Set the timestamp format used when logging to stderr | na | [%a %d %b %Y %H:%M:%S] | 3.0 | global |
| warning – Set the debug level | na | 3.0 | debug_flags |
This section displays all options of the specified type sorted alphabetically.
| Option/Description | Type | Default | Version | Scopes |
|---|---|---|---|---|
| default_charset – Control the character set | both | us-ascii | 3.0 | global, pathway, pathway_group |
| delayed_queue_scan_interval – How often to call the maintainer for a domain | sending | 15 | 3.0 | global |
| disable_nagle_algorithm – Disable nagle algorithm on sockets | both | false | 3.0 | control_listener, eccluster_listener, ecstream_listener, esmtp_listener, global, http_listener, listen, xmpp_listener |
| enable – Enable or disable a listener scope | receiving | true | 3.0 | control_listener, eccluster_listener, ecstream_listener, esmtp_listener, http_listener, listen, msgcserver_listener, xmpp_listener |
| events_per_iter – Employ when using a Concurrency greater than 1 | receiving | 0 | 3.0 | control_listener, eccluster_listener, ecstream_listener, esmtp_listener, http_listener, listen, xmpp_listener |
| file_mode – File access rights in octal notation | na | 0660 | 3.0 | control_listener, eccluster_listener, ecstream_listener, esmtp_listener, http_listener, listen, msgcserver_listener, xmpp_listener |
| license – Specify an alternate license location | na | /opt/msys/ecelerity/etc (non-dynamic) | 3.0 | global |
| local_changes_file – The file for writing local configuration changes | na | /opt/msys/ecelerity/etc/local_changes.conf | 3.0 | global |
| local_changes_only – Whether there is a file for writing local configuration change | na | false | 3.0 | global |
| permastore_interval – The frequency for saving various statistics | na | 300 | 3.0 | global |
| pidfile – Set the PID file path | na | /var/run/ecelerity.pid (non-dynamic) | 3.0 | global |
| reconfig_message – The message if the configuration has changed | receiving | 4.3.2 Reconfiguration in progress | 3.0 | esmtp_listener |
| reserve_maintenance_interval – How often to perform mail queue maintenance | sending | 15 | 3.0 | global |
| send_8bitmime – Enable advertising of 8BITMIME when sending mail | sending | no | 3.0 | binding, binding_group, domain, global |
| smtp_extensions – Array of SMTP extensions | receiving | 3.0 | esmtp_listener, listen, pathway, pathway_group, peer | |
| tcp_recv_buffer_size – The size of the TCP receive buffer size | receiving | 4096 | 3.0 | control_listener, eccluster_listener, ecstream_listener, esmtp_listener, http_listener, listen, xmpp_listener |
| tcp_send_buffer_size – The size of the TCP send buffer | receiving | 4096 | 3.0 | control_listener, eccluster_listener, ecstream_listener, esmtp_listener, http_listener, listen, xmpp_listener |
| transform_8bitmime_content – Enable 8BITMIME downconversion when sending mail | sending | ifneeded (3.1.6) | 3.0 | binding, binding_group, domain, global |
| unlink_on_spool_in_failure – Whether or not to remove malformed messages | receiving | true | 3.0 | global |
| watchdog_interval (deprecated) – If Momentum is unresponsive for this length of time, it will be restarted | na | 60 | 3.0 | global |
| xclient – Use the XCLIENT extension to SMTP for outbound mail | sending | no | 3.0 | binding, binding_group, domain, global |
This section displays all options of the specified type sorted alphabetically.
| Option/Description | Type | Default | Version | Scopes |
|---|---|---|---|---|
| dkim – Enable or disable signing messages | sending | 3.0 | binding, binding_group, domain, global | |
| domainkeys – Enable or disable domainkeys signing | sending | 3.0 | binding, binding_group, domain, global | |
| enable_fbl_header_insertion – Enable or disable fbl header insertion | sending | 3.0 | binding, binding_group, domain, global | |
| opendkim_sign – Whether or not to enable OpenDKIM signing | sending | true (non-dynamic) | 3.6 | binding, binding_group, domain, global |
This section displays all options of the specified type sorted alphabetically.
| Option/Description | Type | Default | Version | Scopes |
|---|---|---|---|---|
| delivery_pool – Associate an eventloop with mail delivery | sending | (non-dynamic) | 3.6 | global |
| event_loop – Associate a listener with an eventloop | sending | (non-dynamic) | 3.6 | ecstream_listener, esmtp_listener, listen |
| eventloop (scope) – Define a pool of event loops to enable multiple event loop configuration | both | (non-dynamic) | 3.6 | global |
| maintainer_pool – Create an eventloop for maintainers | both | (non-dynamic) | 3.6 | global |
This section displays all options of the specified type sorted alphabetically.
| Option/Description | Type | Default | Version | Scopes |
|---|---|---|---|---|
| apn_expiry – Define the number of seconds after which an APNs notification is no longer valid | sending | yes (non-dynamic) | 3.5.5 | binding, binding_group, domain, global |
| gcm_application_id – Define the package name of the Android application allowed to received notifications | sending | 3.5.5 | binding, binding_group, domain, global | |
| gcm_authorization_token_id – The authorization token that permits sending Google push notifications | sending | 3.5.5 | binding, binding_group, domain, global | |
| gcm_delay_while_idle – Whether or not to send the notification immediately if a device is idle | sending | false | 3.5.5 | binding, binding_group, domain, global |
| gcm_dry_run – Test a request without actually sending a message | sending | false | 3.5.5 | binding, binding_group, domain, global |
| gcm_ttl – Default Time To Live for notifications | sending | -1 | 3.5.5 | binding, binding_group, domain, global |
This section displays all options of the specified type sorted alphabetically.
| Option/Description | Type | Default | Version | Scopes |
|---|---|---|---|---|
| _unsafe_spool – Allow dangerous spool semantics to be used | na | false | 3.0 | global |
| address_metrics_cleanse_interval – The interval for refreshing address metrics | sending | 3600 | 3.0 | global |
| address_metrics_lifetime – The TTL of address metrics | sending | 1800 | 3.0 | global |
| backlog – The maximum number of jobs that can be queued up for a pool | na | 0 (non-dynamic) | 3.0 | threadpool |
| clear_mail_queue_maintainers – Reschedule the mail queue maintainer | both | false, true (3.6) | 3.0 | global |
| concurrency – Define number of available threads | receiving | 0 | 3.0 | control_listener, eccluster_listener, ecstream_listener, esmtp_listener, http_listener, listen, threadpool, xmpp_listener |
| crypto_engine – Enable hardware cryptography acceleration | both | 3.0 | global | |
| delayed_binding_domain_fuzz – The time period to spread scheduled messages over when a bulk requeue is necessary | sending | 0 | 3.0.26 | binding, binding_group, global |
| disk_queue_drain_rate – Control the rate at which messages are spooled in on start-up | both | 100 | 3.0 | global |
| dns_cache_purge_interval – How often the DNS response cache is scanned for stale entries | sending | 60 | 3.0 | global |
| drop_body_after_trans_fail – Number of retry attempts before freeing message memory | sending | 3 | 3.0 | binding, binding_group, domain, global |
| exclude_vctx_conn – Exclude validation connection context keys from being journaled in the spool metadata | both | 3.0 | binding, binding_group, domain, global | |
| exclude_vctx_mess – Exclude validation message context keys from being journaled in the spool metadata | both | 3.0 | binding, binding_group, domain, global | |
| expensive_batch_assessment – Treat messages as equal even if the bodies or headers have been modified since reception | receiving | false | 3.0 | global |
| force_fsync – Ensure that data is synced to disk on reception | receiving | false | 3.0 | global |
| growbuf_size – The size of an element in a growbuf chain | na | 16384 | 3.0 | global |
| initial_hash_buckets – Set the number of hash buckets used by the system | na | 32 | 3.1 | global |
| keep_message_dicts_in_memory – Preserve memory representation of metadata when memory is low | both | false (non-dynamic) | 3.0 | global |
| large_message_threshold – Consider a message large when its size exceeds this amount | both | 131072 | 3.0 | global |
| legacy_message_threshold – The maximum size allowed for messages being passed to legacy modules | both | 1048576 | 3.0 | global |
| mail_queue_check_vm_interval – How often to apply memory management reduction on mail queues | both | 60 | 3.0 | global |
| malloc2mmap_threshold – Use mmap when allocations exceed this amount | na | 4092 | 3.0 | global |
| masterdb_file – Specify an alternate path for the statistics permastore | na | /var/log/ecelerity/ecdb (non-dynamic) | 3.0 | global |
| match_cache_life – Set the maximum number of seconds that the match cache will be valid | na | 0 | 3.0 | global |
| match_cache_size – The size of the cache that holds the results of looking up matching scopes | na | 16384 | 3.0 | global |
| max_message_size – The maximum number of bytes allowed in a single message | receiving | 0 | 3.0 | esmtp_listener, listen, pathway, pathway_group, peer |
| max_resident_active_queue – Threshold above which messages are not held in memory | sending | 250 | 3.0 | binding, binding_group, domain, global |
| max_resident_messages – Threshold above which messages are not held in memory | sending | 32768 | 3.0 | binding, binding_group, global |
| max_resident_transfails – If the transient failure queue grows beyond this size, messages are swapped out of memory | sending | 100 | 3.0 | global |
| max_timed_events_per_iter – The maximum numer of timed events per scheduler iteration | na | 1024 | 3.0.22 | global |
| memory_goal – Configure physical memory usage goal | na | 90 | 3.0 | global |
| memory_hwm – Configure physical memory usage high-water mark | na | 95 | 3.0 | global |
| migrate_connections_between_sibling_domains – Optimize connections for sibling domains | both | true | 3.4 | global |
| mime_parse_large_messages_during_reception – Configure whether large messages are parsed upon reception or just in time | receiving | true | 3.0 | global |
| pcre_cache_size – Set the maximum size of the ec_pcre_compile cache | na | 100 | 3.0 | global |
| pcre_cache_ttl – Set the maximum TTL for the ec_pcre_compile cache | na | 300 | 3.0 | global |
| pool_name – Associate a threadpool with a listener | receiving | 3.0 | control_listener, eccluster_listener, ecstream_listener, esmtp_listener, http_listener, listen, xmpp_listener | |
| scheduler – Override the default IO scheduler | na | (non-dynamic) | 3.0 | global |
| spool_mode – Set the file mode for newly created spool files | na | 0640 (non-dynamic) | 3.0 | global |
| spoolbase – Set the base directory for the spool | na | /var/spool/ecelerity (non-dynamic) | 3.0 | global |
| stack_size – The stack space for a threadpool | na | 0 (non-dynamic) | 3.0 | threadpool |
| tcp_buffer_size – Maximum tcp buffer size for outbound connections | sending | 32768 | 3.0 | cluster, global |
| threadpool (scope) – Configure thread pool specific options | na | 3.0 | global | |
| trace_smtp_mode – Set the default permissions of trace files | sending | 0640 (non-dynamic) | 3.0 | global |
| use_iflist_cache – Whether or not to cache the list of interfaces configured by the system | sending | 0 (non-dynamic) | 3.0 | global |
| use_mmap – Use mmap when spooling messages from disk | na | false | 3.0 | global |
| use_sendfile – Use sendfile() when sending mail | sending | false | 3.0 | global |
This section displays all options of the specified type sorted alphabetically.
| Option/Description | Type | Default | Version | Scopes |
|---|---|---|---|---|
| allow_null_envelope_sender – Allow the null envelope sender in email addresses | receiving | true | 3.0 | esmtp_listener, global, listen, pathway, pathway_group, peer |
| allow_trailing_whitespace_in_commands – Allow trailing white space at the end of an SMTP command | receiving | false | 3.0.26 | esmtp_listener, global, listen, pathway, pathway_group, peer |
| require_ehlo – Reject mail from clients that do not say HELO | receiving | false | 3.0 | esmtp_listener, global, listen, pathway, pathway_group, peer |
| rfc2821_allow_whitespace_in_envelope – Permit trailing white space before the final CRLF | receiving | false | 3.0.26 | global, pathway, pathway_group |
| rfc2821_pedantic_address_rules – Allow relaxation of enforcement of the rfc2821 address rules | receiving | true | 3.0 | global, pathway, pathway_group |
| rfc2822_date_header – Allow relaxation of enforcement of the rfc2822 address rules | receiving | ifneeded | 3.0 | global, pathway, pathway_group |
| rfc2822_lone_lf_in_body – Allow relaxation of enforcement of the rfc2822 address rules | receiving | ignore | 3.0 | global, pathway, pathway_group |
| rfc2822_lone_lf_in_headers – Allow relaxation of enforcement of the rfc2822 address rules | receiving | pedantic | 3.0 | global, pathway, pathway_group |
| rfc2822_max_line_length – Allow relaxation of enforcement of the rfc2822 address rules | receiving | ignore | 3.0 | global, pathway, pathway_group |
| rfc2822_max_line_length_policy – Determine how non-RFC-compliant line lengths are handled | receiving | none | 3.0.26 | global, pathway, pathway_group |
| rfc2822_messageid_header – Allow relaxation of enforcement of the rfc2822 address rules | receiving | ifneeded | 3.0 | global, pathway, pathway_group |
| rfc2822_missing_headers – Allow relaxation of enforcement of the rfc2822 address rules | receiving | reject | 3.0 | global, pathway, pathway_group |
| rfc2822_trace_headers – Allow relaxation of enforcement of the rfc2822 address rules | receiving | true | 3.0 | global, pathway, pathway_group |
This section displays all options of the specified type sorted alphabetically.
| Option/Description | Type | Default | Version | Scopes |
|---|---|---|---|---|
| allow_ip_literal – Allow IP addresses in email addresses | receiving | true | 3.0 | esmtp_listener, global, listen, pathway, pathway_group, peer |
| blackhole – Blackhole mail | sending | false | 3.0 | binding, binding_group, domain, global |
| delivery_method – Set the delivery method | sending | ESMTP (3.0), SMTP (2.2) | 3.0 | binding, binding_group, domain, global |
| dns_fallback_to_tcp – Whether or not to fail over to TCP in place of UDP | both | false | 3.0.22 | global |
| domain_for_unqualified_recipient_addresses – Configure a domain which will be used to resolve delivery for unqualified addresses | receiving | 3.0 | esmtp_listener, global, listen, pathway, pathway_group, peer | |
| domain_for_unqualified_sender_address – Configure a domain which will be used to substitute for unqualified sender addresses | receiving | 3.0 | esmtp_listener, global, listen, pathway, pathway_group, peer | |
| ecstream_port – Configure the port for ecstream deliveries | sending | 1825 | 3.2 | binding, binding_group, domain, global |
| fully_resolve_before_smtp – Resolve all MX and A records before attempting delivery | sending | true | 3.0 | binding, binding_group, domain, global |
| gateway – Configure a static SMTP route for mail | sending | 3.0 | binding, binding_group, domain, global | |
| lmtp_port – Configure the port for LMTP deliveries | sending | 2003 | 3.0 | binding, binding_group, domain, global |
| only_use_best_mx_for_relay_domains – If this is set to true only the lowest numerical priority MXs are used | sending | true | 3.0 | global |
| open_relay – Whether the MTA is an open relay or not | receiving | false | 3.0 | esmtp_listener, listen, pathway, pathway_group, peer |
| prohibited_hosts – Prevent mail from being delivered to invalid destinations | sending | 3.0 | global | |
| relay_domains – Configure the list of domains for which Momentum relays mail | receiving | 3.0 | global, pathway, pathway_group | |
| relay_for_sending_domains – Domains that may use the MTA as a relay | receiving | 3.0 | esmtp_listener, listen, pathway, pathway_group, peer | |
| relay_hosts – Configure the list of hosts for which Momentum relays mail | receiving | 3.0 | esmtp_listener, global, listen, pathway, pathway_group, peer | |
| remote_smtp_port – Set the port to be used for SMTP deliveries | sending | 25 | 3.0 | binding, binding_group, domain, global |
| resolv_conf – Specify a custom resolv.conf file | sending | 3.0 | global | |
| routes – Configure message routing | sending | 3.0 | domain, global | |
| use_ipv6 – Affects the selection of IPv6 hosts in the SMTP client | sending | false | 3.0 | global |
This section displays all options of the specified type sorted alphabetically.
| Option/Description | Type | Default | Version | Scopes |
|---|---|---|---|---|
| always_allow – When set to true, authentication is considered to have succeeded, unless always_deny is set | receiving | false | 3.0 | control_listener, esmtp_listener, http_listener, listen, pathway, pathway_group, peer |
| always_deny – If set to true, authentication is considered to have failed | receiving | false | 3.0 | control_listener, esmtp_listener, http_listener, listen, pathway, pathway_group, peer |
| authcrammd5parameters – Configure CRAM-MD5 authentication | receiving | 3.0 | control_listener, esmtp_listener, listen, pathway, pathway_group | |
| authdigestmd5parameters – Configure DIGEST-MD5 authentication | receiving | 3.0 | control_listener, esmtp_listener, http_listener, listen, pathway, pathway_group, peer, xmpp_listener | |
| authloginparameters – Configure clear text login authentication | receiving | 3.0 | control_listener, esmtp_listener, listen, pathway, pathway_group | |
| authorization (scope) – Configure the console commands applicable to users | na | 3.0 | global | |
| authorizationparameters – AuthorizationParameters dictionary points to authorization information | receiving | 3.0 | control_listener, esmtp_listener, listen | |
| authplainparameters – Configure plain text login authentication | receiving | 3.0 | esmtp_listener, http_listener, listen, pathway, pathway_group, xmpp_listener | |
| capabilities – Selectively retain root capabilities | na | (non-dynamic) | 3.0 | security |
| chroot – chroot to a secure environment | na | (non-dynamic) | 3.0 | security |
| enable_authentication – Whether or not to enable authentication | receiving | 3.0 | control_listener, esmtp_listener, http_listener, listen, pathway, pathway_group, peer | |
| enable_authorization – Whether or not to enable authorization for console commands | receiving | 3.0 | control_listener, listen, peer | |
| group – Group identity to assume after startup | na | ecuser (non-dynamic) | 3.0 | security |
| peer (scope) – Create an ACL within a specific listener | receiving | 3.0 | control_listener, ecstream_listener, esmtp_listener, http_listener, listen, xmpp_listener | |
| privileges – Selectively retain root capabilities (Solaris) | na | (non-dynamic) | 3.0 | security |
| role (scope) – Define a role within an authorization stanza | na | 3.0 | authorization | |
| security (scope) – Scope for defining which permissions are retained by which user | na | (non-dynamic) | 3.0 | global |
| supplemental_groups – Supplemental groups to assume after startup | na | (non-dynamic) | 3.0 | security |
| use_ssl – Whether to use SSL verification | receiving | false | 3.0 | ecstream_listener, esmtp_listener, http_listener, listen, pathway, pathway_group, peer |
| user – User identity to assume after startup | na | ecuser (non-dynamic) | 3.0 | security |
This section displays all options of the specified type sorted alphabetically.
| Option/Description | Type | Default | Version | Scopes |
|---|---|---|---|---|
| cluster_max_outbound_connections – Set the maximum number of outbound connections for a domain (cluster-specific) | sending | -1 | 3.0 | binding, domain, global, host |
| cluster_outbound_throttle_connections – Limit the rate at which connections are established (cluster-specific) | sending | 3.0 | binding_group, domain, global | |
| cluster_outbound_throttle_messages – Limit the rate at which messages are delivered (cluster-specific) | sending | 3.0 | binding_group, domain, global | |
| cluster_scope_max_outbound_connections – Provide traffic shaping for outbound connections (cluster-specific) | sending | 3.0.16 | binding, binding_group, domain, global, host | |
| cluster_server_max_outbound_connections – Set the maximum number of outbound connections (cluster-specific) | sending | 3.0 | binding, binding_group, global | |
| connection_allocation_aggressiveness – Tune the aggressiveness for establishing new connections to domains | sending | normal | 3.0 | binding, binding_group, domain, global |
| ecstream_max_batch_size – The maximum number of ECStream messages to accept before dropping back into the scheduler (ECStream only) | receiving | 10000 | 3.0 | ecstream_listener, listen, pathway, pathway_group, peer |
| inbound_throttle_messages – Rate limit inbound mail | receiving | 3.0 | global, pathway, pathway_group | |
| max_deliveries_per_connection – Maximum number of messages to deliver before closing a connection | sending | 0 | 3.0 | binding, binding_group, domain, global |
| max_outbound_connections – Set the maximum number of outbound connections | sending | 32 | 3.0 | binding, binding_group, domain, global, host |
| max_receptions_per_connection – The maximum number of messages allowed in a single session | receiving | 0 | 3.0 | esmtp_listener, global, listen, pathway, pathway_group, peer |
| max_recipients_per_batch – The maximum number of recipients to send in a single outbound message transaction | sending | 100 | 3.0 | binding, binding_group, domain, global |
| max_recipients_per_connection – The maximum number of recipients to send on a connection | sending | 0 | 3.0 | binding, binding_group, domain, esmtp_listener, global, listen, peer |
| max_recipients_per_message – The maximum number of recipients allowed in a message | receiving | 0 | 3.0 | esmtp_listener, listen, pathway, pathway_group, peer |
| max_retries – Override the system configured max_retries | sending | 3.0 | binding, binding_group, domain, global | |
| max_retry_interval – Maximum retry interval | sending | 43200 | 3.0 | binding, binding_group, domain, global |
| never_attempt_expired_messages – Never attempt delivery of expired messages | sending | false | 3.0 | binding, binding_group, domain, global |
| outbound_throttle_connections – Limit the rate at which connections are established | sending | 3.0 | binding, binding_group, domain, global | |
| outbound_throttle_messages – Limit the rate at which messages are delivered | sending | 3.0 | binding, binding_group, domain, global | |
| scope_max_outbound_connections – Provide traffic shaping for outbound connections | sending | 3.2 | binding, binding_group, domain, global | |
| server_max_file_descriptors – Sets the maximum number of file descriptors usable by the system | na | 3000000 | 3.0 | global |
| server_max_outbound_connections – Sets the maximum number of outbound connections | sending | 20000 | 3.0 | binding, binding_group, global |
| server_reserve_outbound_connections – Sets the server-wide connection limit reserve | sending | 200 | 3.0 | global |
| service_sessions – The maximum number of concurrent sessions that can be established to all listeners | receiving | 0 | 3.0 | esmtp_listener, listen, pathway, pathway_group, peer |
| siv_throttle_cache_size – Set the maximum number of named throttles | both | 100, 1000 (3.0.24) | 3.0 | global |
| suspend_delivery – Prevent outbound mail delivery | sending | false | 3.0 | binding, binding_group, domain, global |
This section displays all options of the specified type sorted alphabetically.
| Option/Description | Type | Default | Version | Scopes |
|---|---|---|---|---|
| address – Set the SNMP IP address and port | na | (non-dynamic) | 3.0 | snmp |
| community – Set the SNMP Community option value to the desired SNMP community the agent is to join | na | public (non-dynamic) | 3.0 | snmp |
| snmp (scope) – Simple Network Management Protocol Support scope options | na | (non-dynamic) | 3.0 | global |
| snmp_traps (scope) – Enable and configure generation of SNMP traps | na | (non-dynamic) | 3.0 | global |
| state – Whether to enable the SNMP agent | na | 1 (non-dynamic) | 3.0 | snmp |
| state – Whether to enable generation of SNMP traps | na | 0 (non-dynamic) | 3.0 | snmp_traps |
| syscontact – Set the SNMP SysContact option value | na | (non-dynamic) | 3.0 | snmp |
| sysdescription – Set the SNMP SysDescription option value | na | (non-dynamic) | 3.0 | snmp |
| syslocation – Set the SNMP SysLocation option value | na | (non-dynamic) | 3.0 | snmp |
| trap_destination – Destination for SNMP trap | na | (non-dynamic) | 3.0 | snmp_traps |
| trap_interval – Frequency of SNMP trap generation | na | 60 (non-dynamic) | 3.0 | snmp_traps |
| watch_interval – Interval for watched system variables for SNMP traps | na | 10 (non-dynamic) | 3.0 | snmp_traps |
| watch_variables – SNMP traps watch variables | na | (non-dynamic) | 3.0 | snmp_traps |
This section displays all options of the specified type sorted alphabetically.
| Option/Description | Type | Default | Version | Scopes |
|---|---|---|---|---|
| body_timeout – Network timeout once the DATA phase is complete | sending | 600 | 3.0 | binding, binding_group, domain, global |
| connect_timeout – Set the connection timeout | sending | 300 | 3.0 | binding, binding_group, domain, global |
| connect_timeout_to_delay – Time interval before moving mail into the delayed queue | sending | 900 | 3.0 | binding, binding_group, domain, global |
| control_client_timeout – Network timeout for Momentum control client connections | na | 60 | 3.0 | global |
| delay_dsn_max_retry_interval – Maximum interval for sending DSNs to the sender of a message that has not yet been delivered | sending | 43200 | 3.0 | binding, binding_group, domain, global |
| delay_dsn_retry_interval – Base interval for sending DSNs to the sender of a message that has not yet been delivered | sending | 3600 | 3.0 | binding, binding_group, domain, global |
| dns_expire_interval – How often to check for domains with expired DNS information | sending | 10 | 3.0 | global |
| dns_failures_to_purge – Configure the maximum number of DNS lookups | sending | 10 | 3.0 | domain, global |
| ecstream_idle_time – The number of seconds of inactivity before a client is disconnected (ECStream only) | receiving | 300 | 3.0 | ecstream_listener, listen, pathway, pathway_group, peer |
| ecstream_timeout – The amount of time to wait for an ecstream connection to be established | sending | 600 | 3.2 | binding, binding_group, domain, global |
| ehlo_timeout – Network timeout for EHLO | sending | 300 | 3.0 | binding, binding_group, domain, global |
| host_failure_retry – Time to wait before attempting a retry | sending | 120 | 3.0 | domain, global |
| idle_time – The number of seconds of inactivity before a client is disconnected | receiving | 0 | 3.0 | esmtp_listener, http_listener, listen, pathway, pathway_group, peer, xmpp_listener |
| idle_timeout – Time to maintain idle outbound connections | sending | 5 | 3.0 | binding, binding_group, domain, global |
| mailfrom_timeout – Timeout after MAIL FROM | sending | 300 | 3.0 | binding, binding_group, domain, global |
| max_dns_ttl – Set the maximum DNS TTL | sending | 4294967295 | 3.0 | global |
| message_expiration – Time to live for messages | sending | 86400 | 3.0 | binding, binding_group, domain, global |
| min_dns_ttl – Override DNS TTLs smaller than this value | sending | 0 | 3.0 | global |
| mx_failures_fallback_to_a – Configure the maximum number of times an MX lookup will be attempted | sending | 3 | 3.0 | domain, global |
| mx_failures_to_delay – Number of consecutive failures before a domain is auto-delayed | sending | 50 | 3.0 | domain, global |
| rcptto_timeout – Timeout after RCPT TO | sending | 300 | 3.0 | binding, binding_group, domain, global |
| retry_interval – Base retry interval | sending | 1200 | 3.0 | binding, binding_group, domain, global |
| rset_timeout – Set the timeout after RSET | sending | 30 | 3.0 | binding, binding_group, domain, global |
This section displays all options of the specified type sorted alphabetically.
| Option/Description | Type | Default | Version | Scopes |
|---|---|---|---|---|
| crypto_lock_method – Change the locking method used by the TLS layer | both | EC_SSL_DEFAULTLOCK (non-dynamic) | 3.0 | global |
| ssl_lock_method – The SSL lock method | na | mutex (3.0.17) (non-dynamic) | 3.0 | global |
| starttls_injection_policy – Protect against SMTP injections prior to TLS | receiving | reject | 3.3 | esmtp_listener, listen, pathway, pathway_group, peer |
| tls – Determine whether to use a TLS connection for outbound mail | sending | no | 3.0 | binding, binding_group, domain, global |
| tls_allow_renegotiation – Whether to enable OpenSSL TLS renegotiation | both | true | 3.5.4 | ecstream_listener, esmtp_listener, http_listener, listen, listen, pathway, pathway_group, peer, xmpp_listener |
| tls_ca – Certificate authority for outbound mail | sending | 3.0 | binding, binding_group, domain, global | |
| tls_certificate – Certificate to use for inbound and outbound mail | both | 3.0 | binding, binding_group, domain, ecstream_listener, esmtp_listener, global, http_listener, listen, pathway, pathway_group, peer, xmpp_listener | |
| tls_ciphers – Allowable ciphers for a TLS session | both | 3.0 | binding, binding_group, domain, ecstream_listener, esmtp_listener, global, http_listener, listen, pathway, pathway_group, peer, xmpp_listener | |
| tls_client_ca – Certificate authority for inbound mail | receiving | 3.0 | ecstream_listener, esmtp_listener, global, http_listener, listen, pathway, pathway_group, peer, xmpp_listener | |
| tls_dhparams_file – Specifies DHE parameters that add per-session randomness to the encryption | both | 3.6.6 | global | |
| tls_enable_dhe_ciphers – Controls whether or not DHE ciphers are available | both | true | 3.6.6 | global |
| tls_ifavailable_fallback – Determine the behavior if TLS negotiation fails | sending | true | 3.5.10, 3.6.4 | binding, binding_group, domain, global |
| tls_key – the TLS key to use for outbound mail or inbound mail | both | 3.0 | binding, binding_group, domain, ecstream_listener, esmtp_listener, global, http_listener, listen, pathway, pathway_group, peer, xmpp_listener | |
| tls_protocols – Allowable ciphers for TLS inbound and outbound sessions | both | 3.6.6 | binding, binding_group, domain, ecstream_listener, esmtp_listener, global, http_listener, listen, pathway, pathway_group, peer | |
| tls_verified_peer_can_relay – Verification that peer can relay | receiving | false | 3.0 | ecstream_listener, esmtp_listener, listen, pathway, pathway_group, peer |
| tls_verify – Specify how to handle the remote certificates | sending | no | 3.0 | binding, binding_group, domain, global |
| tls_verify_mode – Determine whether a TLS certificates is required | receiving | 3.0 | ecstream_listener, esmtp_listener, http_listener, listen, pathway, pathway_group, peer, xmpp_listener |
This section displays all options of the specified type sorted alphabetically.
| Option/Description | Type | Default | Version | Scopes |
|---|---|---|---|---|
| alias_schemes – Enable named alias expansion schemes | both | 3.0 | domain, global, pathway, pathway_group | |
| banner_hostname – Specifies the banner hostname that will be displayed to the remote client upon connecting | receiving | 3.0 | esmtp_listener, listen, pathway, pathway_group, peer | |
| bind_address – Source address for outbound connections | sending | 3.0 | binding, binding_group, global | |
| binding (scope) – Configure binding-specific options | sending | 3.0 | binding_group, global | |
| binding_group (scope) – Logically group a set of bindings | sending | 3.0 | global | |
| cluster_group – The DuraVIP™ system coordinates IP ownership responsibilities via the cluster_group extended virtual synchrony group (cluster-specific) | na | ec_cluster | 3.0 | cluster |
| default_binding – Control the default binding | sending | normal | 3.0 | global |
| domain (scope) – Configure domain-specific options | sending | 3.0 | binding, binding_group, global | |
| duravip_follow – Specify the binding a listener should follow (cluster-specific) | receiving | 3.0 | listen | |
| duravip_preference – Specify a DuraVIP™ preference (cluster-specific) | both | 3.0 | binding, listen | |
| ehlo_hostname – Set the hostname used for EHLO in outbound mail | sending | hostname | 3.0 | binding, binding_group, domain, global |
| enable_duravip – Whether to enable Durable MultiVIP© bindings (cluster-specific) | both | 3.0 | binding, listen | |
| host (scope) – Configure host-specific options | sending | 3.0 | binding, binding_group, global | |
| hostname – Override the system configured hostname | both | 3.0 | global | |
| pathway (scope) – A grouping of inbound configuration options | receiving | 3.0.23 | global, pathway_group | |
| pathway – A means for associating a Listener with a pathway scope | receiving | 3.0.23 | ecstream_listener, esmtp_listener, listen, peer | |
| pathway_group (scope) – A container for pathway scopes | receiving | 3.0.23 | global | |
| received_hostname – The hostname that is placed in the received headers | receiving | 3.0 | esmtp_listener, listen, pathway, pathway_group, peer | |
| static_banner – The banner that is displayed to the remote client | receiving | 3.0 | esmtp_listener, listen, pathway, pathway_group, peer |
This section displays all options of the specified type sorted alphabetically.
| Option/Description | Type | Default | Version | Scopes |
|---|---|---|---|---|
| xmpp_dialback_secret – Use when verifying the XMPP server dialback key (Mobile Momentum) | both | 3.4 | domain | |
| xmpp_listener (scope) – The listener for incoming XMPP connections (Mobile Momentum) | receiving | 3.4 | global | |
| xmpp_role – Define whether a domain is an XMPP server or client (Mobile Momentum) | both | 3.4 | domain |
Was this page helpful?