MTA options listed by functional group
From Messaging Server Technical Reference Wiki
Table of MTA options, listed by functional group, shown below, lists the available MTA options, grouped by functionality. A brief description of each option is included, though more details can be found in the discussions of each individual MTA option, and in the discussions of functional groups of MTA options. See also Table of MTA options, listed alphabetically, which lists the MTA options alphabetically.
Options that fall into more than one category (as is frequently the case) are listed under each of the groups, except for the LDAP attribute name (schema) options which, due to their extensive number, are listed only in the LDAP attribute name (schema) options section of the table.
| Option | Usage |
|---|---|
| enable | Enable operation of the MTA |
| Alias and address MTA options | |
| alias_case | RESTRICTED: Control the case sensitivity of aliases |
| alias_domains | Control the format of alias file, alias option, and alias database probes |
| alias_magic | RESTRICTED: Control the order in which alias lookups are performed |
| alternate_recipient | (New in MS 8.0.1) Specify the comment string used to add an alternate recipient for an address. |
| alternate_recipient_mode | (New in MS 8.0.1) Control handling of multiple alternate recipients. |
| ap_debug | Internal MTA debugging option: enable debugging of low level address parsing; support for this option is RESTRICTED |
| delimiter_char | (New in MS 7.0) RESTRICTED: ASCII position of delimiter character |
| exproute_forward | Control whether the exproute channel option affects forward pointing headers |
| idn_config_file | (New in MS 8.0.2) Specify the location of an optional IDNKIT configuration file |
| improute_forward | Control the effect of the improute channel option on forward pointing headers |
| local_format_restrictions | Restrict use of the vertical bar (pipe) character, |, in local mailboxes (usernames), and restrict delivery to local files (use of the +filename syntax) |
| max_alias_levels | Set the level of alias nesting allowed |
| missing_recipient_group_text | Phrase to use when generating an empty group construct |
| missing_recipient_policy | Legalize messages that lack any recipient headers |
| name_table_name | OpenVMS only: Name of a logical name table storing aliases |
| reverse_envelope | Control application of address reversal to envelope addresses |
| subaddress_char | Specify the character used in addresses to separate the username (mailbox) from the subaddress or foldername |
| token_char | Specify token character in local-part of address for SRS purposes |
| use_alias_database | Control use of the alias database |
| use_domain_database | Control use of the domain database |
| use_forward_database | Control use of the forward database |
| use_personal_aliases | Control use of personal alias databases |
| use_reverse_database | Control use and format of the REVERSE mapping table and reverse database |
| user_case | Lower case postmaster; other usernames with localbehavior channel option |
| Autoresponse periodicity MTA options | |
| autoreply_timeout_default | Specify a default duration between successive vacation responses to the same sender |
| notify_maximum_timeout | (New in MS 7.0.5) Specify the maximum timeout permitted between successive Sieve notify or enotify actions |
| notify_minimum_timeout | (New in MS 7.0.5) Specify the minimum timeout permitted between successive Sieve notify or enotify actions |
| notify_timeout_default | (New in MS 7.0.5) Specify the default timeout permitted between successive Sieve notify or enotify actions |
| vacation_cleanup | Average number of times between cleanups of the per-user per-response vacation files |
| vacation_cleanup | (New in MS 8.1.0.3) Specifies the hash algorithm to use for creating vacation entry names |
| vacation_maximum_timeout | (New in MS 7.0.5) Specify a maximum value permitted for Sieve " vacation" periodicity arguments |
| vacation_minimum_timeout | (New in MS 7.0.5) Specify a minimum value permitted for Sieve " vacation" periodicity arguments |
| vacation_template | URL specifying where per-user per-response vacation information is stored |
| BURL MTA options | |
| imap_password | (New in 7.0.) Set the password for the MTA to use when connecting to the IMAP server (for BURL purposes) |
| imap_username | (New in 7.0.) Set the username for the MTA to use when connecting to the IMAP server (for BURL purposes) |
| configutil override MTA options + | |
| ldap_base_dn | DELETED for MS 7.0u4; see instead ldap_user_root |
| ldap_default_domain | The domain name to recognize and interpret as the default domain name; overrides (for MTA purposes) the defaultdomain base option (legacy configuration service.defaultdomain configutil parameter) |
| ldap_domain_root | The base DN for the domain portion of the DIT; overrides the dcroot base option (legacy configuration) service.dcroot configutil parameter) |
| ldap_host | Host to which to connect for LDAP queries; overrides the ugldaphost base option (legacy configuration local.ugldaphost configutil parameter) |
| ldap_host_alias_list | Local host aliases; overrides (for MTA purposes) the ldap_host_alias_list base option (legacy configuration local.imta.hostnamealiases configutil parameter) |
| ldap_local_host | The local host name (official host name for the "l" channel); overrides (for MTA purposes) the hostname base option (legacy configuration local.hostname configutil parameter) |
| ldap_mail_aliases | The attributes in which aliases are stored; overrides the legacy configuration local.imta.mailaliases configutil parameter |
| ldap_pab_host | (New in MS 7.0) The host for PAB LDAP queries; overrides (for MTA purposes) the ldaphost PAB option (legacy configuration local.service.pab.ldaphost configutil parameter) |
| ldap_pab_max_connections | (New in MS 7.0u1) Limit on the maximum number of connections that will be made |
| ldap_pab_password | (New in MS 7.0) The password for PAB LDAP queries; overrides (for MTA purposes) the ldappasswd PAB option (legacy configuration local.service.pab.ldappasswd configutil parameter) |
| ldap_pab_port | (New in MS 7.0) The port for PAB LDAP queries; overrides the ldapport PAB option (legacy configuration local.service.pab.ldapport configutil parameter). If neither this MTA option nor the PAB option (configutil parameter) is set, then this defaults to the ldap_port value. |
| ldap_pab_username | (New in MS 7.0) The username (bind credentials) for PAB LDAP queries; overrides (for MTA purposes) the ldapbinddn PAB option (legacy configuration local.service.pab.ldapbinddn configutil parameter) |
| ldap_password | The password to use when binding for LDAP queries; overrides (for MTA purposes) the ugldapbindcred base option (legacy configuration local.ugldapbindcred configutil parameter) |
| ldap_port | Port to which to connect for LDAP queries; overrides (for MTA purposes) the ugldapport base option (legacy configuration local.ugldapport configutil parameter) |
| ldap_schematag | The tag (name) of the schema in use; overrides (for MTA purposes) the legacy configuration local.imta.schematag configutil parameter |
| ldap_username | The DN under which to bind for LDAP queries; overrides (for MTA purposes) the ugldapbinddn base option (legacy configuration local.ugldapbinddn configutil parameter) |
| ldap_user_root | The base DN for the user and group portion of the DIT; overrides (for MTA purposes) the ugldapbasedn base option (legacy configuration local.ugldapbasedn configutil parameter) |
| Conversions MTA options | |
| conversion_size | Set the number of entries allowed in the conversion file (legacy configuration) or conversions MTA option (Unified Configuration) |
| conversions | (Unified Configuration only) Conversion entries; replaces legacy configuration conversions file |
| include_conversiontag | (New in MS 6.3) Include the conversion tag value(s) in mapping table probes |
| log_conversion_tag | (New in MS 7.0.5) Include conversion tag(s) field in MTA message transaction log entries. |
| original_channel_probe | RESTRICTED: Determine the "input" channel for CONVERSIONS mapping table probes performed by the conversion channel and certain other, special, channels |
| personal_conversion_size | RESTRICTED: Maximum personal conversion entries |
| string_pool_size_0 | Set the number of miscellaneous strings (in particular including strings in conversions entries) allowed in the MTA configuration |
| string_pool_size_4 | Set the number of strings allowed for MTA personal conversion use |
| Counters MTA options | |
| circuitcheck_completed_bins | Specify the bins for the message circuit check message counters |
| enable_delay_timers | (New in MS 8.0) Enable timers measuring the total time the MTA spends waiting for responses from external components |
| log_create_counters | Automatic creation of counters shared memory section. |
| log_delay_bins | Specify the bins for delivery delay range counters |
| log_frustration_limit | How many times a process will tolerate failure to be able to update the MTA counters before giving up on updating counters |
| log_size_bins | Specify the bins for message size range counters |
| log_sndopr | Send an operator or syslog message if the MTA's logging facilities encounter a difficulty |
| log_statistics | RESTRICTED: Normal vs. "strict" counters access. |
| Database MTA options | |
| alias_case | RESTRICTED: Control the case sensitivity of aliases |
| alias_database_url | (New in MS 8.0) memcache: URL for storing alias database data |
| alias_domains | Control the format of alias file, alias option, and alias database probes |
| alias_magic | RESTRICTED: Control the order in which alias lookups are performed |
| domain_database_url | (New in MS 8.0) memcache: URL for storing domain database data |
| forward_data_size | Hash size for the forward (database) text file |
| forward_database_url | (New in MS 8.0) memcache: URL for storing forward database data |
| general_case | Controls the case sensitivity of general database lookups |
| general_data_size | Hash size for the general (database) text file |
| general_database_url | (New in MS 8.0) memcache: URL for storing general database data |
| queue_cache_mode | Tells the MTA where queue cache information is being stored |
| queue_cache_mode_3_files | (New in MS 7.4) RESTRICTED |
| reverse_data_size | Internal hash size for the reverse (database) text file |
| reverse_database_url | (New in MS 8.0) memcache: URL for storing reverse database data |
| use_alias_database | Control use of the alias database |
| use_domain_database | Control use of the domain database |
| use_forward_database | Control use of the forward database |
| use_personal_aliases | Control use of personal alias databases |
| use_reverse_database | Control use and format of the REVERSE mapping table and reverse database |
| use_text_databases | Control whether the general database, the reverse database, and the forward database are on-disk databases, or in-memory structures |
| vacation_template | URL specifying where per-user per-response vacation information is stored |
| Debug MTA options | |
| ap_debug | RESTRICTED: Internal MTA debugging option; enable debugging of low level address parsing |
| cache_debug | Output direct LDAP lookup caching statistics |
| config_debug | RESTRICTED: (New in MS 8.0.1) Enable debugging of MTA configuration loading |
| debug_flush | (New in MS 7.1) Flush certain debug output to disk. |
| dequeue_debug | Enable debugging of message dequeue operations |
| filter_debug | (New in MS 6.2) Control whether detailed (stack state) debugging of Sieve filter evaluation is output |
| log_debug | RESTRICTED: Enable debugging of MTA logging operations |
| mm_debug | Internal MTA debugging option; enable debugging of message enqueue (MM) operation |
| os_debug | RESTRICTED: Internal MTA debugging option; enable debugging of low level OS interface routines, e.g., file operations |
| return_debug | Enable debugging of MTA periodic return job operations |
| return_verify | (New in MS 7.0.5, replacing former imta_return_verify MTA Tailor option) Enable shell script logging within the MTA return job |
| tracking_debug | RESTRICTED: (New in MS 8.0) Enable debugging of the message tracking subsystem |
| LDAP bind and connect MTA options | |
| ldap_base_dn | DELETED for MS 7.0u4; see instead the ldap_user_root MTA option |
| ldap_host | Host to which to connect for LDAP queries; overrides (for MTA purposes) the local.ugldaphost configutil parameter (legacy configuration) or ugldaphost base option (Unified Configuration) |
| ldap_max_connections | The maximum number of simultaneous LDAP connections to allow |
| ldap_password | The password to use when binding for LDAP queries; overrides (for MTA purposes) the local.ugldapbindcred configutil parameter (legacy configuration) or ugldapbindcred base option (Unified Configuration) |
| ldap_port | Port to which to connect for LDAP queries; overrides (for MTA purposes) the local.ugldapport configutil parameter (legacy configuration) or ugldapport base option (Unified Configuration) |
| ldap_timeout | Timeout value for LDAP queries |
| ldap_use_async | Control use of asynchronous (vs. synchronous) LDAP lookups |
| ldap_username | The DN under which to bind for LDAP queries; overrides (for MTA purposes) the local.ugldapbinddn configutil parameter (legacy configuration) or ugldapbinddn base option (Unified Configuration) |
| max_urls | Maximum number of URLs that may be active (nesting of references) |
| Direct LDAP domain lookup MTA options | |
| domain_failure | Rewrite template to apply when an LDAP domain lookup encounters an LDAP error |
| domain_match_cache_size | Number of domain lookup ($V rewrite template) results to keep cached |
| domain_match_cache_timeout | How long to cache domain lookup ($V rewrite template) results |
| domain_match_url | URL for an extra, special lookup for domains, e.g., URL for looking up vanity domains |
| domain_uplevel | Control whether to search "upwards" in the DC tree for domain names, and whether to use a "canonical" domain name when searching for user entries |
| ldap_attr_domain1_schema2 | Specify an alternate attribute name for the attribute used to store the "primary" domain in Schema 2 |
| ldap_attr_domain2_schema2 | Specify an alternate attribute name for the attribute used to store the "secondary" domain in Schema 2 |
| ldap_attr_domain_search_filter | Attribute in the configuration template area, (see the ldap_global_config_templates MTA option) that is used to store the domain search filter template |
| ldap_basedn_filter_schema1 | (New in MS 6.3) When schema 1 is in use, specify the filter used to identify domains when performing baseDN searches |
| ldap_basedn_filter_schema2 | (New in MS 6.3) When schema 2 is in use, specify additional filter elements used to identify domains when performing baseDN searches |
| ldap_default_domain | The domain name to recognize and interpret as the default domain name; overrides (for MTA purposes) the defaultdomain base option (legacy configuration service.defaultdomain configutil parameter) |
| ldap_domain_filter_schema1 | When schema 1 is in use, specify the filter used to find domains in the DIT |
| ldap_domain_filter_schema2 | When schema 2 is in use, specify the filter used to find domains in the DIT |
| ldap_domain_known_attributes | Control whether the MTA fetches all domain attributes vs. fetches only "known" domain attributes |
| ldap_domain_root | The base DN for the domain portion of the DIT; overrides (for MTA purposes) the dcroot base option (legacy configuration) service.dcroot configutil parameter) |
| ldap_domain_timeout | New in MS 6.1-0.01. Specify the retention time for entries in the domain map cache |
| ldap_host_alias_list | Local host aliases; overrides (for MTA purposes) the local.imta.hostnamealiases configutil parameter (legacy configuration) or ldap_host_alias_list base option (Unified Configuration) |
| ldap_local_host | The local host name (official host name for the "l" channel); overrides (for MTA purposes) the local.hostname configutil parameter (legacy configuration) or hostname base option (Unified Configuration) |
| Direct LDAP usergroup lookup MTA options | |
| alias_entry_cache_negative | Whether to cache negative results (i.e., failures) of alias lookups (alias_urlN lookups) |
| alias_entry_cache_size | Number of alias lookup (alias_urlN) results to keep cached |
| alias_entry_cache_timeout | How long to cache alias lookup (alias_urlN) results |
| alias_url0 | URL for doing alias lookups |
| alias_url1 | URL for doing alias lookups |
| alias_url2 | URL for doing alias lookups |
| alias_url3 | URL for doing alias lookups |
| allow_unquoted_addrs_violate_rfc2798 | Look up addresses in LDAP with quotes stripped from the local part |
| aliasdetourhost_null_optin | (New in MS 6.2p4) Specify a value for the attribute named by the ldap_detourhost_optin MTA option (and new in MS 8.0, also the attribute named by the ldap_domain_attr_detourhostoptin) that means that the attribute should be ignored; the purpose is to allow a way of "turning off" message detouring (where the detouring is typically for purposes of spam/virus filtering) for sites and users whose provisioning facilities find it easier to set an attribute value rather than to remove an attribute entirely |
| defer_group_processing | Set a default for whether direct LDAP group (list) expansion is deferred to the reprocess channel |
| group_dn_template | LDAP URL template used for fetching attributes once a user specified via a uniqueMember attribute has been located |
| ldap_default_attr | For URLs that are supposed to return a single result, specify a single attribute to request if no attribute was specified in the original LDAP query string |
| ldap_filter_reference | (New in MS 6.2.) If parental controls are enabled for a user (see the ldap_parental_controls MTA option), then the attribute named by this ldap_filter_reference MTA option specifies the DN of the entry that contains the actual head of household filter (typically, that is, the DN of the head of household user). (The attribute within that user entry containing the filter is specified by the ldap_hoh_filter MTA option, which defaults to mailSieveRuleSource. The lookup requests both the filter, contained in the attribute named by the ldap_hoh_filter MTA option, and the owner, contained in the attribute named by the ldap_hoh_owner MTA option, which defaults to mail.) |
| ldap_group_object_classes | The object classes required for a group |
| ldap_hoh_filter | (New in MS 6.2.) Specify an attribute to request when performing a head of household filter lookup. |
| ldap_hoh_owner | (New in MS 6.2.) Attribute in which to find the owner of the HOH Sieve |
| ldap_mail_aliases | The attributes in which aliases are stored; overrides the legacy configuration local.imta.mailaliases configutil parameter |
| ldap_mail_reverses | The attributes used for the filter generated by the $Q LDAP substitution sequence; normally used during reverse_url lookups, hence normally the attributes compared against an address to be "reversed" |
| ldap_parental_controls | (New in MS 6.2) Specifies the name of a user or group LDAP attribute whose value can request "head of household" (a.k.a "parental controls") Sieve filtering be applied to this user's (or group's) messages. Any of the values Yes, 1, or true is considered to be requesting parental controls. |
| ldap_uid_invalid_chars | Characters that are not allowed in a uid or permanent identifier |
| ldap_user_object_classes | The object classes required for a user |
| ldap_user_root | The base DN for the user and group portion of the DIT; overrides (for MTA purposes) the ugldapbasedn base option (legacy configuration local.ugldapbasedn configutil parameter) |
| max_alias_levels | Set the level of alias nesting allowed |
| max_urls | Maximum number of URLs that may be active (nesting of references) |
| reverse_address_cache_size | Number of LDAP address reversal (reverse_url) results to keep cached |
| reverse_address_cache_timeout | How long to cache LDAP address reversal lookup (reverse_url) results |
| reverse_url | URL for doing address reversal |
| Direct LDAP schema MTA options | |
| ldap_attr_domain_search_filter | Attribute in the global configuration template area (see the ldap_global_config_templates MTA option) that is used to store the domain search filter template; for instance, one attribute that might be used for such a purpose (hence to which this option might be set) would be inetDomainSearchFilter. |
| ldap_basedn_filter_schema1 | (New in MS 6.3) When schema 1 is in use, specify the filter used to identify domains when performing baseDN searches |
| ldap_basedn_filter_schema2 | (New in MS 6.3) When schema 2 is in use, specify additional filter elements used to identify domains when performing baseDN searches |
| ldap_domain_filter_schema1 | When schema 1 is in use, specify the filter used to find domains in the DIT |
| ldap_domain_filter_schema2 | When schema 2 is in use, specify the filter used to find domains in the DIT |
| ldap_domain_known_attributes | Control whether the MTA fetches all domain attributes vs. fetches only "known" domain attributes |
| ldap_domain_root | The base DN for the domain portion of the DIT; overrides (for MTA purposes) the dcroot base option (legacy configuration) service.dcroot configutil parameter) |
| ldap_global_config_templates | Schema 2 support: specify the DN where global configuration templates can be found |
| group_dn_template | LDAP URL template used for fetching attributes once a user specified via a uniqueMember attribute has been located |
| ldap_group_object_classes | The object classes required for a group |
| ldap_schemalevel | The schema level in use; overrides (for MTA purposes) the ldap_schemalevel base option |
| ldap_schematag | The tag (name) of the schema in use; overrides the local.imta.schematag configutil parameter |
| ldap_user_object_classes | The object classes required for a user |
| ldap_user_root | The base DN for the user and group portion of the DIT; overrides (for MTA purposes) the ugldapbasedn base option (legacy configuration local.ugldapbasedn configutil parameter) |
| Direct LDAP attribute interpretation MTA options | |
| aliasdetourhost_null_optin | (New in MS 6.2p4) Specify a value for the attribute named by the ldap_detourhost_optin MTA option (and new in MS 8.0, also the attribute named by the ldap_domain_attr_detourhostoptin) that means that the attribute should be ignored; the purpose is to allow a way of "turning off" message detouring (where the detouring is typically for purposes of spam/virus filtering) for sites and users whose provisioning facilities find it easier to set an attribute value rather than to remove an attribute entirely |
| allow_unquoted_addrs_violate_rfc2798 | Look up addresses in LDAP with quotes stripped from the local part |
| capture_format_default | (New in MS 7.0u4) Specify the default "capture" format resulting from ldap_capture |
| delivery_options | Specify interpretation of mailDeliveryOption values |
| group_dn_template | LDAP URL template used for fetching attributes once a user specified via a uniqueMember attribute has been located |
| ldap_default_domain | The domain name to recognize and interpret as the default domain name; overrides (for MTA purposes) the defaultdomain base option (legacy configuration service.defaultdomain configutil parameter) |
| ldap_hoh_filter | (New in MS 6.2.) Specify an attribute to request when performing a head of household filter lookup. |
| ldap_hoh_owner | (New in MS 6.2.) Attribute in which to find the owner of the HOH Sieve |
| ldap_host_alias_list | Local host aliases; overrides (for MTA purposes) the local.imta.hostnamealiases configutil parameter (legacy configuration) or ldap_host_alias_list base option (Unified Configuration) |
| ldap_local_host | The local host name (official host name for the "l" channel); overrides (for MTA purposes) the local.hostname configutil parameter (legacy configuration) or hostname base option (Unified Configuration) |
| ldap_uid_invalid_chars | Characters that are not allowed in a uid or permanent identifier |
| optin_user_carryover | (New in MS 6.2.) Specify whether user spam/virus filter "optin" is considered to "carry over" for forwarded recipients |
| process_substitutions | (New in MS 6.3) Process substitution characters in the URL values of various LDAP attributes |
| route_to_routing_host | Forcibly route non-local hosts to the first value of mailRoutingHosts |
| sieve_user_carryover | Specify whether user Sieve filters "carry over" for forwarded recipients |
| spare_N_separator | (New in MS 7.0u2) Specify the handling of multiple values of the ldap_spare_N attribute for corresponding N. |
| vacation_maximum_timeout | (New in MS 7.0.5) Specify a maximum value permitted for Sieve "vacation" periodicity arguments |
| vacation_minimum_timeout | (New in 7.0.5) Specify a minimum value permitted for Sieve "vacation" periodicity arguments |
| Direct LDAP attribute name MTA options | |
| ldap_* | Specify an alternate attribute name for any of various per-user attributes; see MTA LDAP attribute name options |
| ldap_attr_domain_* | Specify an alternate attribute name for any of a few fundamental defining attributes of domains; see MTA LDAP attribute name options |
| ldap_domain_attr_* | Specify an alternate attribute name for any of various per-domain attributes; see MTA LDAP attribute name options |
| Direct LDAP attributes returned upon authentication MTA options | |
| ldap_auth_attr_hold_for | (New in MS 8.0) Specify the name of an attribute that stores authenticated hold time |
| ldap_auth_attr_mail_host | (New in MS 8.0) Specify an alternate attribute name for the attribute used to store the mailHost for BURL purposes |
| ldap_auth_attr_recall_secret | (New in MS 8.0) Specify the name of an attribute used to store the user's recall secret |
| ldap_auth_attr_sender | (New in MS 8.0) Specify an alternate attribute name for the attribute used to store the user's canonical address |
| ldap_auth_attr_submit_channel | (New in MS 8.0) Specify an alternate attribute name for the attribute used to store the authenticated submission source channel name override |
| LDAP and URL lookup caching and timeout options | |
| alias_entry_cache_negative | Whether to cache negative results (i.e., failures) of alias lookups (alias_urlN lookups) |
| alias_entry_cache_size | Number of alias lookup (alias_urlN) results to keep cached |
| alias_entry_cache_timeout | How long to cache alias lookup (alias_urlN) results |
| cache_debug | Output direct LDAP lookup caching statistics |
| domain_match_cache_size | Number of domain lookup ($V rewrite template) results to keep cached |
| domain_match_cache_timeout | How long to cache domain lookup ($V rewrite template) results |
| filter_cache_size | (New in MS 6.2.) Specify the size of the per-process cache of tokenized Sieve filters |
| filter_cache_timeout | (New in MS 6.2.) Specify the retention time for entries in the per-process cache of tokenized Sieve filters |
| ldap_domain_timeout | New in MS 6.1-0.01. Specify the retention time for entries in the domain map cache |
| ldap_timeout | Timeout value for LDAP queries |
| ldap_use_async | Control use of asynchronous (vs. synchronous) LDAP lookups |
| reverse_address_cache_size | Number of LDAP address reversal (reverse_url) results to keep cached |
| reverse_address_cache_timeout | How long to cache LDAP address reversal lookup (reverse_url) results |
| url_result_cache_case | New in MS 8.1.0.2. Controls whether URLs are treated in a case-sensitive fashion. |
| url_result_cache_size | Number of rewrite rule LDAP URL lookups and mapping table LDAP URL lookups ($]...[ lookups) to keep cached |
| url_result_cache_timeout | How long to cache results of rewrite rule LDAP URL lookups and mapping table LDAP URL lookups ($]...[ lookups) |
| Directory location MTA options | |
| langdir | (New in MS 7.0) Specify the location of the default set of language-specific files |
| tmpdir | (New in MS 7.0) Specify the location of the directory for storing temporary files |
| DKIM MTA options | |
| dkim_ignore_domains | (New in MS 7.0.5) Domains to ignore in DKIM-Signature: fields |
| dkim_preserve_domains | (New in MS 7.0.5) Domains in DKIM-Signature: fields that trigger passthrough mode |
| dkim_remove_domains | (New in MS 7.0.5) Domains in DKIM-Signature: fields triggering removal of the header |
| DNS lookup MTA options | |
| blocked_mail_from_ips | (New in MS 6.1) Specify IP address literals whose A records should be ignored for purposes of the lookups done due to the mailfromdnsverify channel option |
| return_envelope | Control use of empty return address in notification messages, and validity checks on envelope From address |
| Error text and error interpretation MTA options | |
| access_errors | Control the information issued in certain error messages |
| error_text_* | Specify alternate error text for any of various error conditions; see error_text_* MTA options |
| missing_recipient_group_text | Phrase to use when generating an empty group construct |
| spamfilterN_optional | What to do if a spam/virus filter package is not responding: temporarily reject message vs. allow to pass unfiltered, plus whether to send syslog notice |
| use_permanent_error | Control whether certain error conditions are considered to be permanent errors, or temporary errors |
| use_temporary_error | (New in MS 8.0) Control whether certain error conditions are considered to be temporary errors, or permanent errors |
| External filtering context MTA options | |
| scan_channel | (New in MS 7.0.5) Channel to consider as source channel when initializing the MTA for spam/virus filter package checks performed by non-channel applications and utilities such as imexpire |
| scan_originator | (New in MS 7.0.5) Address to consider as the MAIL FROM/envelope From address when initializing the MTA for spam/virus filter package checks performed by non-channel applications and utilities such as imexpire |
| scan_recipient | (New in MS 7.0.5) Address to consider as the RCPT TO/envelope To address when initializing the MTA for spam/virus filter package checks performed by non-channel applications and utilities such as imexpire |
| File format MTA options | |
| buffer_size | Set the buffer size used when writing files; default is 8192 |
| cache_magic | Obsolete PMDF option, controlling message file sorting |
| cbt | Obsolete PMDF option, to control the use of "contiguous best try" filesystem storage |
| comment_chars | Set the "comment" character(s) in MTA configuration files |
| debug_flush | (New in MS 7.1) Flush certain debug output to disk. |
| dequeue_map | RESTRICTED. Map files into memory when dequeuing |
| fdirectory | OpenVMS only. |
| file_member_size | Maximum number of configuration files used by the MTA |
| fsync | Do an fsync upon file close |
| log_alq | (OpenVMS only) Specify the default allocation quantity for the MTA message transaction log file |
| log_deq | (OpenVMS only) Specify the default extend quantity for the MTA message transaction log file |
| max_internal_blocks | Specify size of messages beyond which to buffer to temporary files |
| mm_mbc | (OpenVMS only) Set the RMS RAB MBC field; default is 4 |
| mm_mbf | (OpenVMS only) Set the RMS RAB MBF field; default is 16 |
| notary_quote | Specify the character that marks substitution sequences in return_*.txt files and disposition_*.txt files |
| os_debug | RESTRICTED: Internal MTA debugging option; enable debugging of low level OS interface routines, e.g., file operations |
| osync | (New in MS 7.0.5) Specify whether or not to set the O_SYNC flag when creating message queue files on disk. |
| projectid | (New in MS 7.3-11.01) Numeric id MTA uses when obtaining shared memory segments |
| queue_cache_mode | RESTRICTED: Tells the MTA where queue cache information is being stored |
| queue_cache_mode_3_files | (New in MS 7.4) RESTRICTED |
| use_text_databases | Control whether the general database, the reverse database, and the forward database are on-disk databases, or in-memory structures |
| Internal size MTA options | |
| alias_hash_size | Set the number of aliases allowed: in the alias file (legacy configuration), or via alias option (Unified Configuration) |
| alias_member_size | Set the number of alias expansions allowed: in the alias file (legacy configuration), or via alias option (Unified Configuration) |
| channel_table_size | Set the number of channels allowed in the MTA configuration |
| chunk_cache_limit | Specify the size of the cache of message body chunks |
| circuitcheck_paths_size | Number of circuit check paths (entries) to allow in the circuit check configuration file |
| conversion_size | Set the number of entries allowed in the conversion file (legacy configuration) or conversions MTA option (Unified Configuration) |
| describe_cache_limit | Control size of message part description cache for message body processing purposes |
| domain_hash_size | Set the number of rewrite rules allowed |
| file_member_size | Maximum number of configuration files used by the MTA |
| forward_data_size | Hash size for the forward (database) text file |
| fruits_size | Number of fruits allowed in the fruit validation table |
| general_data_size | Hash size for the general (database) text file |
| host_hash_size | Set the number of channel host names |
| ldap_attr_name_hash_size | Internal hash size for the list of LDAP attributes relevant to the MTA |
| ldap_object_class_hash_size | Internal hash size for the list of object classes relevant to the MTA |
| map_names_size | Set the number of mapping tables |
| options_hash_size | Hash size for the internal table of MTA options (option.dat options in legacy configuration; mta.option-name options in Unified Configuration) |
| personal_conversion_size | RESTRICTED: Maximum personal conversion entries |
| reverse_data_size | Internal hash size for the reverse (database) text file |
| string_pool_size_0 | Set the number of strings allowed for miscellaneous MTA configuration use |
| string_pool_size_1 | Set the number of strings allowed for MTA mapping table use |
| string_pool_size_2 | Set the number of strings allowed for MTA alias use |
| string_pool_size_3 | Set the number of strings allowed for MTA general (database) text file use |
| string_pool_size_4 | Set the number of strings allowed for MTA personal conversion use |
| wild_pool_size | Set the total number of wildcards allowed in mapping table patterns |
| LDAP external directory lookup MTA options | |
| ldap_ext_host | (New in MS 7.0u2) The host for LDAP EXT queries |
| ldap_ext_max_connections | (New in MS 7.0u2) Limit on the maximum number of LDAP EXT connections |
| ldap_ext_password | (New in MS 7.0u2) The password for LDAP EXT queries |
| ldap_ext_port | (New in MS 7.0u2) The port for LDAP EXT queries |
| ldap_ext_username | (New in MS 7.0u2) The username (bind credentials) for LDAP EXT queries |
| LDAP PAB lookup MTA options | |
| ldap_pab_host | (New in MS 7.0) The host for PAB LDAP queries; overrides (for MTA purposes) the ldaphost PAB option (Unified Configuration) or local.service.pab.ldaphost configutil parameter (legacy configuration) |
| ldap_pab_max_connections | (New in MS 7.0u1) Limit on the maximum number of connections that will be made |
| ldap_pab_password | (New in MS 7.0) The password for PAB LDAP queries; overrides (for MTA purposes) the ldappasswd PAB option (Unified Configuration) or local.service.pab.ldappasswd configutil parameter (legacy configuration) |
| ldap_pab_port | (New in MS 7.0) The port for PAB LDAP queries; overrides the local.service.pab.ldapport configutil parameter. If neither this option nor the configutil parameter is set, this defaults to the ldap_port value. |
| ldap_pab_username | (New in MS 7.0) The username (bind credentials) for PAB LDAP queries; overrides (for MTA purposes) the ldapbinddn PAB option (Unified Configuration) or local.service.pab.ldapbinddn configutil parameter (legacy configuration) |
| Mailing list and group MTA options | |
| alternate_recipient | (New in MS 8.0.1) Specify the comment string used to add an alternate recipient for an address. |
| alternate_recipient_mode | (New in MS 8.0.1) Control handling of multiple alternate recipients. |
| defer_group_processing | Set a default for whether direct LDAP group (list) expansion is deferred to the reprocess channel |
| digest_on | RESTRICTED. Specify the comment string that enables mailing list digests (in preference to regular mailing list postings) |
| expandable_default | Set the default for mailing lists to [NONEXPANDABLE] or in direct LDAP terms, to expandable: none or equivalently mgmanMemberVisibility: none; i.e., disable use of SMTP EXPN |
| mail_off | Specify the comment string that disables mail delivery for list addresses |
| or_clauses | Set default for whether to AND or OR multiple posting access control settings on mailing lists |
| post_off | Specify the comment string that disables list postings for a list address |
| MAILSERV MTA options | |
| ldap_mlsub_* | RESTRICTED: Names of LDAP attributes for MAILSERV user list subscription entries |
| ldap_mluser_* | RESTRICTED: Names of LDAP attributes for MAILSERV users |
| mailserv_* | RESTRICTED: MAILSERV admin user settings |
| Access mapping table MTA options | |
| access_auth | (New in MS 8.0) Control whether certain FROM_ACCESS mapping table probes include the SMTP MAIL FROM AUTH parameter's value |
| access_counts | (New in MS 6.3.) Control whether certain *_ACCESS mapping table probes include recipient count fields |
| access_errors | Control the information issued in certain error messages |
| access_orcpt | Control whether certain *_ACCESS mapping table probes include an ORCPT field |
| include_connectioninfo | (New in MS 6.2) Include transport and application connection information in various (mailing list related) mapping table probes |
| include_conversiontag | (New in MS 6.3) Include the conversion tag value(s) in mapping table probes |
| include_domain | (New in MS 8.0.2.3) Include the destination domain in various mapping table probes |
| include_mtpriority | (New in MS 8.0) Include the value of a message's MT-PRIORITY in various mapping table probes |
| include_spares1 | (New in MS 7u2, renamed from include_spares in 8.0.2.2) Include the values of the LDAP attributes named by the ldap_spare_N MTA options in FROM_ACCESS and/or recipient address access mapping table probes |
| mapping_paranoia | (New in MS 7.0) Control handling of vertical bar characters in various mapping table probes, especially *_ACCESS mapping table probes |
| use_auth_return | (New in MS 7.0) Control use of authenticated sender address in place of the envelope From address in various address matching contexts |
| use_canonical_return | (New in MS 6.3) Control address reversal of envelope From address for purposes of address matching in various contexts |
| use_ip_access | (New in MS 7.0) Control format of probes to the IP_ACCESS mapping table |
| Miscellaneous mapping table MTA options | |
| averages_cache_size | RESTRICTED: New in MS 6.2 but not yet fully implemented. Control caching of the load average data accessed from mapping table callouts. |
| averages_cache_timeout | RESTRICTED: New in MS 6.2 but not yet fully implemented. Control caching of the load average data accessed from mapping table callouts. |
| include_conversiontag | (New in MS 6.3) Include the conversion tag value(s) in mapping table probes |
| include_domain | (New in MS 8.0.2.3) Include the destination domain in various mapping table probes |
| include_mtpriority | (New in MS 8.0) Include the value of a message's MT-PRIORITY in various mapping table probes |
| include_spares2 | (New in MS 8.0) Include the values of the LDAP attributes named by the ldap_spare_N MTA options in FORWARD mapping table probes |
| message_save_copy_flags | (New in MS 6.3) Control the format of MESSAGE-SAVE-COPY mapping table probes |
| original_channel_probe | RESTRICTED: Determine the "input" channel for CONVERSIONS mapping table probes performed by the conversion channel and certain other, special, channels |
| use_comment_strings | Control the format of COMMENT_STRINGS mapping table probes |
| use_personal_names | Control the format of PERSONAL_NAMES mapping table probes |
| url_result_cache_case | New in MS 8.1.0.2. Controls whether URLs are treated in a case-sensitive fashion. |
| url_result_cache_size | Number of rewrite rule LDAP URL lookups and mapping table LDAP URL lookups ($]...[ lookups) to keep cached |
| url_result_cache_timeout | How long to cache results of rewrite rule LDAP URL lookups and mapping table LDAP URL lookups ($]...[ lookups) |
| Memcache MTA options | |
| alias_database_url | (New in MS 8.0) memcache: URL for storing alias database data |
| domain_database_url | (New in MS 8.0) memcache: URL for storing domain database data |
| enable_sieve_memcache | (New in MS 8.0) Control whether Sieve filters may use the private memcache extension |
| enable_sieve_redis | (New in MS 8.0.2.3) Control whether Sieve filters may use the private redis extension |
| forward_database_url | (New in MS 8.0) memcache: URL for storing forward database data |
| general_case | Controls the case sensitivity of general database lookups |
| general_database_url | (New in MS 8.0) memcache: URL for storing general database data |
| reverse_database_url | (New in MS 8.0) memcache: URL for storing reverse database data |
| memcache_expire | (New in MS 8.0) Time to hold idle memcached connections open |
| memcache_hash_algorithm | (New in 8.1.0.3) Hash function to apply to memcache keys |
| memcache_host | (New in MS 8.0) Host name of memcached server |
| memcache_port | (New in MS 8.0) Memcached service port |
| Message archival and hashing MTA options | |
| journal_format | (New in MS 7.0.5) Specify whether capture message copies generated in "journal" format are generated in 2003 vs. 2007 "journal" style |
| message_hash_algorithm | (New in MS 6.3) Algorithm to use for generating message hashes for message archiving |
| message_hash_fields | (New in MS 6.3) Header fields to include when generating a message hash |
| unique_id_template | (New in MS 6.3) Specify a template used to convert an address into a unique identifier, typically used in conjunction with archiving facilities |
| Message size MTA options | |
| block_limit | Limit the size of messages allowed through the MTA |
| block_size | Set the size of MTA "blocks" |
| bounce_block_limit | Limit the amount of original message content included in bounce messages |
| content_return_block_limit | Force NOTARY non-return of content flag for messages over the specified size |
| error_text_block_over | Specify error text returned in some cases of exceeding a destination channel blocklimit |
| error_text_line_over | Specify error text returned in some cases of exceeding a destination channel linelimit |
| error_text_list_block_over | Specify error text returned in some cases of exceeding a list's [BLOCKLIMIT] or mgrpMsgMaxSize value |
| error_text_list_line_over | Specify error text returned in some cases of exceeding a list's [LINELIMIT] value |
| error_text_user_block_over | Specify error text returned in some cases of exceeding a user's mailMsgMaxBlocks value or the [BLOCKLIMIT] value for an alias |
| error_text_user_line_over | Specify error text returned in some cases of exceeding a user's [LINELIMIT] value |
| header_limit | Sets a maximum size for the primary (outermost) message header |
| line_limit | Limit the size of messages allowed through the MTA |
| max_header_block_use | Fine tune message fragmentation |
| max_header_blocks | Truncate message header after the specified number of MTA blocks |
| max_header_line_use | Fine tune message fragmentation |
| max_header_lines | Truncate message header after the specified number of lines |
| max_mime_levels | Degree to look inside MIME messages during processing |
| max_mime_parts | Number of parts to look at when processing MIME messages |
| normal_block_limit | Maximum size of message to treat as being of normal or higher priority |
| non_urgent_block_limit | Maximum size of message to treat as being of non-urgent priority |
| second_class_block_limit | Maximum size of message to treat as being of second class priority |
| urgent_block_limit | Maximum size of message to treat as being of urgent priority |
| Message Store insertion logging MTA options | |
| logfile | logfile options set at the MTA level (mta.logfile.option-name in Unified Configuration) affect the MTA's logging of insertion of messages into the Message Store; that is, affect logging of message insertions performed by ims-ms and tcp_lmtpss_* channels |
| Message tracking MTA options | |
| log_times | (New in MS 8.0) Include requested deferral time in MTA message transaction log entries |
| log_tracking | (New in MS 8.0) Include tracking ID in MTA message transaction log entries |
| tracking_hash_algorithm | (New in 8.1.0.3) Select the hash algorithm the MTA uses to generate hashes of tracking and recall secrets. The default is SHA-1. |
| tracking_mode | (New in MS 8.0) Enable/disable the MTA's tracking support |
| tracking_debug | (New in MS 8.0) Level of debug output regarding tracking |
| tracking_retries | (New in MS 8.0) How many times the MTA will reattempt a tracking update |
| tracking_retry_delay | (New in MS 8.0) The time to wait between tracking update reattempts |
| MeterMaid MTA options | |
| enable_sieve_metermaid | (New in MS 8.0) Control whether Sieve filters may use the private metermaid extension |
| metermaid_backoff | (New in MS 7.2) |
| metermaid_expire | (New in MS 7.2) |
| metermaid_host | (New in MS 7.2) |
| metermaid_port | (New in MS 7.2) |
| metermaid_secret | (New in MS 7.2) |
| metermaid_timeout | (New in MS 7.2) |
| MLS MTA options | |
| error_text_mls_access_failure | (New in MS 7.0) RESTRICTED: Not yet used |
| ldap_mlsrange | (New in MS 7.0) RESTRICTED: Not yet used |
| mls | (New in MS 7.0) RESTRICTED: Not yet fully implemented |
| MTQP MTA options | |
| mtqp_expire | (New in MS 8.0) Specify the MTQP expiration, in seconds |
| mtqp_port | (New in MS 8.0) Specify the MTQP port |
| mtqp_timeout | (New in MS 8.0) Specify the MTQP timeout, in seconds |
| Notification message MTA options | |
| bounce_block_limit | Limit the amount of original message content included in bounce messages |
| content_return_block_limit | Force NOTARY non-return of content flag for messages over the specified size |
| history_to_return | Control the amount of delivery attempt history included in bounced messages |
| ldap_domain_attr_report_address | Name of domain level LDAP attribute whose value specifies a domain-specific postmaster address |
| lines_to_return | Lines included when returning samples of message content (as in warning messages) |
| notary_decode | Control whether encoded-words in the original message header are decoded when performing a %H substitution during the MTA's generation of DSNs and MDNs |
| notary_quote | Specify the character that marks substitution sequences in return_*.txt files and disposition_*.txt files |
| return_address | Set the return address for the local postmaster |
| return_debug | Enable debugging of MTA periodic return job operations |
| return_delivery_history | Control whether delivery attempt history is included in returned messages |
| return_envelope | Control use of empty return address in notification messages, and validity checks on envelope From address |
| return_personal | Set the personal name for the postmaster |
| return_units | Control the assumed units for the notices channel option, thereby controlling the interval at which certain notification messages are generated |
| return_verify | (New in MS 7.0.5, replacing former imta_return_verify MTA Tailor option) Enable shell script logging within the MTA return job |
| use_precedence | Control whether delayed delivery notification messages are sent for list and bulk precedence messages |
| use_warnings_to | DELETED as of MS 7.0.5: Whether to send DSNs to Warnings-to: address |
| Password and TLS MTA options | |
| plaintextmincipher | (New in MS 7.4-18.01; available as an MTA level option in Unified Configuration only) Disable PLAINTEXT SMTP AUTH unless SSL or TLS is active |
| smtpproxypassword | (New in MS 7.0.5) Replaces the former TCP/IP channel option file option PROXY_PASSWORD |
| sslnicknames | (New in MS 7.4-18.01; available as an MTA level option in Unified Configuration only) SSL/TLS server certificate nicknames the MTA will offer |
| Processing priority MTA options | |
| defer_group_processing | Set a default for whether direct LDAP group (list) expansion is deferred to the reprocess channel |
| log_mtpriority | (New in MS 8.0) Include message MT-PRIORITY in MTA message transaction log entries |
| log_priority | Include message priority in MTA message transaction log entries |
| mtpriority_policy | (New in MS 8.0) MT-PRIORITY policy name to announce in SMTP EHLO response |
| normal_block_limit | Maximum size of message to treat as being of normal or higher priority |
| non_urgent_block_limit | Maximum size of message to treat as being of non-urgent priority |
| second_class_block_limit | Maximum size of message to treat as being of second class priority |
| urgent_block_limit | Maximum size of message to treat as being of urgent priority |
| use_precedence | Control whether delayed delivery notification messages are sent for list and bulk precedence messages |
| Received header line MTA options | |
| held_sndopr | Send operator or syslog messages when messages are HELD |
| id_domain | Set the domain name used in constructing message IDs |
| max_local_received_lines | Occurrences of the local host name in Received: headers after which a message will be HELD |
| max_mr_received_lines | Number of MR-Received: headers after which a message will be HELD |
| max_received_lines | Number of Received: headers after which a message will be HELD |
| max_total_received_lines | Number of Received:, MR-Received: or X400-Received: headers after which a message will be HELD |
| max_x400_received_lines | Number of X400-Received: headers after which a message will be HELD |
| received_domain | Specify the domain name (identifying the system itself) to use in constructing Received: headers |
| received_version | Specify the IMTA version string to use in constructing Received: header lines; use is NOT RECOMMENDED |
| Sieve filter MTA options | |
| systemfilter | System Sieve filter, applied to all messages at each enqueue |
| sieve_body_needed | Specifies whether or not to retain decoded MIME body information when initial message analysis is performed. |
| sieve_mime_needed | Specifies whether or not to retain inner MIME structure and header information when initial message analysis is performed. |
| Sieve filter interpretation MTA options | |
| decode_encoded_words | RESTRICTED: Decode encoded words during Sieve processing |
| defer_header_addition | (New in MS 7.0.5.30.0) Control whether Sieve filters see any headers added prior to Sieve processing |
| filter_discard | Control whether messages discarded by a Sieve filter are immediately deleted, or instead routed to the filter_discard channel for delayed deletion |
| filter_jettison | New in MS 6.1. Control whether messages jettisoned by a Sieve filter are immediately deleted, or instead routed to the filter_discard channel for delayed deletion |
| notify_ignore_errors | (New in MS 7.0.5) Control whether to abort or ignore invalid recipient in Sieve notify action |
| sieve_received | (New in MS 8.0) Make synthesized Received: header line visible for Sieve filter evaluation |
| sieve_redirect_add_resent | (New in MS 6.3p1) System default for whether Sieve "redirect" actions cause addition of Resent-* header lines |
| sieve_user_carryover | Specify whether user Sieve filters "carry over" for (direct LDAP mailDeliveryOption: forward) forwarded recipients |
| Sieve filter limit MTA options | |
| max_addheaders | Maximum number of Sieve "addheader" actions that can be performed |
| max_duplicates | (New in MS 8.0) Maximum "duplicate" tests performed in a Sieve filter |
| max_fileintos | Maximum number of "fileinto" actions that may be performed by a Sieve filter |
| max_notifys | (New in MS 6.2) Maximum number of Sieve "notify" actions that may be applied in a Sieve filter |
| max_redirect_addresses | (New in MS 7.0u1) Maximum number of addresses which will be used from a Sieve external list used in a redirect; i.e., maximum addresses that will be used from a redirect :list Sieve action |
| max_redirects | Maximum number of Sieve "redirect" actions (i.e., forwards) that may be performed in a Sieve filter |
| max_sieve_list_size | Maximum number of elements allowed in a Sieve string-list structure |
| max_sieve_list_size | (New in MS 8.1) Maximum number of iterations allowed in a Sieve :matches operation |
| max_sieve_string_size | (New in MS 7.0u3) Maximum size allowed for any string in a Sieve script |
| max_vacations | Maximum number of vacation actions that may appear in a Sieve filter |
| max_variables | (New in MS 6.2) Maximum number of variables that may be used in a Sieve script |
| Sieve filter caching MTA options | |
| filter_cache_size | (New in MS 6.2) Specify the size of the per-process cache of tokenized Sieve filters |
| filter_cache_timeout | (New in MS 6.2) Specify the retention time for entries in the per-process cache of tokenized Sieve filters |
| Sieve language extension MTA options | |
| enable_sieve_body | Control whether Sieve filters may use the body extension |
| enable_sieve_ereject | (New in MS 7.0u2) Control whether Sieve filters may use the ereject extension |
| enable_sieve_memcache | (New in MS 8.0) Control whether Sieve filters may use the private memcache extension |
| enable_sieve_metermaid | (New in MS 8.0) Control whether Sieve filters may use the private metermaid extension |
| enable_sieve_redis | (New in MS 8.0.2.3) Control whether Sieve filters may use the private redis extension |
| enable_sieve_regex | Control whether Sieve filters may use the regex extension (the :regex match-type) |
| strict_require | Control whether or not to strictly enforce certain rules regarding the syntax of use of "require" in Sieve filters |
| Sieve filter duplicate extension MTA options | |
| duplicate_maximum_timeout | (New in MS 8.0) Maximum period in seconds for Sieve duplicate test storage timeout |
| duplicate_minimum_timeout | (New in MS 8.0) Minimum period in seconds for Sieve duplicate test storage timeout |
| duplicate_timeout_default | (New in ) Default period in seconds for Sieve duplicate test storage timeout |
| duplicate_tracking_url | (New in ) Template for locating per-user duplicate message information |
| max_duplicates | (New in MS 8.0) Maximum "duplicate" tests performed in a Sieve filter |
| Sieve filter error text MTA options | |
| error_text_sieve_access | Specify the error text used when reporting on an error accessing a user's Sieve filter file (for Sieve filters stored on disk) |
| error_text_sieve_syntax | Specify the error text used when reporting on a syntax error in a user Sieve filter |
| error_text_source_sieve_access | Specify the error text used when reporting on an error accessing a source channel Sieve filter file (for Sieve filters stored on disk) |
| error_text_source_sieve_syntax | (New in MS 6.3) Specify the error text used when reporting on a syntax error in a source channel Sieve filter |
| error_text_source_sieve_authorization | (New in MS 6.3) Specify the error text used when reporting on a general error encounted attempting to use a source channel Sieve filter |
| Sieve filter log and debug MTA options | |
| filter_debug | (New in MS 6.2) Control whether detailed (stack state) debugging of Sieve filter evaluation is output |
| log_dkim | (New in 8.1.0.6) Include information about DKIM signing operations in message transaction log entries |
| log_filter | Include applicable Sieve filter actions in MTA message transaction log entries |
| log_from | (New in 8.1.0.2) Include the address found in the From: header field in message transaction log entries |
| log_smartsend | (New in 8.1.0.1) Include additional information about smartsend plugin actions in MTA message transaction log entries |
| log_transactionlog | (New in MS 8.0) Include Sieve "transactionlog" action strings in MTA message transaction log entries |
| Spamfilter MTA options | |
| access_errors | Control the information issued in certain error messages |
| brightmail_* | Aliases for corresponding spamfilter_* MTA options; see the spamfilter_* options for definitions |
| scan_channel | (New in MS 7.0.5) Channel to consider as source channel when initializing the MTA for spam/virus filter package checks performed by non-channel applications and utilities such as imexpire |
| scan_originator | (New in MS 7.0.5) Address to consider as the MAIL FROM/envelope From address when initializing the MTA for spam/virus filter package checks performed by non-channel applications and utilities such as imexpire |
| scan_recipient | (New in MS 7.0.5) Address to consider as the RCPT TO/envelope To address when initializing the MTA for spam/virus filter package checks performed by non-channel applications and utilities such as imexpire |
| error_text_spamfilterN_error | Specify default error text to return in cases of spam/virus filter package problems |
| ldap_domain_attr_optinN | Name of domain-level LDAP attribute selecting opt-in to spam/virus filter package N processing |
| ldap_optinN | Name of user-level LDAP attribute selecting opt-in to spam/virus filter package N processing |
| ldap_source_optinN | Name of user-level LDAP attribute selecting source opt-in to spam/virus filter package N processing |
| ldap_optoutN | Name of user-level LDAP attribute used to opt-out of spam/virus filter package N processing |
| optin_user_carryover | (New in MS 6.2.) Specify whether user spam/virus filter "opt-in" is considered to "carry over" for forwarded recipients |
| spamfilter_* | As of MS 6.3, obsoleted in favor of the new-in-MS-6.3 spamfilter1_* options with which they are (became in MS 6.3) synonymous |
| spamfilterN_action_M | (Values for N of 1--4 are new in MS 6.2; values of 5--8 are new in MS 6.3.) URL that resolves to a Sieve filter, specifying the action to take when the Nth spam/virus filter package returns the corresponding Mth verdict, that is, the action to take corresponding to the spamfilterN_verdict_M verdict |
| spamfilterN_config_file | (Values for N of 1--4 are new in MS 6.2; values of 5--8 are new in MS 6.3.) Location of the configuration file for the Nth spam/virus filter package |
| spamfilterN_final | (Values for N of 1--4 are new in MS 6.2; values of 5--8 are new in MS 6.3.) Control whether the MTA passes the "intermediate" vs. "final" address form to the Nth spam/virus filter package |
| spamfilterN_includeheaders | (New in MS 7.0.5) Specify whether or not to pass to the Nth (N in the range 1--8) spam/virus filter package any header lines added via the $A flag in an address *_ACCESS mapping table |
| spamfilterN_library | (Values for N of 1--4 are new in MS 6.2; values of 5--8 are new in MS 6.3.) Location of the client shared library for the Nth spam/virus filter package |
| spamfilterN_name | (New in MS 7.0.5) Specify a symbolic name for the Nth spam/virus filter package. |
| spamfilterN_null_action | URL that resolves to a Sieve filter, specifying the action(s) to take in the case of a null verdict from the Nth spam/virus filter package |
| spamfilterN_null_optin | (Values for N of 1-4 are new in MS 6.2; values of 5--8 are new in MS 6.3.) Specify a value for the attribute named by the ldap_domain_attr_optinN MTA options, the ldap_optinN MTA options, the (new in MS 8.0.1.3) ldap_optoutN MTA options, or the (new in MS 6.3) ldap_source_optinN MTA options that means that the attribute should be ignored; the purpose is to allow use of these attributes by provisioning facilities that find it easier to set an attribute value rather than to remove an attribute entirely |
| spamfilterN_optional | What to do if a spam/virus filter package is not responding: temporarily reject message vs. allow to pass unfiltered, plus whether to send syslog notice |
| spamfilterN_received | (New in MS 6.2) Specify whether or not to generate a pseudo-Received: header line to pass to the spam/virus filter package. |
| spamfilterN_returnpath | (New in MS 7.0 update 1) Control whether or not to add a Return-path: header line to the message passed to the spam/virus filter package |
| spamfilterN_string_action | (Values for N of 1--4 are new in MS 6.2; values of 5--8 are new in MS 6.3.) URL that resolves to a Sieve filter, specifying the action(s) to take in the case of verdicts from the Nth spam/virus filter package that do not have an explicit corresponding action |
| spamfilterN_verdict_M | (Values for N of 1--4 are new in MS 6.2; values of 5--8 are new in MS 6.3.) For the Nth spam/virus filter package, its Mth verdict string |
| SPF MTA options | |
| error_text_spf_* | (New in MS 6.3, but not taking effect until MS 8.0) Set the text for any of several SPF-related errors |
| spf_max_dns_queries | (New in MS 6.3-0.15) Maximum DNS queries per SPF check |
| spf_max_recursion | (New in MS 6.3-0.15) Maximum recursion during SPF checks |
| spf_max_time | (New in MS 6.3-0.15) Maximum time (seconds) permitted for performing an SPF check |
| spf_smtp_status_fail | (New in MS 6.3-0.15) How to interpret an SPF domain verification failure |
| spf_smtp_status_fail_all | (New in MS 6.3-0.15) How to interpret an SPF subdomain verification failure |
| spf_smtp_status_permerror | (New in MS 6.3-0.15) Interpretation of DNS permanent errors on SPF attempts |
| spf_smtp_status_softfail | (New in MS 6.3-0.15) How to interpret an SPF "soft" domain verification failure |
| spf_smtp_status_softfail_all | (New in MS 6.3-0.15) How to interpret an SPF subdomain "soft" verification failure |
| spf_smtp_status_temperror | (New in MS 6.3-0.15) How to interpret DNS temporary errors during SPF lookups |
| SRS MTA options | |
| error_text_srs_* | (New in MS 7.0u2) Set the text for any of several SRS-related errors |
| srs_domain | (New in 6.3p1) Domain to use in SRS addresses. |
| srs_hash_algoritm | (New in 8.1.0.3) Hash algorithm to use when building SRS addresses. |
| srs_maxage | (New in 6.3p1) Number of days before an SRS address times out |
| srs_secrets | (New in 6.3p1) Secret keys used for encoding and decoding SRS addresses |
| token_char | Specify token character in local-part of address for SRS purposes |
| Syslog MTA options | |
| held_sndopr | Send operator or syslog messages when messages are HELD |
| log_connections_syslog | Send MTA connection transaction log entries to syslog (UNIX) |
| log_messages_syslog | Send MTA message transaction log file entries to syslog |
| log_sndopr | Send an operator or syslog message if the MTA's logging facilities encounter a difficulty |
| log_syslog_prefix | (New in MS 8.0.2.3.) Specifices the prefix used on MTA message transaction log file entries sent to syslog |
| sndopr_prefix | (New in MS 8.0.2.3.) Set the prefix attached to syslog notices. |
| sndopr_priority | Set the priority of operator broadcast or the syslog level of syslog messages |
| spamfilterN_optional | What to do if a spam/virus filter package is not responding: temporarily reject message vs. allow to pass unfiltered, plus whether to send syslog notice |
| Transaction logging MTA options | |
| log_alq | (OpenVMS only) Specify the default allocation quantity for the MTA transaction log file(s) |
| log_auth | (New in MS 7.0.5) Include SMTP MAIL FROM's AUTH parameter in MTA message transaction log entries |
| log_callout_delays | (New in MS 8.0) Include timers showing the time for responses from external components in MTA message transaction log entries |
| log_connection | Include connection information in MTA transaction log entries |
| log_connections_syslog | Send MTA connection transaction log file entries to syslog (UNIX) in addition to, or instead of to, MTA connection transaction log file |
| log_conversion_tag | (New in MS 7.0.5) Include conversion tag(s) field in MTA message transaction log entries |
| log_debug | RESTRICTED: Enable debugging of MTA logging operations |
| log_deq | (OpenVMS only) Specify the default extend quantity for the MTA transaction log file(s) |
| log_delivery_flags | (New in MS 7.0.5) Include delivery flags field in MTA message transaction log entries |
| log_diagnostics | (New in MS 7.0u1) Include diagnostics in MTA message transaction log entries |
| log_dkim | (New in 8.1.0.6) Include information about DKIM signing operations in message transaction log entries |
| log_envelope_id | (New in MS 6.1) Include envelope id in MTA message transaction log entries |
| log_filename | Include message file names in MTA message transaction log entries |
| log_filter | Include applicable Sieve filter actions in MTA message transaction log entries |
| log_format | Control the format of the MTA transaction log file(s) |
| log_from | (New in 8.1.0.2) Include the address found in the From: header field in message transaction log entries |
| log_futurerelease | (New in ) Include value of FUTURERELEASE SMTP extension in MTA message transaction log entries |
| log_header | Include message headers in MTA message transaction log entries |
| log_imap_flags | (New in MS 7.0.5) Include any IMAP flags set by the MTA in MTA message transaction log entries |
| log_intermediate | (New in MS 6.2) Include the "intermediate" address and/or "original" (RCPT TO: command line) forms of destination address in MTA message transaction log entries |
| log_isc_status | (New in MS 8.0.2) Include Indexed Search Converter status information in LMTP server MTA message transaction log entries |
| log_local | Include the local domain name on "bare user name" addresses in MTA message transaction log entries |
| log_mailbox_uid | (New in MS 7.0.5) Include the IMAP UID and UIDVALIDITY of messages delivered by ims-ms channel to the Message Store in MTA message transaction log entries |
| log_message_id | Include message IDs in MTA message transaction log entries |
| log_messages_syslog | Send MTA message transaction log file entries to syslog in addition to, or instead of to, MTA message transaction log file |
| log_mtpriority | (New in MS 8.0) Include message MT-PRIORITY in MTA message transaction log entries |
| log_node | (OpenVMS only prior to MS 6.3) Include the node name on which process runs in MTA message transaction log entries |
| log_notary | Include a NOTARY (delivery receipt) flags indicator in MTA message transaction log entries |
| log_priority | Include message priority in MTA message transaction log entries |
| log_process | Include process ID in MTA message transaction log entries |
| log_queue_time | (New in MS 6.3) Include "time in queue" in MTA message transaction log entries; this also causes inclusion of "time to open or fail to open a connection" in MTA connection log entries |
| log_reason | (New in MS 6.3) Include reason for message rejection in MTA message transaction log entries |
| log_remota_mta | (New in MS 8.0.2.3) Include remote MTA name in MTA message transaction log entries |
| log_sensitivity | Include message's sensitivity value in MTA message transaction log entries |
| log_smartsend | (New in 8.1.0.1) Include additional information about smartsend plugin actions in MTA message transaction log entries |
| log_sndopr | Send an operator or syslog message if the MTA's logging facilities encounter a difficulty |
| log_syslog_prefix | (New in MS 8.0.2.3.) Specifices the prefix used on MTA message transaction log file entries sent to syslog |
| log_times | (New in MS 8.0) Include requested deferral time in MTA message transaction log entries |
| log_tracking | (New in 8.0) Include message tracking ID in MTA message transaction log entries |
| log_transaction_delays | (New in 8.0.1) Not yet implemented. |
| log_transactionlog | (New in MS 8.0) Include Sieve "transactionlog" action strings in MTA message transaction log entries |
| log_uid | (New in MS 8.0) Include recipient UIDs in MTA message transaction log entries |
| log_use_xtext | (New in MS 8.0) Controls xtext encoding of addresses in MTA message transaction log entries |
| log_username | Include the username for an enqueuing process in MTA transaction log entries |
| log_8bit_encode | Controls how non-ASCII characters are written in XMl format MTA transaction log file(s) |
| return_cleanup_period | Run site's cleanup script every Nth run of return_job |
| return_split_period | Start new mail.log_current file every Nth run of return_job |
| separate_connection_log | Write connection transaction log entries to a separate file than message transaction log entries |
| OpenVMS user agent MTA options | |
| delivery_receipt_off | (OpenVMS only) Comment string that disables delivery receipt request |
| delivery_receipt_on | (OpenVMS only) Comment string that enables delivery receipt request |
| dis_nesting | (OpenVMS only) Nesting allowed for VMS MAIL @DIS lists |
| form_names | (OpenVMS only) List of the names of pop-up form images |
| mail_delivery_filename | (OpenVMS only) Set MAIL.DELIVERY filename |
| missing_address | (OpenVMS only) Address to insert of VMS MAIL From: if empty |
| multinet_mm_exclusive | (OpenVMS only) VMS MAIL vs. Multinet MM mailbox |
| read_receipt_off | (OpenVMS only) Comment string that disables read receipt request |
| read_receipt_on | (OpenVMS only) Comment string that enables read receipt request |
| safe_tcl_mode | (OpenVMS only) Control handling of Safe-Tcl message parts |
| use_mail_delivery | (OpenVMS only) Enable MAIL.DELIVERY processing |
| vms_mail_exclusive | (OpenVMS only) VMS MAIL vs. Multinet MM mailbox |
+Note that the MTA's SMTP AUTH user authentication lookups are done using general authentication library code, also used for IMAP, POP, or mshttpd user logins (authentication). The authentication library code generally does not make use of the MTA-specific options, but rather is controlled by Auth options (or in legacy configuration, configutil parameters). However, for a few specific cases of MTA options affecting authentication library operation, see the Direct LDAP attributes returned upon authentication MTA options.
See also:
