Sun Java System Messaging Server 6.3 Administration Reference

Option File Format and Available Options

Option files consist of several lines. Each line contains the setting for one option. An option setting has the form:


option=value

The value may be either a string, an integer, or a floating point value depending on the option's requirements. If the option accepts an integer value, a base may be specified using notation of the form b%v, where b is the base expressed in base 10 and v is the actual value expressed in base b.

Long option values may be broken onto several lines. Each line that is to be continued should end with a back slash (\).

Comments are allowed. Any line that begins with an exclamation point (!), hash (#), or semicolon (;) is considered to be a comment and is ignored. You are allowed comments between continuation lines. Blank lines are also ignored in any option file.

The available options are listed in Table 4–16.

Table 4–16 Option File Options

Options  

Description  

ACCESS_COUNTS

Provides a way to get at various types of recipient count information in the various recipient *_ACCESS mappings. ACCESS_COUNTS is bit-encoded and if set enables the addition of a set of counts to the end of the access mapping probe string. Bits 1-4 (values 2-16), if set, selectively enable the addition to the ORIG_SEND_ACCESS, SEND_ACCESS, ORIG_MAIL_ACCESS, and MAIL_ACCESS mappings respectively. The default is 0.

Currently the format of the count addition is: 


RCPT-TO-count/total-recipient-count/              

Note the trailing slash. It is expected that additional counter information will be added to this field in the future; all mappings making use of this information should be coded to ignore anything following the (current) last slash or they may break without warning. 

ACCESS_ERRORS (Integer 0 or 1)

Controls whether or not a $N in one of the *_ACCESS mappings that does not supply its own error text returns a generic invalid address error (value 0, the default) or a more specific you are not allowed to send to this address error (value 1).

ACCESS_ORCPT (Integer)

Setting ACCESS_ORCPT to 1 adds an additional vertical bar delimited field to the probe value passed to the SEND_ACCESS, ORIG_SEND_ACCESS, MAIL_ACCESS, and ORIG_MAIL_ACCESS mapping tables that contains the original recipient (ORCPT) address. If the message doesn't have an ORCPT address the original unmodified RCPT TO: address is used instead. Bits 1-4 (values 2-16), if set, selectively enable the addition to the ORIG_SEND_ACCESS, SEND_ACCESS, ORIG_MAIL_ACCESS, and MAIL_ACCESS mappings respectively. The default is 0.

ALIAS_DOMAINS (Integer)

Controls the format of alias file and alias database lookups. This option takes a bit-encoded integer as its argument. The default value is 1, meaning that alias file and alias database lookups probe with only the local part (mailbox portion) of the address. Not that for addresses matching the local channel, such a probe is made even if bit 0 (value 1) is not set. Setting bit 1 (value 2) causes a probe to be made using the entire address (including the domain name). Setting bit 2 (value 4) causes a wildcard (*) probe to be made. If all bits are set, that is ALIAS_DOMAIN=7, then the order of the probes is to first probe with the entire address (the most specific check), next probe with a wildcard (*) local part plus the domain name, and finally probe with just the local part.

ALIAS_ENTRY_CACHE_NEGATIVE

Controls negative caching of alias entries. A nonzero value enables caching of alias match failures. A zero value disables it. 

Default: 0

ALIAS_ENTRY_CACHE_SIZE

Controls the size, in entries, of the alias cache. 

Default: 1000

ALIAS_ENTRY_CACHE_TIMEOUT

Controls the timeout, in seconds, of the alias cache. 

Default: 600

ALIAS_URL0ALIAS_URL1ALIAS_URL2ALIAS_URL3 (URL)

Specifies a URL to query for alias lookups. The URL must be specified using standard LDAP URL syntax, except the LDAP server and port must be omitted. The LDAP server and port are specified via the LDAP_HOST and LDAP_PORT options.

See The Direct LDAP Algorithm and Implementation in Sun Java System Messaging Server 6.3 Administration Guide for certain substitution sequences.

ALIAS_HASH_SIZE (Integer <= 32,767)

Sets the size of the alias hash table. This is an upper limit on the number of aliases that can be defined in the alias file. The default is 256; the maximum value is 32,767. 

ALIAS_MAGIC

Determines he exact alias sources that are checked and the order in which they are checked. When set to 8764, the URL specified by the ALIAS_URL0 MTA option is checked first, then the URL specified by the ALIAS_URL1 MTA option, then the URL specified by the ALIAS_URL2 MTA option, and finally, the alias file. The alias database is not checked when this setting is active.

ALIAS_MEMBER_SIZE (Integer <= 20,000)

Controls the size of the index table that contains the list of alias translation value pointers. The total number of addresses on the right sides of all of the alias definitions in the alias file cannot exceed this value. The default is 320; the maximum value is 20,000. 

ALIASDETOURHOST_NULL_OPTIN

Specifies a special value which, if used in the optin attribute, is treated as the same as the attribute being omitted. The default value is "", which means that an empty attribute value is ignored. This option is similar to the SPAMFILTERx_NULL_OPTIN option..

ALLOW_UNQUOTED_ADDRS_VIOLATE_RFC2798

If set to 1, it will add additional filter terms to search on the syntactically invalid dequoted form of quoted addresses. 

Default: 0

AUTOREPLY_TIMEOUT_DEFAULT

Sets the duration, in hours, for successive autoreply responses to any give mail sender if the mailAutoReplyTimeOut attribute does not appear on a user entry.

Default: 168 

BLOCK_LIMIT (Integer > 0)

Places an absolute limit on the size, in blocks, of any message that may be sent or received with the MTA. Any message exceeding this size is rejected. By default, the MTA imposes no size limits. Note that the blocklimit channel keyword can be used to impose limits on a per-channel basis. The size in bytes of a block is specified with the BLOCK_SIZE option.

BLOCK_SIZE (Integer > 0)

The MTA uses the concept of a “block” in several ways. For example, the MTA log files (resulting from placing the logging keyword on channels) record message sizes in terms of blocks. Message size limits specified using the maxblocks keyword are also in terms of blocks. Normally, an MTA block is equivalent to 1024 characters. This option can be used to modify this sense of what a block is.

Caution: Reducing BLOCK_SIZE too much (to a value of 1) may have negative impact on the MTA.

BLOCKED_MAIL_FROM_IPS

The introduction of DNS wildcard entries in the COM and ORG top-level domains has made the mailfromdnsverify channel keyword almost useless. The mailfromdnsverify code has been modified to address this. When the DNS returns one or more A records, their values are compared against the domain literals specified by this option. If a match is found the domain is considered to be invalid. To restore correct behavior of mailfromdnsverify, the current correct setting is:

BLOCKED_MAIL_FROM_IPS=[192.168.168.3]

This option’s value defaults to an empty string. 

BOUNCE_BLOCK_LIMIT (Integer)

Used to force bounces of messages over the specified size to return only the message headers, rather than the full message content. 

BRIGHTMAIL_ACTION_n

As a pair with the matching Brightmail_verdict_n option, this can specify a Sieve command with optional if-then-else statement* to execute. For example, if you want to reject spam, then you may have the pair:

Brightmail_verdict_0=spamfolder Brightmail_action_0=data:,require "reject"; reject "Rejected by Brightmail";

The template for the Sieve command is:data:,[requirecommand;] command;Where the require statement is needed for reject and fileinto. Another example:

Brightmail_verdict_1=spam-folder Brightmail_action_1_=data;,require "fileinto";fileinto "Junk";

This files the spam (assuming spam-folder is the verdict returned by Brightmail for spam) into a folder called Junk. Without Junk, spam will be filed into the folder called spam-folder.

Default: none 

BRIGHTMAIL_CONFIG_FILE (path)

Required to activate Brightmail. Full file path and name of the Brightmail configuration file. When specified along with Brightmail_library, the MTA is enabled for Brightmail integration. Can also be used with SpamAssassin. 

Example: /opt/mailwall/configDefault: None

BRIGHTMAIL_LIBRARY (path)

Required to activate Brightmail. Full file path and name of the Brightmail SDK shared library. When specified along with Brightmail_config_file, this library is loaded by the MTA at run time. Can also be used with SpamAssassin.

Example: /opt/mailwall/lib/libbmiclient.so Default: None

BRIGHTMAIL_NULL_ACTION

Specifies a Sieve command with optional if-then-else statement* to execute when the verdict from Brightmail matches the Null action in the Brightmail configuration file. For example, if the Brightmail configuration file has: 

blSWClientDestinationLocal: spam|

where the null or nothing after the | means the null action. If the verdict for the message is spam, matching the word spam before the |, then the null action will be taken by the MTA. There is usually no reason to specify this option, since the default action is discard, matching what Brightmail means by the null action. Can also be used with SpamAssassin.

The template for the Sieve command is:data:,[requirecommand;] command;Where the require statement is needed for reject and fileinto.

Default: data:,discard;

BRIGHTMAIL_OPTIONAL

If set to 1, when the MTA calls an initialization routine to load the Brightmail SDK, but fails, the MTA continues as if Brightmail was not enabled. This setting has no effect if the MTA is already in a dialogue with Brightmail and Brightmail dies. In this case the MTA returns a temporary error to the SMTP client. 

Default: 0

BRIGHTMAIL_STRING_ACTION

Specifies a Sieve command with optional if-then-else statement* to execute when the Brightmail verdict matches an action which is a string in the Brightmail configuration file. Can also be used with SpamAssassin. For example, if in the Brightmail configuration file you have 

blSWClientDestinationLocal: spam|spam-folder

then spam-folder is a string. If the verdict is spam, then we have a string which matches the verdict. This option is rarely used, since the default action when a string is specified is to file the message into that folder.

The template for the Sieve command is:data:,[requirecommand”;] command;Where the require statement is needed for reject and fileinto.

Default: data:,require "fileinto"; fileinto "$U”;

$U is the string to the right of | in the blSWClientDestinationLocal value (in the example above it would be spam-folder)

BRIGHTMAIL_VERDICT_n

Brightmail_verdict_n and Brightmail_action_n are matched pairs, where n is a number from 0 to 9. These options are not normally specified if you take the default interpretation of Brightmail verdicts. The possible values for this option are specified by the values on the right of the | in the Brightmail configuration file options blSWClientDestinationLocal (for local domains) or blSWClientDesintationForeign (for domains that are not local). Using the example:

blSWClientDestinationLocal=spam|spamfolder

you would want to have Brightmail_verdict_0=spamfolder (not spam, which is to the left of |. This may seem non-intuitive, but that is indeed how it works.

Default: none 

CACHE_DEBUG (0 or 1)

When set to 1, this option indicates to various MTA components to write information about the domain, alias, and reverse caches to its debug log file just prior to exiting. 

CHANNEL_TABLE_SIZE

(Integer <= 32,767) 

Controls the size of the channel table. The total number of channels in the configuration file cannot exceed this value. The default is 256; the maximum is 32,767. 

CIRCUITCHECK_COMPLETED_BINS

(comma separated list of up to eight integers) 

Specifies the bin divisions, in seconds, for the MTA circuit check counters. The default values are 120, 300, 900, 1800, 3600, 7200, 14400, and 28800 (2 minutes, 5 minutes, 30 minutes, 1 hour, 2 hours, 4 hours, and 8 hours respectively). 

CIRCUITCHECK_PATCHS_SIZE

(Integer <=256) 

Controls the size of the circuit check paths table, and thus the total number of circuit check configuration file entries. The default is 10.

COMMENT_CHARS (Integer list)

Sets the comment characters in the MTA configuration files. The value of this option takes the form of a list of ASCII character values in decimal. The default is the list {33, 59}, which specifies exclamation points and semicolons as comment introduction characters. 

CONTENT_RETURN_BLOCK_LIMIT (Integer)

Specifies the maximum size of an originating message that will be returned in a notification message. If the original message content is larger than this size, then the message will not be returned in a notification message. The units are in blocks (see BLOCK_SIZE).

CONVERSION_SIZE

(Integer <= 2000) 

Controls the size of the conversion entry table, and thus the total number of conversion file entries cannot exceed this number. The default is 32.

DEFER_GROUP_PROCESSING

Whether mail groups are expanded online (by the enqueuing tcp_smtp_server, for instance, or offline by enqueuing the group address unchanged to the reprocess channel, is controlled by the value of the mailDeferprocessing attribute on the LDAP entry for the group. If that attribute is absent, then the behavior of the system is controlled by the DEFER_GROUP_PROCESSING option. If this value is set, mail groups with no mailDeferProcessing attribute are expanded offline. Otherwise they are expanded online.

The default is 1 (yes).

DELIVERY_OPTIONS

Controls the conversion of the mailDeliveryOption attribute into appropriate addresses. This option not only specifies what addresses are produced by each permissible mailDeliveryOption value, but also what the permissible mailDeliveryOption values are and whether or not each one is applicable to users, groups, or both. The value of this option consists of a comma-separated list of deliveryoption=template pairs, each pair with one or more optional single character prefixes. Refer to the Sun Java System Messaging Server 6.3 Administration Guide for more details.

Default: 

DELIVERY_OPTIONS=*mailbox=$M%$\\$2I$_+$2S@ims-ms-daemon,&members=*, *native=$M@native-daemon,/hold=@hold-daemon:$A,*unix=$M@native-daemon,&file=+$F@native-daemon,&@members_offline=*,program=$M%$P@pipe-daemon,#forward=**,*^!autoreply=$M+$D@bitbucket

DEQUEUE_DEBUG (0 or 1)

Specifies whether debugging output from the MTA's dequeue facility (QU) is produced. If enabled with a value of 1, this output is produced on all channels that use the QU routines. The default of 0 disables this output.

DEQUEUE_MAP (0 or 1)

Determines whether or not a message is mapped into memory when dequeuing. The default is 1.

DOMAIN_FAILURE

Specifies a template to use in the event of a domain lookup failure. 

Default: reprocess-daemon$Mtcp_local$1M$1~-error$4000000?Temporary lookup failure

DOMAIN_HASH_SIZE

(Integer <= 32,767) 

Controls the size of the domain rewrite rules hash table. Each rewrite rule in the configuration file consumes one slot in this hash table; thus the number of rewrite rules cannot exceed this option's value. The default is 512; the maximum number of rewrite rules is 32,767.

DOMAIN_MATCH_CACHE_SIZE 

Sets the maximum size of the MTA’s private domain match cache. 

Default: 

10000

DOMAIN_MATCH_CACHE_TIMEOUT 

Sets the timeout for entries in the MTA’s private domain match cache. 

Default: 

600 (seconds)

DOMAIN_MATCH_URL

Sets the URL for vanity domain checking. The value of this option should be set to: 

ldap:///$B?msgVanityDomain?sub?(msgVanityDomain=$D)

DOMAIN_UPLEVEL (Integer)

Controls the MTA domain and email address lookup. It accepts a two-bit binary value. Table 4–17 describes this control in detail.

Default is 0.

ERROR_TEXT_ACCEPTED_RETURN_ADDRESS

Configurable error message the SMTP server either returns or places in DSNs. 

Default:return address invalid/unroutable but accepted anyway 

ERROR_TEXT_ACCESS_FAILURE

Configures the text string returned by the MTA. The value must conform to the requirements of SMTP error response text. In particular, it is constrained to be in the US-ASCII character set. The MTA will convert any eight bit characters in such option values into the dollar character ($).

Default: you are not allowed to use this address 

ERROR_TEXT_ALIAS_AUTH

Configures the text string returned by the MTA. The value must conform to the requirements of SMTP error response text. In particular, it is constrained to be in the US-ASCII character set. The MTA will convert any eight bit characters in such option values into the dollar character ($).

Default: you are not allowed to use this list 

ERROR_TEXT_ALIAS_FILEERROR

Configures the text string returned by the MTA. The value must conform to the requirements of SMTP error response text. In particular, it is constrained to be in the US-ASCII character set. The MTA will convert any eight bit characters in such option values into the dollar character ($).

Default: error opening file/URL referenced by alias 

ERROR_TEXT_ALIAS_FILEEXIST

Configures the text string returned by the MTA. The value must conform to the requirements of SMTP error response text. In particular, it is constrained to be in the US-ASCII character set. The MTA will convert any eight bit characters in such option values into the dollar character ($).

Default: nonexistent file referenced by alias 

ERROR_TEXT_ALIAS_LOCKED

Configures the text string returned by the MTA. The value must conform to the requirements of SMTP error response text. In particular, it is constrained to be in the US-ASCII character set. The MTA will convert any eight bit characters in such option values into the dollar character ($).

Default: list is currently reserved and locked 

ERROR_TEXT_ALIAS_TEMP

Configures the text string returned by the MTA. The value must conform to the requirements of SMTP error response text. In particular, it is constrained to be in the US-ASCII character set. The MTA will convert any eight bit characters in such option values into the dollar character ($).

Default: temporary error returned by alias expansion 

ERROR_TEXT_BLOCK_OVER

Configures the text string returned by the MTA. The value must conform to the requirements of SMTP error response text. In particular, it is constrained to be in the US-ASCII character set. The MTA will convert any eight bit characters in such option values into the dollar character ($).

Default: channel size limit exceeded 

ERROR_TEXT_DELETED_GROUP

Configures the text string returned by the MTA. The value must conform to the requirements of SMTP error response text. In particular, it is constrained to be in the US-ASCII character set. The MTA will convert any eight bit characters in such option values into the dollar character ($).

Default: group no longer on server 

ERROR_TEXT_DELETED_USER

Configures the text string returned by the MTA. The value must conform to the requirements of SMTP error response text. In particular, it is constrained to be in the US-ASCII character set. The MTA will convert any eight bit characters in such option values into the dollar character ($).

Default: recipient no longer on server 

ERROR_TEXT_DISABLED_ALIAS

Configures the text string returned by the MTA. The value must conform to the requirements of SMTP error response text. In particular, it is constrained to be in the US-ASCII character set. The MTA will convert any eight bit characters in such option values into the dollar character ($).

Default: alias disabled; cannot receive new mail 

ERROR_TEXT_DISABLED_USER

Configures the text string returned by the MTA. The value must conform to the requirements of SMTP error response text. In particular, it is constrained to be in the US-ASCII character set. The MTA will convert any eight bit characters in such option values into the dollar character ($).

Default: user disabled; cannot receive new mail 

ERROR_TEXT_DUPLICATE_ADDRS

Configures the text string returned by the MTA. The value must conform to the requirements of SMTP error response text. In particular, it is constrained to be in the US-ASCII character set. The MTA will convert any eight bit characters in such option values into the dollar character ($).

Default: duplicate/ambiguous directory match 

ERROR_TEXT_INACTIVE_GROUP

Configures the text string returned by the MTA. The value must conform to the requirements of SMTP error response text. In particular, it is constrained to be in the US-ASCII character set. The MTA will convert any eight bit characters in such option values into the dollar character ($).

Default: group temporarily disabled 

ERROR_TEXT_INACTIVE_USER

Configures the text string returned by the MTA. The value must conform to the requirements of SMTP error response text. In particular, it is constrained to be in the US-ASCII character set. The MTA will convert any eight bit characters in such option values into the dollar character ($).

Default: mailbox temporarily disabled 

ERROR_TEXT_INSUFFICIENT_QUEUE_SPACE

Configurable error message the SMTP server either returns or places in DSNs. 

Default: insufficient free queue space available 

ERROR_TEXT_INVALID_RETURN_ADDRESS

Configurable error message the SMTP server either returns or places in DSNs. 

Default: invalid/unroutable return address not allowed 

ERROR_TEXT_LINE_OVER

Configures the text string returned by the MTA. The value must conform to the requirements of SMTP error response text. In particular, it is constrained to be in the US-ASCII character set. The MTA will convert any eight bit characters in such option values into the dollar character ($).

Default: channel line limit exceeded 

ERROR_TEXT_LIST_BLOCK_OVER

Configures the text string returned by the MTA. The value must conform to the requirements of SMTP error response text. In particular, it is constrained to be in the US-ASCII character set. The MTA will convert any eight bit characters in such option values into the dollar character ($).

Default: list size limit exceeded 

ERROR_TEXT_LIST_LINE_OVER

Configures the text string returned by the MTA. The value must conform to the requirements of SMTP error response text. In particular, it is constrained to be in the US-ASCII character set. The MTA will convert any eight bit characters in such option values into the dollar character ($).

Default: list line limit exceeded 

ERROR_TEXT_MAILFROMDNSVERIFY

Configurable error message the SMTP server either returns or places in DSNs. 

Default: invalid/host-not-in-DNS return address not allowed 

ERROR_TEXT_NOSOLICIT

When used with the NO-SOLICIT SMTP extension (described in the Internet Draft draft-malamud-no-soliciting-07.txt), this option specifies alternate error message text when a message is refused due to an examination of its solicitation fields.

ERROR_TEXT_OVER_QUOTA

Configures the text string returned by the MTA. The value must conform to the requirements of SMTP error response text. In particular, it is constrained to be in the US-ASCII character set. The MTA will convert any eight bit characters in such option values into the dollar character ($).

Default: user over quota; cannot receive new mail 

ERROR_TEXT_PERMANENT_FAILURE

Configures the text string returned by the MTA. The value must conform to the requirements of SMTP error response text. In particular, it is constrained to be in the US-ASCII character set. The MTA will convert any eight bit characters in such option values into the dollar character ($).

Default: unknown host or domain 

ERROR_TEXT_RECEIPT_IT

Configures the text string returned by the MTA. The value must conform to the requirements of SMTP error response text. In particular, it is constrained to be in the US-ASCII character set. The MTA will convert any eight bit characters in such option values into the dollar character ($).

Default: message accepted for list expansion processing 

ERROR_TEXT_SEND_REMOTE_ERROR

Configures the text string returned by the MTA. The value must conform to the requirements of SMTP error response text. In particular, it is constrained to be in the US-ASCII character set. The MTA will convert any eight bit characters in such option values into the dollar character ($).

Default: no protocol to SEND/SAML 

ERROR_TEXT_SEND_UNKNOWN_ERROR

Configures the text string returned by the MTA. The value must conform to the requirements of SMTP error response text. In particular, it is constrained to be in the US-ASCII character set. The MTA will convert any eight bit characters in such option values into the dollar character ($).

Default: do not know how to SEND/SAML 

ERROR_TEXT_SIEVE_ACCESS

Configures the text string returned by the MTA. The value must conform to the requirements of SMTP error response text. In particular, it is constrained to be in the US-ASCII character set. The MTA will convert any eight bit characters in such option values into the dollar character ($).

Default: filter access error 

ERROR_TEXT_SIEVE_SYNTAX

Configures the text string returned by the MTA. The value must conform to the requirements of SMTP error response text. In particular, it is constrained to be in the US-ASCII character set. The MTA will convert any eight bit characters in such option values into the dollar character ($).

Default: filter syntax error 

ERROR_TEXT_SMTP_LINES_TOO_LONG

Configurable error message the SMTP server either returns or places in DSNs. 

Default: lines longer than SMTP allows encountered; message rejected 

ERROR_TEXT_SOURCE_SIEVE_ACCESS

Configurable error message the SMTP server either returns or places in DSNs. 

Default: source channel sieve filter access error 

ERROR_TEXT_SOURCE_SIEVE_AUTHORIZATION

Configurable error message the SMTP server either returns or places in DSNs. 

Default: source channel sieve filter authorization error 

ERROR_TEXT_SOURCE_SIEVE_SYNTAX

Configurable error message the SMTP server either returns or places in DSNs. 

Default: source channel sieve filter syntax error 

ERROR_TEXT_SPAMFILTER_ERROR

Configures the text string returned by the MTA. The value must conform to the requirements of SMTP error response text. In particular, it is constrained to be in the US-ASCII character set. The MTA will convert any eight bit characters in such option values into the dollar character ($).

Default: filtering/scanning error 

ERROR_TEXT_TEMPORARY_FAILURE

Configures the text string returned by the MTA. The value must conform to the requirements of SMTP error response text. In particular, it is constrained to be in the US-ASCII character set. The MTA will convert any eight bit characters in such option values into the dollar character ($).

Default: unknown host or domain 

ERROR_TEXT_TEMPORARY_WRITE_ERROR

Configurable error message the SMTP server either returns or places in DSNs. 

Default: error writing message temporary file 

ERROR_TEXT_TRANSACTION_LIMIT_EXCEEDED

Configurable error message the SMTP server either returns or places in DSNs. 

Default: number of transactions exceeds allowed maximum 

ERROR_TEXT_UNKNOWN_ALIAS

Configures the text string returned by the MTA. The value must conform to the requirements of SMTP error response text. In particular, it is constrained to be in the US-ASCII character set. The MTA will convert any eight bit characters in such option values into the dollar character ($).

Default: unknown or illegal alias 

ERROR_TEXT_UNKNOWN_HOST

Configures the text string returned by the MTA. The value must conform to the requirements of SMTP error response text. In particular, it is constrained to be in the US-ASCII character set. The MTA will convert any eight bit characters in such option values into the dollar character ($).

Default: unknown host or domain 

ERROR_TEXT_UNKNOWN_RETURN_ADDRESS

Configurable error message the SMTP server either returns or places in DSNs. 

Default: invalid/no-such-user return address 

ERROR_TEXT_UNKNOWN_USER

Configures the text string returned by the MTA. The value must conform to the requirements of SMTP error response text. In particular, it is constrained to be in the US-ASCII character set. The MTA will convert any eight bit characters in such option values into the dollar character ($).

Default: unknown or illegal user 

ERROR_TEXT_UNNEGOTIATED_EIGHTBIT

Configurable error message the SMTP server either returns or places in DSNs. 

Default: message contains unnegotiated 8bit 

EXPANDABLE_DEFAULT

(Integer 0 or 1) 

Specifies whether or not lists are expandable by default. The option, if set to 1 enables the SMTP EXPN command. 1 is the default and allows for mail list expansion.

EXPROUTE_FORWARD

(Integer 0 or 1) 

Controls the application of the exproute channel keyword to forward-pointing (To, Cc, and Bcc lines) addresses in the message header. A value of 1 is the default and specifies that exproute should affect forward pointing header addresses. A value of 0 disables the action of the exproute keyword on forward pointing addresses.

FILE_MEMBER_SIZE

Specifies the maximum size of the table that tracks the list of files contributed to the configuration. 

FILTER_CACHE_SIZE

Controls the size of the cache that stores tokenized sieve filters for process-wide reuse. 

Default: 500

FILTER_CACHE_TIMEOUT

Controls the timeout, in seconds, of the filter cache. 

Default: 600

FILTER_DISCARD (1 or 2)

Controls whether mailbox filter discard actions cause such discarded messages to be immediately discarded, or cause such messages to go to the FILTER_DISCARD channel. The FILTER_DISCARD channel keeps messages for a short period before discarding them. The default is FILTER_DISCARD=1, which means that messages discarded by a mailbox filter are immediately discarded. Setting FILTER_DISCARD=2 causes discarded messages to instead be routed to the filter_discard channel.

FILTER_JETTISON

Controls whether the mailbox filter jettison Sieve action immediately discards jettisoned messages, or such messages go to the FILTER_DISCARD channel. The FILTER_DISCARD channel keeps messages for a short period before discarding them. FILTER_JETTISON=1 specifies that jettisoned messages are immediately discarded. FILTER_JETTISON=2 causes jettisoned messages to be routed to the FILTER_DISCARD channel. FILTER_JETTISON takes its default from the FILTER_DISCARD setting. FILTER_DISCARD in turn defaults to 1. See Sun Java System Messaging Server 6.3 Administration Guide for details.

FLORWARD_DATA_SIZE

Sets the initial number of entries in the forward text database.  

The MTA stores the database template strings in string pool 3, so the STRING_POOL_SIZE_3 MTA option controls the initial allocation of space for this purpose.  

Note that these various options only control initial sizes. The various tables and arrays will resize automatically up to the maximum allowed size. The maximum string pool size 50Mb. Up to 2 million entries are allowed.  

GENERAL_DATA_SIZE

Sets the initial number of entries in the general text database.  

The MTA stores the database template strings in string pool 3, so the STRING_POOL_SIZE_3 MTA option controls the initial allocation of space for this purpose.  

Note that these various options only control initial sizes. The various tables and arrays will resize automatically up to the maximum allowed size. The maximum string pool size 50Mb. Up to 2 million entries are allowed.  

GROUP_DN_TEMPLATE

Specifies the URLto use for group DNs. 

Default: ""ldap:///$A??sub?mail=*"

HEADER_LIMIT (Integer)

Specifies the maximum size in blocks of the primary (outermost) message header. Headers are silently truncated when the limit is reached. This limit is useful in preventing a denial of service attack involving a message with an enormous header from consuming all available memory. The default is 2000.

HISTORY_TO_RETURN (1-200)

Controls how many delivery attempt history records are included in returned messages. The delivery history provides an indication of how many delivery attempts were made and might indicate the reason the delivery attempts failed. The default value for this option is 20.

HELD_SNDOPR (Integer 0 or 1)

Controls the production of operator messages when a message is forced into a held state because it has too many Received: header lines. The default is 0 and specifies that the syslog messages are not generated when messages or forced to .HELD status due to too many Received: header lines. The value of 1 specifies that syslog messages are generated.

HOST_HASH_SIZE

(Integer <= 32,767) 

Controls the size of the channel hosts hash table. Each channel host specified on a channel definition in the MTA configuration file (both official hosts and aliases) consumes one slot in this hash table, so the total number of channel hosts cannot exceed the value specified. The default is 512; the maximum value allowed is 32,767.

ID_DOMAIN (U.S. ASCII String)

Specifies the domain name to use when constructing message IDs. By default, the official host name of the local channel is used. 

IMPROUTE_FORWARD

(Integer 0 or 1) 

Controls the application of the improute channel keyword to forward-pointing (To, Cc, and Bcc lines) addresses in the message header. A value of 1 is the default and specifies that improute should affect forward-pointing header addresses. A value of 0 disables the action of the improute keyword on forward-pointing addresses.

INCLUDE_CONNECTIONINFO

Provides a means of including the transport and application connection information in various mapping probes that otherwise would not include this material. If included, the information appears at the beginning of the mapping probe in the same format used in the FROM_ACCESS, MAIL_ACCESS, and ORIG_MAIL_ACCESS mappings. The option is a bit-encoded value that defaults to 0. Each assigned bit corresponds to a particular nonpositional alias parameter, as follows. Setting bit 0 (value 1) corresponds to the AUTH_MAPPING alias. Setting bit 1 (value 2) corresponds to the MODERATOR_MAPPING alias. Setting bit 2 (value 4) corresponds to the CANT_MAPPING alias. Setting bit 3 (value 8) corresponds to the DEFERRED_MAPPING alias. Setting bit 4 (value 16) corresponds to the DIRECT_MAPPING alias. Setting bit 5 (value 32) corresponds to the HOLD_MAPPING alias. Setting bit 6 (value 64) corresponds to the NOHOLD_MAPPING alias. Setting bit 7 (value 128) corresponds to the SASL_AUTH_MAPPING alias. Setting bit 8 (value 256) corresponds to the SASL_MODERATOR_MAPPING alias. Setting bit 9 (value 512) corresponds to the SASL_CANT_MAPPING alias.

LDAP_ADD_HEADER

Specifies the LDAP attribute to use to specify header field values that are to be added to the message header if it is present. Typically, this option is not set because the default value mgrpAddHeader corresponds to the standard schema.

LDAP_ALIAS_ADDRESSES

Can be used to override the use of the mailAlternateAddress attribute.

LDAP_DETOURHOST_OPTIN

Specifies the name of an attribute used to opt the user in to the detour (assuming the source channel has aliasoptindetourhost set). If the values of this attribute contain periods they will be compared against the list of potential detour hosts and the first host on the list that matches will be the chosen detour. If the value does not contain a period,the first detour host will be used unconditionally.

LDAP_ATTR_DOMAIN_SEARCH_FILTER

Specifies the LDAP attribute name in the global Sun ONE LDAP Schema, v2 domain search template which contains the domain search pattern. This option is ignored if the LDAP_GLOBAL_CONFIG_TEMPLATE is not set. The default value of this option is inetDomainSearchFilter.

LDAP_ATTR_DOMAIN1_SCHEMA2

Specifies the LDAP attribute name for the primary domain attribute used by Sun ONE LDAP Schema, v2. The default value is sunPreferredDomain.

LDAP_ATTR_DOMAIN2_SCHEMA2

This is the LDAP attribute name for the secondary domain attribute used by Sun ONE LDAP Schema, v2. The default value is associatedDomain.

LDAP_ATTR_MAXIMUM_MESSAGE_SIZE

Specifies the LDAP attribute to use to specify the maximum message size in bytes that can be sent to the group. Typically, this option is not set because the default value mgrpMsgMaxSize corresponds to the standard schema.

LDAP_AUTH_DOMAIN

Specifies the LDAP attribute to use to identify domains (including subdomains) from which users are allowed to send messages to the mail group. Typically, this option is not set because the default value mgrpAllowedDomain corresponds to the standard schema.

LDAP_AUTH_PASSWORD

Specifies the LDAP attribute to use to specify a password needed to post to the list. Typically, this option is not set because the default value mgrpAuthPassword corresponds to the standard schema.

LDAP_AUTH_POLICY

Specifies the LDAP attribute to use to specify the level of authentication required to access the list of broadcaster addresses. Typically, this option is not set because the default value mgrpBroadcasterPolicy corresponds to the standard schema.

LDAP_AUTH_URL

Specifies the LDAP attribute to use to identify mail users allowed to send messages to the mail group. Typically, this option is not set because the default value mgrpAllowedBroadcaster corresponds to the standard schema.

LDAP_AUTOREPLY_ADDRESSES

Specifies the LDAP attribute to use for generating :addresses arguments to sieve vacation. This option has no value by default. The attribute can be multivalued, with each value specifying a separate address to pass to the :addresses vacation parameter.

LDAP_AUTOREPLY_MODE

Specifies the LDAP attribute to use for the autoreply mode for the user mail account. Typically, this option is not set because the default value mailAutoReplyMode corresponds to the standard schema.

LDAP_AUTOREPLY_SUBJECT

Specifies the LDAP attribute to use for the contents of the subject field in the autoreply response (typically mailAutoReplySubject).

LDAP_AUTOREPLY_TEXT

Specifies the LDAP attribute to use for autoreply text sent to all senders except users in the recipient's domain. Typically, this option is not set because the default value mailAutoReplyText corresponds to the standard schema.

LDAP_AUTOREPLY_TEXT_INT

Specifies the LDAP attribute to use for autoreply text sent to senders from the recipient's domain. Typically, this option is not set because the default valuemailAutoReplyTextInternalcorresponds to the standard schema.

LDAP_AUTOREPLY_TIMEOUT

Specifies the LDAP attribute to use to set the duration, in hours, for successive autoreply responses to any give mail sender. Typically, t his option is not set because the default value mailAutoReplyTimeOut corresponds to the standard schema.

LDAP_BLOCKLIMIT

Specifies the LDAP attribute to use to impose a size limit in units of MTA blocks that can be sent to this user or group. Typically, this option is not set because the default value mailMsgMaxBlocks corresponds to the standard schema.

LDAP_CANT_DOMAIN

Specifies the LDAP attribute to use to identify domains from which users are not allowed to send messages to the mail group. Typically, this option is not set because the default value mgrpDisallowedDomain corresponds to the standard schema.

LDAP_CANT_URL

Specifies the LDAP attribute to use to identify mail users not allowed to send messages to the mail group. Typically, this option is not set because the default value mgrpDisallowedBroadcaster corresponds to the standard schema.

LDAP_CAPTURE

Specifies the attribute used to specify one or more message capture addresses. 

No default. 

LDAP_CONVERSION_TAG

Specifies the LDAP attribute to use for conversion tags attached to a message to this user or group. Tag-specific conversion actions are specified in the MTA configuration. Typically, this option is not set because the default value mailConversionTag corresponds to the standard schema.

LDAP_DEFAULT_ATTR

Specifies the default attribute if no attribute is specified in the LDAP query for URLs that are supposed to return a single result. 

LDAP_DEFAULT_DOMAIN

Overrides the service.defaultdomain configutil parameter.

LDAP_DELIVERY_FILE

Specifies the LDAP attribute to use to specify the fully-qualified local path of the file to which all messages sent to the mailing list are appended. Typically, this option is not set because the default value mailDeliveryFileURL corresponds to the standard schema

LDAP_DELIVERY_OPTION

Specifies the LDAP attribute to use to specify delivery options for the mail recipient. Typically, this option is not set because the default value mailDeliveryOption corresponds to the standard schema.

LDAP_DETOURHOST_OPTIN

Specifies the name of an attribute used to opt the user in to the detour (assuming the source channel has aliasoptindetourhost set). If the values of this attribute contain periods they will be compared against the list of potential detour hosts and the first host on the list that matches will be the chosen detour. If the value does not contain a period, the first detour host will be used unconditionally.

LDAP_DISK_QUOTA

Specifies the LDAP attribute to use to specify disk space allowed for the user's mailbox in bytes. Typically, this option is not set because the default value mailQuota corresponds to the standard schema.

LDAP_DOMAIN_ATTR_ALIAS

Specifies the LDAP attribute name which contains a pointer to another domain node in Sun ONE LDAP Schema, v1. The default value is aliasedObjectName.

LDAP_DOMAIN_ATTR_AUTOREPLY_TIMEOUT

No default. 

LDAP_DOMAIN_ATTR_BASEDN

Specifies the LDAP attribute name which contains the baseDN of the user subtree associated with a given domain in Sun ONE LDAP Schema, v1. In Sun ONE LDAP Schema, v2 mode, this attribute specifies the canonical organization node (under which the users are located) pointed to by a domain index node. The default value is inetDomainBaseDN.

LDAP_DOMAIN_ATTR_BLOCKLIMIT

Specifies the LDAP attribute to use to impose a size limit in units of MTA blocks on all messages sent to addresses in this domain. Typically, this option is not set because the default value mailDomainMsgMaxBlocks corresponds to the standard schema.

LDAP_DOMAIN_ATTR_CANONICAL

Specifies the LDAP attribute name which contains the canonical domain name associated with a Sun ONE LDAP Schema, v1 domain entry. The default value is inetCanonicalDomainName.

LDAP_DOMAIN_ATTR_CATCHALL_ADDRESS

Specifies the LDAP attribute to use to specify an address to be substituted for any address in the domain that does not match any user or group in the domain. Typically, this option is not set because the default value mailDomainCatchallAddress corresponds to the standard schema.

LDAP_DOMAIN_ATTR_CATCHALL_MAPPING

Specifies the name of an LDAP domain attribute. This option is not set by default. If set the option specifies the name of a mapping which is consulted when an address associated with the domain fails to match any user entries. The format of the mapping probe is the same as that of the forward mapping, and the USE_FORWARD_DATABASE MTA option controls the format of the probe of this mapping in the same way as the forward mapping. If the mapping sets the $Y metacharacter the resulting string will replace the address being processed.

LDAP_DOMAIN_ATTR_CONVERSION_TAG

Specifies the LDAP attribute to use for one or more conversion tags attached to messages to any user in the domain. Tag-specific conversion actions are specified in the MTA configuration. Typically, this option is not set because the default value mailDomainConversionTag corresponds to the standard schema.

LDAP_DOMAIN_ATTR_DEFAULT_MAILBOX

Specifies a domain-level attribute containing the default mailhost for the domain. If set and the attribute is present on the domain the mailhost attribute is no longer required on user entries in the domain. This option currently has no default, but preferredmailhost is the logical attribute to use as long as some other, conflicting usage does not exist.

LDAP_DOMAIN_ATTR_DISK_QUOTA

No default. 

LDAP_DOMAIN_ATTR_FILTER

Specifies the LDAP attribute to use to specify the sieve filter for all users in the domain. Typically, this option is not set because the default value mailDomainSieveRuleSource corresponds to the standard schema.

LDAP_DOMAIN_ATTR_MAIL_STATUS

Specifies the LDAP attribute to use to specify the mail status. Typically, this option is not set because the default value mailDomainStatus corresponds to the standard schema.

LDAP_DOMAIN_ATTR_MESSAGE_QUOTA

No default. 

LDAP_DOMAIN_ATTR_NOSOLICIT

When used with the NO-SOLICIT SMTP extension (described in the Internet Draft draft-malamud-no-soliciting-07.txt), this option specifies the name of an LDAP attribute used to store the solicitation field values that are to be declined in messages sent to users in a particular domain. Multiple values and glob-style wildcards are allowed.

Default: none 

LDAP_DOMAIN_ATTR_OPTIN (ASCII)

The name of the LDAP attribute used to activate Brightmail on a per-domain basis. It applies to the destination domain. It is just like LDAP_optin above except it should be in the objectclass mailDomain.

Default: none 

LDAP_DOMAIN_ATTR_PRESENCE

No default. 

LDAP_DOMAIN_ATTR_RECIPIENTCUTOFF

The LDAP attribute specifying the maximum number of recipient addresses for a message (from the domain containing this attribute) before the message is rejected. This is a domain analog to the recipientcutoff keyword. No default.

LDAP_DOMAIN_ATTR_RECIPIENTLIMIT

The LDAP attribute specifying the maximum number of recipient addresses for a message coming from the domain containing this attribute. Addresses over the limited are rejected. This is a domain analog to the recipientlimit keyword. No default.

LDAP_DOMAIN_ATTR_REPORT_ADDRESS

Specifies the LDAP attribute to use to specify the header From: address in DSNs reporting problems associated with recipient addresses in the domain. It is also used when reporting problems to users within the domain regarding errors associated with non-local addresses. If this attribute is not set, the reporting address defaults to postmaster@domain. Typically, this option is not set because the default value mailDomainReportAddress corresponds to the standard schema.

LDAP_DOMAIN_ATTR_ROUTING_HOSTS

Specifies the LDAP attribute to use to specify the fully-qualified host name of the MTA responsible for making routing decisions for users in this (and all contained) domain(s). Typically, this option is not set because the default value mailRoutingHosts corresponds to the standard schema.

LDAP_DOMAIN_ATTR_SOURCE_CHANNEL

Specifies the name of a domain-level attribute containing the name of the channel to switch to. In addition, the channel being switched to must be set to allow channel switches. It cannot, therefore, be marked with the noswitchchannel keyword. Switching is done based on information returned by rewriting the MAIL FROM address. Note that MAIL FROM addresses are easily forged so this functionality should be used with extreme care.

LDAP_DOMAIN_ATTR_SOURCE_CONVERSION_TAG

Specify domain level LDAP attribute for conversion tags associated with the source address. No default. 

LDAP_DOMAIN_ATTR_SOURCEBLOCKLIMIT

LDAP attribute specifying the maximum number of blocks a message can contain coming from the domain containing this attribute. This is a domain analog to the sourceblocklimit keyword. No default.

No default. 

LDAP_DOMAIN_ATTR_SMARTHOST

Specifies the LDAP attribute to use to specify the fully-qualified host name of a mail server responsible for handling mail for users not found in the local directory. Typically, this option is not set because the default value mailRoutingSmarthost corresponds to the standard schema.

LDAP_DOMAIN_ATTR_STATUS

Specifies the LDAP attribute to use to specify the current status of the mail domain (active, inactive, deleted, or hold). Typically, this option is not set because the default value mailDomainStatus corresponds to the standard schema.

LDAP_DOMAIN_ATTR_UID_SEPARATOR

Specifies the LDAP attribute to use to override the default mailbox (MB) home. Typically, this option is not set because the default value domainUidSeparator corresponds to the standard schema.

LDAP_DOMAIN_FILTER_SCHEMA1

This is the LDAP search filter used for Sun ONE LDAP Schema, v1 domain lookups. 

Default: (|(objectclass=inetDomain)(objectclass=inetdomainalias)).

LDAP_DOMAIN_FILTER_SCHEMA2

This is the LDAP search filter used for Sun ONE LDAP Schema, v2 domain lookups. 

Default: (objectclass=sunManagedOrganization)

LDAP_DOMAIN_ROOT

If set, overrides the service.dcroot configutil parameter.

LDAP_DOMAIN_TIMEOUT

Controls the retention time for entries in the domain map cache. This value is expressed in seconds. 

Default: 

60 * 15 (or 15 minutes)

LDAP_END_DATE

Specifies the vacation end date attribute. 

Default: vacationEndDate

LDAP_EQUIVALENCE_ADDRESSES

Can be used to override the mailEquivalentAddress attribute.

LDAP_ERRORS_TO

Specifies the LDAP attribute to use to specify the recipient of error messages generated when messages are submitted to this list. Typically, this option is not set because the default value mgrpErrorsTo corresponds to the standard schema.

LDAP_EXPANDABLE

Specifies the attribute to check for group expansion as part of an SMTP EXPN command. 

Default: mgmanMemberVisibility

LDAP_FILTER

Specifies the LDAP attribute to use to specify SIEVE rules for filtering mail. Typically, this option is not set because the default value mailSieveRuleSource corresponds to the standard schema.

LDAP_FILTER_REFERENCE

Specifies an attribute containing a DN pointing to a directory entry where the head of household sieve can be found. 

LDAP_FORWARDING_ADDRESS

Default: mailForwardingAddress

LDAP_GLOBAL_CONFIG_TEMPLATES

Specifies the LDAP baseDN which contains the global Sun ONE LDAP Schema, v2 domain template for domain searches. Use of this option is not recommended. There is no default value. 

LDAP_GROUP_DN

Specifies the LDAP attribute to use to identify a member of a group of names where each name was given a uniqueIdentifier to ensure its uniqueness. Typically, this option is not set because the default value uniqueMember corresponds to the standard schema.

LDAP_GROUP_MAIL_STATUS

Controls mail-specific group status attributes. 

LDAP_GROUP_OBJECT_CLASSES

Specifies different sets of object classes for groups. 

LDAP_GROUP_RFC822

Specifies the LDAP attribute to use to identify recipients of mail sent to mail group. Typically, this option is not set because the default value mgrpRFC822MailMember (or rfc822MailMember, used for backward compatibility) corresponds to the standard schema.

LDAP_GROUP_STATUS

Used to select alternate general status attributes for groups. 

LDAP_GROUP_URL1

Specifies the LDAP attribute to use as an alternative method of specifying mail group membership. Typically, this option is not set because the default value mgrpDeliverTo corresponds to the standard schema.

LDAP_GROUP_URL2

Specifies the LDAP attribute to use to specify a list of URLs, which, when expanded, provides a list of mailing list member addresses. Typically, this option is not set because the default value memberURL corresponds to the standard schema.

LDAP_HASH_SIZE

Specifies the size of the internal table of LDAP attribute names. 

LDAP_HOH_FILTER

Specifies an attribute containing the head of household sieve. The value of this option defaults to mailSieveRuleSource.

LDAP_HOH_OWNER

Specifies an attribute containing the email address of the owner of the head of household. The value of this option defaults to mail.

LDAP_HOST (Host name)

If set, overrides the MTA's use of the local.ugldaphost configutil parameter in accessing the LDAP directory server.

LDAP_HOST_ALIAS_LIST

If set, overrides the MTA's use of the local.imta.hostnamealiases configutil parameter in accessing the LDAP directory server.

LDAP_LOCAL_HOST

If set, overrides the MTA's use of the local.hostname configutil parameter in accessing the LDAP directory server.

LDAP_MAIL_REVERSES

Specifies the list of attributes to search containing addresses that are candidates for address reversal. If this option is not set, the local.imta.schematag configutil parameter is examined, and depending on its value, an appropriate set of default attributes is chosen.

LDAP_MAILHOST

Specifies the LDAP attribute to use to specify the fully-qualified host name of the MTA that is the final destination of messages sent to this recipient. Typically, this option is not set because the default value mailhost corresponds to the standard schema.

LDAP_MAX_CONNECTIONS

Limits the number of LDAP connections the LDAP pool the MTA uses can make. Default: 1024.

LDAP_MESSAGE_QUOTA

Specifies the LDAP attribute to use to specify the maximum number of messages permitted for a user. Typically, this option is not set because the default value mailMsgQuota corresponds to the standard schema.

LDAP_MODERATOR_URL

Specifies the LDAP attribute to use to specify the LDAP URI or mailto URL identifying the moderators allowed to submit messages to this list. Typically, this option is not set because the default value mgrpModerator corresponds to the standard schema.

LDAP_NOSOLICIT

When used with the NO-SOLICIT SMTP extension (described in the Internet Draft draft-malamud-no-soliciting-07.txt), this option specifies the name of an LDAP attribute used to store solicitation field values a user declines to accept in a user entry. Multiple attribute values can be used to specify multiple values. Glob-style wildcards can be used.

Default: none; a value must be specified to enable per-user solicitation blocking. 

LDAP_OPTIN (ASCII)

The name of the LDAP attribute used to activate Brightmail on a per-user basis. This should be an attribute in the inetMailUser objectclass. If you do not have another predefined attribute, use mailAntiUBEService.

The attribute itself (example: mailAntiUBEService) is multi-valued, case-sensitive. Its value could be either spam or virus in lowercase. If the user is opting for both, then he would have two such attributes, one containing spam, one containing virus.

Default: none 

LDAP_PARENTAL_CONTROLS

Specifies an attribute containing a string value of either “Yes” or “No”. “Yes” means a head of household sieve is to be applied to this entry, “No” means no such sieve is to be applied. 

LDAP_PASSWORD

If set, overrides the MTA's use of the local.ugldapbindcred configutil parameter in accessing the LDAP directory server.

LDAP_PERSONAL_NAME

The alias processing machinery keeps track of any personal name information specified in the attribute named by the LDAP_PERSONAL_NAME MTA option and will use this information in constructing From: fields for any MDNs or vacation replies that are generated. No default.

Use with caution to avoid exposing personal information. 

LDAP_PORT (Integer)

Specifies the port to which to connect when performing LDAP queries. The default value is 389, the standard LDAP port number.

LDAP_PREFIX_TEXT

Specifies the LDAP attribute to use to specify the text to be added to the beginning of the message text. Typically, this option is not set because the default value mgrpMsgPrefixText corresponds to the standard schema.

LDAP_PRESENCE

Specifies a URL that can be resolved to return presence information about the user. If the option is specified and the attribute is present, its value is saved for possible use in conjunction with sieve presence tests. The domain level attribute set by the LDAP_DOMAIN_ATTR_PRESENCE MTA option is used as source for this URL if no value exists for the user entry.

LDAP_PRIMARY_ADDRESS

Overrides the LDAP attribute to use to specify the primary address typically stored in the mail attribute.

LDAP_PROGRAM_INFO

Specifies the LDAP attribute to use to specify one or more programs used for program delivery. Typically, this option is not set because the default value mailProgramDeliveryInfo corresponds to the standard schema.

LDAP_RECIPIENT

Specifies the name of an LDAP attribute used to store a sending-user-specific maximum number of envelope recipients (additional recipients are rejected). This is a per-user/group analogue of the recipientlimit channel keyword, or the LDAP_DOMAIN_ATTR_RECIPIENTLIMIT domain level attribute.

LDAP_RECIPIENTLIMIT

The LDAP attribute to specify a sending-user-specific maximum number of envelope recipients that a message can contain from a specific sender. Additional recipients are rejected. This attribute is added to a user’s entry. This is a per-user analogue of the recipientlimit channel keyword.

No default. 

LDAP_RECIPIENTCUTOFF

Specifies the name of an LDAP attribute used to store a sending-user-specific maximum number of envelope recipients (messages with more recipients are rejected entirely). This is a per user/group analogue of the recipientcutoff channel keyword, or the LDAP_DOMAIN_ATTR_RECIPIENTCUTOFF domain level attribute.

No default. 

LDAP_REJECT_ACTION

Single-valued attribute that controls what happens if any of the subsequent access checks fail. Only one value is defined: TOMODERATOR, which if set instructs the MTA to redirect any access failures to the moderator specified by the mgrpModerator attribute. The default (and any other value of this attribute) causes an error to be reported and the message rejected.

Default: mgrpMsgRejectAction

LDAP_REJECT_TEXT

Specifies the LDAP attribute to use to specify text to return if any of the authentication attributes cause the message to be rejected. Typically, this option is not set because the default value mailRejectText corresponds to the standard schema.

LDAP_REMOVE_HEADER

Specifies the LDAP attribute to use to specify a header field that is to be removed from the message header if it is present. Typically, this option is not set because the default value mgrpRemoveHeader corresponds to the standard schema.

LDAP_REPROCESS

Specifies the attribute used for deferred mail processing. 

Default: mailDeferProcessing

LDAP_ROUTING_ADDRESS

Specifies the LDAP attribute to use to determine whether or not the address should be acted on at this time or forwarded to another system. Typically, this option is not set because the default value mailRoutingAddress corresponds to the standard schema.

LDAP_SCHEMALEVEL

If set to value 2, this enables support for Sun ONE LDAP Schema, v2.

LDAP_SCHEMATAG

Can be used to override the setting of the local.imta.schematag configutil parameter specifically for the MTA.

LDAP_SOURCE_CHANNEL

Specifies the name of a user-level attribute containing the name of the channel to switch to. In addition, the channel being switched to must be set to allow channel switches. It cannot, therefore, be marked with the noswitchchannel keyword. Switching is done based on information returned by rewriting the MAIL FROM address. Note that MAIL FROM addresses are easily forged so this functionality should be used with extreme care.

LDAP_SOURCE_CONVERSION_TAG

Specifies user-level LDAP attribute for conversion tags associated with the source address. No default. 

LDAP_SOURCEBLOCKLIMIT

The LDAP attribute to specify the maximum number of blocks allowed in a user’s message. The MTA rejects messages containing more blocks than this from a user. An MTA block is normally 1024 bytes, but this can be changed with the BLOCK_SIZE option in the MTA option file. This is a user analog to the sourceblocklimit keyword and has no default.

LDAP_SPARE_1

Spare slot for additional attributes to be used to build customized address expansion facilities. No default. 

LDAP_SPARE_2

Spare slot for additional attributes to be used to build customized address expansion facilities. No default. 

LDAP_SPARE_3

Spare slot for additional attributes to be used to build customized address expansion facilities. No default. 

LDAP_SPARE_4

Spare slot for additional attributes to be used to build customized address expansion facilities. No default. 

LDAP_SPARE_5

Spare slot for additional attributes to be used to build customized address expansion facilities. No default. 

LDAP_START_DATE

Specifies the vacation start date attribute. 

Default: vacationStartDate

LDAP_SUFFIX_TEXT

Specifies the LDAP attribute to use to specify the text to append to the text message. Typically, this option is not set because the default value mgrpMsgSuffixText corresponds to the standard schema.

LDAP_TIMEOUT (Integer)

Controls the length of time to wait (in hundredths of seconds) before timing out on an LDAP query. The default value is 180000.

LDAP_UG_FILTER

Object class settings are used to construct an actual LDAP search filter that can be used to check to see that an entry has the right object classes for a user or a group. This filter is accessible through the $K metacharacter. It is also stored internally in the MTA's configuration for use by channel programs and is written to the MTA option file, option.dat, as the LDAP_UG_FILTER option when the command imsimta cnbuild -option is used. This option is only written to the file. The MTA never reads it from the option file.

LDAP_UID

Specifies the LDAP attribute to use to identify the entry’s userid. Typically, this option is not set because the default value uid corresponds to the standard schema. Identifies the entry's userid.

LDAP_USE_ASYNC

Controls the use of asynchronous LDAP lookups. This option is a bit-encoded value. Each bit, if set, enables the use of asynchronous LDAP lookups in conjunction with a specific use of LDAP within the MTA. This value is a decimal integer representing a bit-encoded integer, the interpretation of which is given in Table 4–21.

Default: 0 (asynchronous LDAP looks are disabled)

LDAP_USERNAME

If set, overrides the MTA’s use of the local.ugldapbinddn configutil parameter in accessing the LDAP directory server.

LDAP_USER_MAIL_STATUS

Controls mail-specific user status attributes. 

LDAP_USER_OBJECT_CLASSES

Specifies different sets of object classes for users. 

LDAP_USER_ROOT

If set, overrides the MTA’s use of the local.ugldapbasedn configutil parameter.

LDAP_USER_STATUS

Used to select alternate general status attributes for users. 

LINE_LIMIT (Integer)

Places an absolute limit on the overall number of lines in any message that may be sent or received with the MTA. Any message exceeding this limit is rejected. By default, the MTA imposes no line-count limits.The linelimit channel keyword can be used to impose limits on a per channel basis.

LINES_TO_RETURN (Integer)

Controls how many lines of message content the MTA includes when generating a notification message for which it is appropriate to return on a sample of the contents. Setting the LINES_TO_RETURN option to 0 disables partial content return. Only the headers of the message part are returned. The default is 20.

LOG_CONNECTION (Integer)

The LOG_CONNECTION option controls whether or not connection information, for example, the domain name of the SMTP client sending the message, is saved in mail.log file entries and the writing of connection records when the logging channel keyword is enabled for the channel. This value is a decimal integer representing a bit-encoded integer, the interpretation of which is given below:

Bit-0 Value-1: When set, includes source system information in mail.log E, D, R, and J entries, as well as transport information in Reporting-MTA fields of DSNs.

Bit-1 Value-2: When set, connection open, close, and fail records are logged by message enqueue and dequeue agents such as the SMTP clients and servers. 

Bit-2 Value-4: When set, I records are logged recording ETRN events. 

Bit 3 Value-8: When set, includes transport information in Reporting-MTA fields of DSNs. 

Bit 4 Value 16: When set, allows PORT_ACCESS to add text to an application information string. 

Bit 5 Value 32: When set, includes transport information string in mail.log entries.This will always include a source IP address for incoming TCP/IP connections. 

Bit 6 Value 64: When set, includes application information string in mail.log entries. 

Bit 7 Value 128: When set, generates a U record type which logs SMTP authentication successes and failures. A diagnostic field will record the result of the authentication attempt and the username will be logged in the username field if it is known. 

Where Bit 0 is the least significant bit. 

LOG_CONNECTIONS_SYSLOG (0 or 1)

Sends MTA connection log file entries to syslog (UNIX) or event log (Windows NT). 0 is the default and indicates that syslog (event log) logging is not performed. A value of 1 indicates that syslog logging is performed.

LOG_SENSITIVITY (0 or 1)

Controls whether message Sensitivity: header values are included in log entries. A value of 1 enables such logging. The default value of 0 disables such logging. If logging is enabled, the sensitivity value is logged in an integer representation after the connection information and before the transport information.

LOG_DELAY_BINS

Specifies the bins for delivery delay range counters. The parameters for this options should be a comma-separated list of up to five integers. The default values are 60, 600, 6000, 60000, 600000.

LOG_ENVELOPE_ID (0 or 1)

Controls whether or not envelope IDs are logged. If envelope IDs are logged, they appear just before the message IDs in the log. 

The value of this option defaults to 0, which prevents envelope IDs from being logged.

LOG_FILENAME (0 or 1)

Controls whether the names of the files in which messages are stored are saved in the mail.log file. A value of 1 enables file name logging. A value of 0 (the default) disables it.

LOG_FILTER (0 or 1)

Specifies whether or not the list of active filters enclosed by single quotes are written into enqueue records in the log file just prior to the diagnostics field. The default is 0 (do not write lists into enqueue records).

LOG_FORMAT (1, 2, 3, or 4)

Controls formatting options for the mail.log file. A value of 1 (the default) is the standard format. A value of 2 requests non-null formatting: empty address fields are converted to the string “<>.” A value of 3 requests counted formatting: all variable length fields are preceded by N, where N is a count of the number of characters in the field. A value of 4 causes log entries to be written in an XML-compatible format. For details about value 4, see Specifying Additional MTA Logging Options in Sun Java System Messaging Server 6.3 Administration Guide

LOG_FRUSTRATION_LIMIT

Specifies the limit of “frustration counts.” In a process, if repeated retries of writing a counter fails, the “frustration count” is incremented. Once the count reaches this limit, that process stops attempting to write counters. 

LOG_HEADER (0 or 1)

Controls whether the MTA writes message headers to the mail.log file. A value of 1 enables message header logging. The specific headers written to the log file are controlled by a site-supplied log_header.opt file. The format of this file is that of other MTA header option files. For example, a log_header.opt file containing the following would result in writing the first To and the first From header per message to the log file. A value of 0 (the default) disables message header logging:

To: MAXIMUM=1

From: MAXIMUM=1

Defaults: MAXIMUM=-1

LOG_INTERMEDIATE

Enables the system to log the address initially presented in the RCPT TO as well as the intermediate address generated during alias expansion. If Bit 0 is set (value 1) the intermediate address will be logged. If Bit 1 (value 2) is set, the initially presented address is logged. If logged, this information appears immediately before filter information in the log record, with the intermediate address coming first if both are logged. 

LOG_LOCAL (0 or 1)

Controls whether the domain name for the local host is appended to logged addresses that don't already contain a domain name. A value of 1 enables this feature, which is useful when logs from multiple systems running the MTA are concatenated and processed. A value of 0, the default, disables this feature.

LOG_MESSAGE_ID (0 or 1)

Controls whether message IDs are saved in the mail.log file. A value of 1 enables message ID logging. A value of 0 (the default) disables it.

LOG_MESSAGES_SYSLOG (0 or 1)

A value of 0 disables generation of the syslog notices. A non-zero value enables generation of the syslog notices, with the absolute value controlling the syslog priority and facility mask. (Positive values mean syslog notices and the regular mail.log* entries; negative values, which are not recommended, mean syslog notices only, disabling the regular mail.log* entries. A value of 0 is the default and indicates that syslog (event log) logging is not performed.

LOG_PROCESS (0 or 1)

Includes the enqueuing process ID in the MTA’s log entries. 

LOG_QUEUE_TIME (0 or 1)

Log the amount of time a message has spent in the queue. Queue time is logged as an integer value in seconds. It appears immediately after the application information string in non-XML format logs. The attribute name in XML formatted logs for this value is "qt". 1 enables, O disables.  

Default: 0  

LOG_REASON(0 or 1)

Controls storage of error reason information in log records. Setting the option to 1 enables this storage, 0 disables it. This information, if present, appears just before diagnostic information in log records. 

Default: 0 

LOG_SNDOPR (0 or 1)

Controls the production of syslog messages by the MTA message logging facility. 

LOG_SIZE_BINS

Specifies the bin sizes for message size range counters. The value is a comma-separated list of up to five integers. The default values are 2, 10, 50, 100, 500.

LOG_USERNAME (0 or 1)

The LOG_USERNAME option controls whether or not the username associated with a process that enqueues mail is saved in the mail.log file. Note that messages submitted via SMTP with authentication (SMTP AUTH) will be considered to be owned by the username that authenticated, prefixed with the asterisk, *, character. A value of 1 enables username logging. When username logging is enabled, the username will be logged after the final form envelope To: address field in log entries---and after the message ID, if LOG_MESSAGE_ID=1 is also enabled. A value of 0 (the default) disables username logging.

MAIL_OFF (String)

Specifies the comment string that disables mail delivery for list addresses. The default is NOMAIL.

MAP_NAMES_SIZE

(Integer > 0) 

Specifies the size of the mapping table name table, and thus the total number of mapping table cannot exceed this number. The default is 32.

MAX_ALIAS_LEVELS (Integer)

Controls the degree of indirection allowed in aliases; that is, how deeply aliases may be nested, with one alias referring to another alias, and so forth. The default value is 10.

MAX_FILEINTOS (Integer)

Specifies the maximum number of files that may be specified by a mailbox filter’s fileinto operator.

Default: 10

MAX_FORWARDS (Integer)

Specifies the maximum number of forwarding addresses that may be specified by a mailbox filter’s forward operator. 

Default: 10

MAX_HEADER_BLOCK_USE

(Real Number Between 0 and 1) 

Controls what fraction of the available message blocks can be used by message headers. 

MAX_HEADER_LINE_USE

(Real Number Between0 and 1) 

Controls what fraction of the available message lines can be used by message headers. 

MAX_INTERNAL_BLOCKS (Integer)

Specifies how large (in MTA blocks) a message the MTA keeps entirely in memory; messages larger than this size is written to temporary files. The default is 30. For systems with lots of memory, increasing this value may provide a performance improvement.

MAX_LOCAL_RECEIVED_LINES (Integer)

As the MTA processes a message, it scans any Received: header lines attached to the message looking for references to the official local host name. (Any Received line that the MTA inserts contains this name.) If the number of Received lines containing this name exceeds the MAX_LOCAL_RECEIVED_LINES value, the message is entered in the MTA queue in a held state. The default for this value is 10 if no value is specified in the option file. This check blocks certain kinds of message forwarding loops. The message must be manually moved from the held state for processing to continue.

MAX_MIME_LEVELS (Integer)

Specify the maximum depth to which the MTA should process MIME messages. The default is 100, which means that the MTA processes up to 100 levels of message nesting.

MAX_MIME_PARTS (Integer)

Specify the maximum number of MIME parts that the MTA should process in a MIME message. 

MAX_MR_RECEIVED_LINES (Integer)

As the MTA processes a message, it counts the number of MR_Received: header lines in the message’s header. If the number of MR-Received: lines exceeds the MAX_MR_RECEIVED_LINES value, the message is entered into the MTA queue in a held state. The default value for this option is 20 if no value is specified in the Option File. This check blocks certain kinds of message forwarding loops. The message must be manually moved from the held state for processing to continue.

MAX_RECEIVED_LINES (Integer)

As the MTA processes a message, it counts the number of Received: header lines in the message's header. If the number of Received lines exceeds the MAX_RECEIVED_LINES value, the message is entered in the MTA queue in a held state. The default for this value is 50 if no value is specified in the option file. This check blocks certain kinds of message forwarding loops. The message must be manually moved from the held state for processing to continue.

MESSAGE_HASH_ALGORITHM

Specifies the hash algorithm. Possible values are md2, md4, md5, sha1, md128(for RIPE-MD128), or md160 (for RIPE-MD160).

Default: md5 

MESSAGE_HASH_FIELDS

Comma separated list of fields from the header to hash (in order). Any known header field can be specified. If this option is not specified it defaults to "message-id,from,to,cc,bcc, resent-message-id,resent-from,resent-to,resent-cc,resent-bcc, subject,content-id,content-type,content-description". 

MISSING_RECIPIENT_GROUP_TEXT

Configures the text string returned by the MTA. The value must conform to the requirements of SMTP error response text. In particular, it is constrained to be in the US-ASCII character set. The MTA will convert any eight bit characters in such option values into the dollar character ($).

Default: recipients not specified 

MISSING_RECIPIENT_POLICY (Integer)

Legalizes messages that lack any recipient headers. If set to 1, the MTA does nothing about illegal headers that do not contain a To:, Cc:, or Bcc: field. If set to 0, the MTA adds a To: field to the headers to make them legal.

Default: 0

MAX_SIEVE_LIST_SIZE (Integer)

Controls the number of strings that can appear in a list construct in MTA sieve scripts. The default is 64.

MAX_TOTAL_RECEIVED_LINES (Integer)

As the MTA processes a message, it counts the number of Received:, MR-Received:, and X400-Received: header lines in the message’s header. If the number of all such header lines exceeds the MAX_TOTAL_RECEIVED_LINES value, the message is entered into the MTA queue in a held state. The default value is 100 if no value is specified in the option file. This check blocks certain kinds of message forwarding loops. The message must be manually moved from the held state for processing to continue.

MAX_URLS (Integer)

Specifies the URL to query for address reversal. Standard LDAP URL syntax is used, except omitting the LDAP server and port which are instead specified via the LDAP_HOST and LDAP_PORT options.

MAX_X400_RECEIVED_LINES (Integer)

As the MTA processes a message, it counts the number of X400-Received: header lines in the message’s header. If the number of Received: lines exceeds the MAX_X400_RECEIVED_LINES value, the message is entered into the MTA queue in a held state. The default value for this option is 50 if no value is specified in the Option File. This check blocks certain kinds of message forwarding loops. The message must be manually moved from the held state for processing to continue.

NORMAL_BLOCK_LIMIT (Integer)

Used to instruct the MTA to downgrade the priority of messages based on size: messages above the specified size is downgraded to non-urgent priority. This priority, in turn, affects the processing priority of the message—how quickly the Job Controller processes the message. 

NON_URGENT_BLOCK_LIMIT (Integer)

Used to instruct the MTA to downgrade the priority of messages based on size: Messages above the specified size is downgraded to lower than nonurgent priority. The value is interpreted in terms of MTA blocks, as specified by the BLOCK_SIZE option. Note also that the nonurgentblocklimit channel keyword may be used to impose such downgrade thresholds on a per channel basis.

NOTARY_DECODE (-1, 0, or 1)

Specifies the decoding condition of encoded words. If set to 1, NOTARY_DECODE causes the subset of the original message headers that are added to the first part of a DSN by the %H substitution to be decoded and converted to match the charset of the first part. A value of 0 decodes the subset of encoded words in the header that matches the charset of the first part; no charset conversion is performed. A value of -1 disables decoding of encoded words unconditionally.

Caution should be used with a setting of 1, as information loss can occur and confusion can result when a rich charset like UTF-8 is converted to a limited charset like ISO-8859-1 or US-ASCII.

The default is 0.

OPTIN_USER_CARRYOVER (Integer)

Controls how the spam filtering optin list is carried from one user/alias entry to another when forwarding occurs. This is a bit-encoded value; the interpretation is as follows: 

Bit-0 Value-1: When set, each LDAP user entry overrides any previously active user/domain optins unconditionally. 

Bit-1 Value-2: When set, it overrides any previous user, domain, or alias optins that were active if a user’s domain has an optin attribute. 

Bit-2 Value-4: When set, it overrides any previous user, domain, or alias optins that were active, if a user has an optin attribute. 

Bit-3 Value-8: When set, an optin specified by an (optin) nonpositional parameter overrides any previous user, domain, or alias optins that were active. 

The value of this option defaults to 0. Optins will accumulate if one user has a delivery option that forwards to another user. The default ensures that site security policies will be effective when forwarding mail.

OR_CLAUSES (0 or 1)

Specifies mailing list access controls are OR’ed by default, instead of AND’ed. 

POST_DEBUG (0 or 1)

Specifies whether or not debugging output is produced by the MTA’s periodic delivery job. If enabled with a value of 1, this output is produced in the post.log file. The default value of 0 disables this output.

RECEIVED_DOMAIN (String)

Sets the domain name to use when constructing Received headers. By default, the official host name of the local channel is used.

RECEIVED_VERSION (String)

Sets the Sun Java System Messaging Server version string that is to be used when constructing Received: header lines. By default, the string “(Sun Java System Messaging Server version-info)” is used; use of the default is strongly recommended. Note that this option is a complement to the (also not recommended) CUSTOM_VERSION_STRING TCP/IP SMTP channel option.

In the above description, note the mention of constructing a Received: header line; that is, this option does not change already present Received: header lines, but rather only affects what is used when generating a new Received: header line. Also note that this option is option and the CUSTOM_VERSION_STRING option should not be used.

A non-ASCII string could be specified, but the MTA would then have to MIME encode the non-ASCII characters. Since user agent handling of MIME encoded header lines is not always useful, specifying a non-ASCII value would be inadvisable. So while the value is not strictly limited to being an ASCII string, it is not recommended to use anything other than ASCII. 

RETURN_ADDRESS (String)

Sets the return address for the local postmaster. The local postmaster's address is postmaster@localhost by default, but it can be overridden with the address of your choice. Care should be taken in the selection of this address—an illegal selection may cause rapid message looping and pileups of huge numbers of spurious error messages.

RETURN_DEBUG (0 or 1)

Enables or disables debugging output in the nightly message bouncer batch job. A value of 0 disables this output (the default), while a value of 1 enables it. Debugging output, if enabled, appears in the output log file, if such a log file is present. The presence of an output log file is controlled by the crontab entry for the return job.

RETURN_DELIVERY_HISTORY

(0 or 1) 

Controls whether or not a history of delivery attempts is included in returned messages. The delivery history provides some indication of how many delivery attempts were made and, in some cases, indicates the reason the delivery attempts failed. A value of 1 enables the inclusion of this information and is the default. A value of 0 disables return of delivery history information. The HISTORY_TO_RETURN option controls how much history information is actually returned.

RETURN_ENVELOPE (Integer)

Takes a single integer value, which is interpreted as a set of bit flags. Bit 0 (value = 1) controls whether return notifications generated by the MTA are written with a blank envelope address or with the address of the local postmaster. Setting the bit forces the use of the local postmaster address; clearing the bit forces the use of a blank addresses. Note that the use of blank address is mandated by RFC 1123. However, some systems do not handle blank-envelope-from-address properly and may require the use of this option. Bit 1 (value = 2) controls whether the MTA replaces all blank envelope addresses with the address of the local postmaster. Again, this is used to accommodate noncompliant systems that don't conform to RFC 821, RFC 822, or RFC 1123. Note that the returnenvelope channel keyword can be used to impose this sort of control on a per-channel basis.

RETURN_PERSONAL (String)

Specifies the personal name to use when the MTA generates postmaster messages (for example, bounce messages). By default, the MTA uses the string, Internet Mail Delivery.

RETURN_UNITS (0 or 1)

Controls the time units used by the message return system. A value of 0 selects units of days. A value of 1 selects units of hours. By default, units of days are used. Return job scheduling is controlled by the local.schedule.return_job configutil parameter.

REVERSE_ADDRESS_CACHE_SIZE

Specifies the maximum size of the address reversal cache. 

Default: 100000

REVERSE_ADDRESS_CACHE_TIMEOUT

Specifies the timeout, in seconds, for entries in the address reversal cache. 

Default: 600

REVERSE_DATA_SIZE

Sets the initial number of entries in the forward text database.  

The MTA stores the database template strings in string pool 3, so the STRING_POOL_SIZE_3 MTA option controls the initial allocation of space for this purpose.  

Note that these various options only control initial sizes. The various tables and arrays will resize automatically up to the maximum allowed size. The maximum string pool size 50Mb. Up to 2 million entries are allowed.  

REVERSE_ENVELOPE (0 or 1)

Controls whether the MTA applies the address reversal to envelope From addresses as well as header addresses. This option has no effect if the USE_REVERSE_DATABASE option is set to 0 or if the reverse database and reverse mapping does not exist. The default is 1, which means that the MTA attempts to apply the database to envelope From addresses. A value of 0 disables this use of the address reversal database.

REVERSE_URL (URL)

Specifies the URL to query for address reversal. Standard LDAP URL syntax is used, except omitting the LDAP server and port, which are instead specified using the LDAP_HOST and LDAP_PORT options. REVERSE_URL applicability is not controlled by any bit in USE_REVERSE_DATABASE.


Note –

Changing REVERSE_URL for any reason is discouraged.


ROUTE_TO_ROUTING_HOST (0 or 1)

Specifies (value set to 1) that the Messaging Server routes all addresses associated with the domain to the first host listed in the mailRoutingHosts attribute. A value of 0 indicates that a failure to match an existant mailRoutingHosts attribute against causes the domain to be treated as non-local; addresses are routed onward according to their rewrite rules. The default is 0.

SEPARATE_CONNECTION_LOG

(0 or 1) 

Controls whether the connection log information generated by setting LOG_CONNECTION =1 is stored in the usual the MTA message logging files, mail.log* or is stored separately in connection.log* files. The default (0) causes connection logging to be stored in the regular message log files; 1 causes the connection logging to be stored separately.

SIEVE_USER_CARRYOVER (0 or 1)

Controls how user sieves are combined when forwarding occurs. This is a bit-encoded value; the interpretation is as follows: 

Bit-0 Value-1: When set, user-to-user forwarding cancels the domain and user scripts associated with the original user entry. 

The value of this option defaults to 0.

Using this option is not recommended, because it prevents a user from filtering mail prior to it being forwarded. 

SNDOPR_PRIORITY (Integer)

Sets the syslog level of syslog messages or the severity of the Windows NT event log entry. 

For syslog, this option corresponds to the priority argument of the syslog call. Both the facility and severity can be set by applying a logical OR operation to the desired values. On Solaris, see /usr/include/sys/syslog.h for a definition of valid values. Be sure to coordinate setting the SNDOPR_PRIORITY option with how syslog messages are handled, as controlled by the syslog.conf file.

The default for UNIX is 5; the default for Windows NT is 1.

SPAMFILTERn_OPTIONAL

Controls whether certain failures reported by the filtering library X are treated as a temporary processing failure or ignored. The default value of 0 specifies that spam filtering problems cause a temporary processing failure. Changing the value to 1 causes spam filter processing to be skipped in the event of some, but possibly not all, filtering library failures. In particular, if the system gets stuck without a return in the library code, some portion of the MTA may also get stuck. -2 and 2 can also be set. The are the same as 0 and 1 respectively except that they also cause a syslog message to be sent in the event of a problem reported by the spam filter plugin. A value of 3 causes spam filter failures to accept the message but queue it to the reprocess channel for later processing. A value of 4 does the same thing but also logs the spam filter temporary failure to syslog.

Default: 0

SPAMFILTERX_ACTION_N

See SPAMFILTERX_VERDICT_N.

Default: none 

SPAMFILTERX_CONFIG_FILE

Specifies the full file path and name of the filtering software X configuration file.

Default: none 

SPAMFILTERX_FINAL

 

Some filtering libraries have the ability to perform a set of actions based on recipient addresses. What sort of recipient address is passed to the filtering library depends on the setting of the SPAMFILTERX_FINAL MTA option. The default value of 0 results in a so-called intermediate address being passed to the filtering library. This address is suitable for use in delivery status notifications and for directory lookups. If bit 0 (value 1) of SPAMFILTERX_FINAL is set, however, the final form of the recipient address is passed. This form may not be suitable for presentation but is more appropriate for subsequent forwarding operations.

The SPAMFILTERX_FINAL option is only available in Messaging Server 6.0 and later; Messaging Server 5.2 behaves as if the option had the default value of 0.

In 6.2 and later bit 1 (value 2) of SPAMFILTERX_FINAL controls whether or not source routes are stripped from the address that's passed to the filtering interface. Setting the bit enables source route stripping.

Default: 0

SPAMFILTERX_LIBRARY

Specifies the full file path and name of the filtering software X shared library.

Default: none 

SPAMFILTERX_NULL_OPTIN

Specifies a string which, if found, as a value of the attribute defined by LDAP_optinX or LDAP_domain_attr_optinX, causes the MTA to act as if the attribute wasn't there. That is, it disables filtering for that entry. See Specifying the Messages to Be Filtered in Sun Java System Messaging Server 6.3 Administration Guide

Default: The empty string. Empty optin attributes are ignored by default. (This is a change from Messaging Server 5.2, where empty optin attributes triggered filtering with an empty optin list. The 5.2 behavior can be restored by setting spamfilterX_null_optin to a string that never occurs in practice.)

SPAMFILTERX_STRING_ACTION

Defines Sieve rule specifying what to do with the message if the verdict is a string. Sieve expressions can be stored externally using a file URL. For example: file:///var/opt/SUNWmsgsr/config/null_action.sieve. Also, do not reject spam using the Sieve reject action, as it tends to deliver a nondelivery notification to the innocent party whose server was used to send the spam.

Default: data:,require "fileinto"; fileinto "$U;

where $U is the string that verdict returned.

SPAMFILTERX_VERDICT_N

The options spamfilterX_verdict_n and spamfilterX_action_n are matched pairs, where n is a number from 0 to 9. These options allow you to specify Sieve filters for arbitrary verdict strings. This is done by setting spamfilterX_verdict_nand spamfilterX_action_n to the verdict string and sieve filter, respectively, where n is an integer from 0 to 9. For example, a site could have the "reject" verdict cause a sieve reject action by specifying:


spamfilter1_verdict_0=reject
spamfilter1_action_0=data:,require "reject";
reject "Rejected by spam filter";

STRICT_REQUIRE (0 or 1)

Enforces strict Sieve compliance for location of require clauses. The default is 0.

STRING_POOL_SIZE

(Integer <= 10,000,000) 

Controls the number of character slots allocated to the string pool used to hold rewrite rule templates and alias list members. A fatal error occurs if the total number of characters consumed by these parts of the configuration and alias files exceeds this limit. The default is 60,000; the maximum allowed value is 10,000,000.

STRING_POOL_SIZE_3

Controls the initial allocation of space for template strings for the general, forward, and reverse text databases. 

UNIQUE_ID_TEMPLATE

Specifies a template used to convert an address into a unique identifier. The template's substitution vocabulary is the same as that for delivery options. The resulting unique identifier is intended for use by message archiving tools. 

URGENT_BLOCK_LIMIT (Integer)

Used to instruct the MTA to downgrade the priority of messages based on size: messages above the specified size are downgraded to normal priority. This priority, in turn, affects the Job Controller’s processing priority for processing the message. The value is interpreted in terms of the MTA blocks, as specified by the BLOCK_SIZE option. Note also that the urgentblocklimit channel keyword may be used to impose such downgrade thresholds on a per-channel basis.

URL_RESULT_CACHE_SIZE

Specifies the cache size of URL results from lookups done in rewrite rules and mappings. Default: 10000 entries

URL_RESULT_CACHE_TIMEOUT

Specifies the timeout period for rewrite rules and mapping URL lookups. Default: 600 seconds

USE_ALIAS_DATABASE (0 or 1)

Controls whether the MTA uses the alias database as a source of system aliases for local addresses. The default (1), means that the MTA checks the database if it exists. A value of 0 disables this use of the alias database.

USE_CANONICAL_RETURN (Integer)

This option is bit-encoded with the various bits matching those of the USE_ORIG_RETURN option. Each place where the MTA performs a comparison operation against the envelope from (MAIL FROM) address has an assigned bit. If the bit in USE_CANONICAL_RETURNis clear, normal rewriting is applied to the envelope from address prior to use. In particular rewriting from mailAlternateAddress attributes to mail attributes will be performed; mailEqvuialentAddress attributes will not be rewritten to the corresponding mail attribute. If, however, the bit is set, the corresponding address will be rewritten if it appears in a mailEquivalentAddress attribute. It should be noted that the bit USE_ORIG_RETURN will, if set, disable rewriting entirely. So setting a bit in USE_ORIG_RETURN renders the corresponding bit in USE_CANONICAL_RETURN useless.

The value is a decimal integer representing a bit-encoded integer, the interpretation of which is given in Table Table 4–19

USE_DOMAIN_DATABASE (0 or 1)

Controls the use of the domain database. The default (1) means that the MTA checks the database if it exists.

USE_FORWARD_DATABASE (Integer)

Control use of the forward database. 

The value is a decimal integer representing a bit-encoded integer, the interpretation of which is given below: 

Bit–0 (Value=1) When set, the Forward Database is used. Bit-0 (Value=1) is the least significant bit. The default value for the USE_FORWARD_DATABASE is 0 which means the Forward Database is not used at all. Note that a Forward Mapping, if present, is always consulted.

Bit-3 (Value=8) When set, channel-level granularity is used with the forward database entries. The forward database entries' left hand side must have the form (note the | vertical bars): 

source-channel|from-address|to-address

Bit-4 (Value=16) When set, channel-level granularity is used with FORWARD mapping. FORWARD mapping entries' patterns (left hand sides) must have the form (note the | vertical bars); 

source-channel|from-address|to-address

USE_ORIG_RETURN (Integer)

Controls the bit-encoded field. 

The value is a decimal integer representing a bit-encoded integer, the interpretation of which is given in Table Table 4–19.

USE_PERMANENT_ERROR (0-4)

Controls whether or not certain errors returned by the MTA are marked as temporary or permanent. Each bit in this option corresponds to a specific error condition. When set, this option instructs the MTA to return a permanent error. The value is a decimal integer representing a bit-encoded integer, the interpretation of which is given in Table 4–18. The default value is 0.

USE_PERSONAL_ALIASES (0 or 1)

Controls whether or not the MTA makes use of personal alias databases as a source of aliases for local addresses. The default is 1, which means that the MTA checks such databases, if they exist. A value of 0 disables personal aliases and makes them unavailable to all users.

USE_REVERSE_DATABASE (0-31)

Controls whether the MTA uses the address reversal database and REVERSE mapping as a source of substitution addresses. This value is a decimal integer representing a bit-encoded integer, the interpretation of which is given in Table 4–20.

Note that bit 0 is the least significant bit. 

The default value for USE_REVERSE_DATABASE is 5, which means that the MTA reverse envelope From addresses and both backward and forward pointing addresses after they have passed through the normal address rewriting process. Simple address strings are presented to both REVERSE mapping and the reverse database. A value of 0 disables the use of the address reversal completely.

USE_TEXT_DATABASES

Stores information that previously would have gone in the general, forward, and reverse databases in the compiled configuration. This option is bit encoded. If bit 0 (value 1) is set, the file IMTA_TABLE:general.txt is read as the MTA configuration is initialized and the information from that file replaces all uses of the general database. If bit 1 (value 2) is set, the file IMTA_TABLE:reverse.txt is read and used instead of the reverse database.If bit 2 (value 4) is set, the file IMTA_TABLE:forward.txt is read and used instead of the forward database. The default value for this option is 0, which disables all use of text databases. Note that use of the text database option means that changes to the underlying files will only be seen after issuing the imsimta cnbuild and imtsimta reload commands.

WILD_POOL_SIZE (integer)

Controls the total number of patterns that appear throughout mapping tables. the default is 8000. The maximum allowed is 200,000.

Table 4–17 DOMAIN_UPLEVEL Bit Values

Bit  

Value  

Usage  

If clear, only look up the domain that is actually specified in an address. If set, look up not only that domain but every superior domain. For example, if the bit is clear and the domain is host1.siroe.com, only host1.siroe.com is looked up. If the bit is set host1.siroe.com will be looked up, if that fails siroe.com, and if that fails com.

Controls how filters are constructed for address searches in the directory. If the bit is clear, only the originally supplied address is searched for. If it is set, both the original supplied address and an address built using the domain that was found in the directory are searched for. 

Controls which domain is used in checks against service.defaultdomain to determine whether or not the domain is the default domain or a hosted domain. If the bit is set, the domain extracted from the address that matched a domain entry is used. If the bit is clear the canonical domain from the domain entry that matched is used.

Checks the address with an upleveled/canonicalized domain name against the mailEqvuialentAddress during address reversal. A match disables rewriting the address to the value of the mail attribute.

16 

Control whether address reversal rewriting is skipped if the address is a mailEquivalentAddress (bit clear) or performed only if the address is a mailAlternateAddress (bit set)

Table 4–18 USE_PERMANENT_ERROR Bit Values

Bit  

Value  

Error  

Mailbox is temporarily disabled (inactive). 

Group is temporarily disabled (inactive). 

User is over quota; cannot receive new mail. 

Various alias expansion errors. 

16 

too many recipients specified 

Table 4–19 USE_CANONICAL_RETURN and USE_ORIG_RETURN Bit Values

Bit 

Value 

Usage 

When set, use the original envelope From: address in ORIG_SEND_ACCESS mapping table probes.

When set, use the original envelope From: address in SEND_ACCESS mapping table probes.

When set, use the original envelope From: address in ORIG_MAIL_ACCESS mapping table probes.

When set, use the original envelope From: address in MAIL_ACCESS mapping table probes.

16 

When set, use the original envelope From: address in mailing list [AUTH_LIST], [MODERATOR_LIST], [SASL_AUTH_LIST], and [SASL_MODERATOR_LIST] checks.

32 

When set, use the original envelope From: address in mailing list [CANT_LIST] and [SASL_CANT_LIST] checks.

64 

When set, use the original envelope From: address in mailing list [AUTH_MAPPING], [MODERATOR_MAPPING], [SASL_AUTH_MAPPING], and [SASL_MODERATOR_MAPPING] checks.

128 

When set, use the original envelope From: address in mailing list [CANT_MAPPING] and [SASL_CANT_MAPPING] checks.

256 

When set, use the original envelope From: address in mailing list [ORIGINATOR_REPLY] comparisons.

512 

When set, use the original envelope From: address in mailing list [DEFERRED_LIST], [DIRECT_LIST], [HOLD_LIST], and [NOHOLD_LIST] checks.

10 

1024 

When set, use the original envelope From: address in mailing list [DEFERRED_MAPPING], [DIRECT_MAPPING], [HOLD_MAPPINGS], and [NOHOLD_MAPPING] checks.

11 

2048 

When set, use the original envelope From: address in mailing list checks for whether the sender is the list moderator. 

12 

4096 

When set, use the original envelope From: address in mailing list LDAP_AUTH_DOMAIN LDAP attribute (e.g., mgrpAllowedDomain) checks.

13 

8192 

When set, use the original envelope From: address in mailing list LDAP_CANT_DOMAIN LDAP attribute (e.g., mgrpDisallowedDomain) checks

14 

16384 

When set, use the original envelope From: address in mailing list LDAP_AUTH_URL LDAP attribute (e.g., mgrpAllowedBroadcaster) checks.

15 

32768 

When set, use the original envelope From: address in mailing list LDAP_CANT_URL LDAP attribute (e.g., mgrpDisallowedBroadcaster) checks.

16 

65536 

Obsolete. In Messaging Server 5.0 and 5.1, when set, used the original envelope From: address in mailing list LDAP_MODERATOR_RFC822 comparisons. As of Messaging Server 5.2 there is no longer any such global MTA option nor need for such an attribute (since the LDAP_MODERATOR_URL attribute value can, in fact, specify a mailto: URL pointing to an RFC 822 address), this bit no longer has any meaning.

17 

131072 

When set, use the original envelope From: address in mailing list LDAP_MODERATOR_URL LDAP attribute (e.g., mgrpModerator) comparisons.

18 

262144 

When set, use the original envelope From: address in any source-specific FORWARD mapping tables probes. 

19 

524288 

When set, use the original envelope From: address in any source-specific FORWARD database probes. 

Table 4–20 UUSE_REVERSE_DATABASE Bit Values

Bit  

Value  

Usage  

When set, address reversal is applied to addresses after they have been rewritten by the MTA address rewriting process. 

When set, address reversal is applied before addresses have had the MTA address rewriting applied to them. 

When set, address reversal is applied to all addresses, not just to backward pointing addresses. 

When set, channel-level granularity is used with REVERSE mapping. REVERSE mapping table (pattern) entries must have the form (note the vertical bars [|]).

source-channel|destination-channel|address

16 

When set, channel-level granularity is used with address reversal database entries. Reversal database entries must have the form (note the vertical bars [|]).

source-channel|destination-channel|address

Table 4–21 LDAP_USE_ASYNC Bit Values

Bit  

Value  

Specific Use of LDAP  

LDAP_GROUP_URL1 (mgrpDeliverTo) URLs

LDAP_GROUP_URL2 (memberURL) URLs

LDAP_GROUP_DN (UniqueMember) DNs

auth_list, moderator_list, sasl_auth_list, and sasl_moderator_list nonpositional list parameter URLs

16 

cant_list, sasl_cant_list nonpositional list parameter URLs

32 

originator_reply nonpositional list parameter URLs

64 

deferred_list, direct_list, hold_list, nohold_list nonpositional list parameter URLs

128 

username_auth_list, username_moderator_list, username_cant_list nonpositional list parameter URLs

256 

alias file list URLs 

512 

alias database list URLs 

10 

1024 

LDAP_CANT_URL (mgrpDisallowedBroadcaster) outer level URLs

11 

2048 

LDAP_CANT_URL inner level URLs

12 

4096 

LDAP_AUTH_URL (mgrpAllowedBroadcaster) outer level URLs

13 

8192 

LDAP_AUTH_URL inner level URLs

14 

16384 

LDAP_MODERATOR_URL (mgrpModerator) URLs