Sun Java System Messaging Server 6 2005Q4 Administration Guide

Channel Keywords Categorized by Function

The following tables are categorized lists of keywords. The tables and categories are as follows:

Table 12–2 Address Handling Keywords

Keyword 

Page 

Definition 

Address Handling 

733 

Use % routing in the envelope; synonymous with percents. Address Types and Conventions

822 

Address Types and Conventions

Use source routes in the envelope; same as sourceroute.

addreturnpath 

Generating of Return-path Header Lines

Add Return-path: header to messages enqueued to this channel.

aliaslocal 

Specifying Alias File and Alias Database Probes

Look up rewritten addresses in the alias file and alias database. 

authrewrite 

TCP/IP Connection and DNS Lookup Support

Used on a source channel to have the MTA propagate authenticated originator information, if available, into the headers. 

bangoverpercent 

Adding Routing Information in Addresses

Group A!B%C as A!(B%C) 

bangstyle 

Address Types and Conventions

Use UUCP ! routing in the envelope; synonymous with uucp.

defaulthost 

Specifying a Host Name to Use When Correcting Incomplete Addresses

Specify a domain name to use to complete addresses 

dequeue_removeroute 

Removing Source Routes

Removes source routes from envelope To: addresses.

exproute 

Adding Routing Information in Addresses

Require explicit routing when addresses passed to remote systems. 

holdlimit 

Expansion of Multiple Addresses

Hold message when number of envelope recipient addresses exceeds this limit. 

improute 

Adding Routing Information in Addresses

Implicit routing for this channel’s addresses 

missingrecipientpolicy 

Legalizing Messages Without Recipient Header Lines

Set policy for how to legalize (which header to add) messages that are lacking any recipient headers. 

noaddreturnpath 

Generating of Return-path Header Lines

Do not add Return-path: header when enqueuing message.

nobangoverpercent 

Adding Routing Information in Addresses

Group A!B%C as (A!B)%C 

nodefaulthost 

Specifying a Host Name to Use When Correcting Incomplete Addresses

Do not specify a domain name to use to complete addresses 

noexproute 

Adding Routing Information in Addresses

No explicit routing for this channel’s addresses 

noimproute 

Adding Routing Information in Addresses

No implicit routing for this channel’s addresses 

noreceivedfrom 

Constructing Received Header Lines from Envelope To and From Addresses

Construct Received: header lines without including the original envelope From: address.

noremotehost 

Specifying a Host Name to Use When Correcting Incomplete Addresses

Use local host’s domain name as the default domain name to complete addresses 

norestricted 

Enabling Restricted Mailbox Encoding

Same as unsrestricted.

noreverse 

Enabling Channel-Specific Use of the Reverse Database

Exempts addresses in messages from address reversal processing 

norules 

Enabling Channel-specific Rewrite Rules Checks

Do not enforce channel-specific rewrite rule checks for this channel. 

percentonly 

Adding Routing Information in Addresses

Ignores bang paths. Use % routing in the envelope. 

percents 

Address Types and Conventions

Use % routing in the envelope; synonymous with 733.

remotehost 

Specifying a Host Name to Use When Correcting Incomplete Addresses

Use remote host’s name as the default domain name to complete addresses 

restricted 

Enabling Restricted Mailbox Encoding

The channel connects to mail systems that require encoding. 

reverse 

Enabling Channel-Specific Use of the Reverse Database

Checked addresses against address reversal database or REVERSE mapping 

routelocal 

Disabling Rewriting of Explicit Routing Addresses

Causes the MTA, when rewriting an address to the channel, to attempt to “short circuit” any explicit routing in the address. 

rules 

Enabling Channel-specific Rewrite Rules Checks

Enforce channel-specific rewrite rule checks for this channel. 

sourceroute 

Address Types and Conventions

Synonymous with 822.

subaddressexact 

Subaddress Handling

Perform no special subaddress handling during entry matching; the entire mailbox, including the subaddress, must match an entry in order for the alias to be considered to match. 

subaddressrelaxed 

Subaddress Handling

After looking for an exact match and then a match of the form name+*, the MTA should make one additional check for a match on just the name portion. 

subaddresswild 

Subaddress Handling

After looking for an exact match including the entire subaddress, the MTA should next look for an entry of the form name+*. 

unrestricted 

Enabling Restricted Mailbox Encoding

Tells the MTA not to perform RFC 1137 encoding and decoding. 

uucp 

Address Types and Conventions

Use UUCP! routing in the envelope; synonymous with bangstyle. 

viaaliasoptional 

Specifying Address Must be from an Alias

Final recipient addresses that match the channel are not required to be produced by an alias. 

viaaliasrequired 

Specifying Address Must be from an Alias

Final recipient address that matches the channel must be produced by an alias. 

Table 12–3 Attachments and MIME Processing

Keyword 

Definition 

defragment 

Automatic Defragmentation of Message/Partial Messages

Partial messages queued to the channel are placed in the defragmentation channel queue instead. 

ignoreencoding 

Ignoring the Encoding Header Line

Ignore Encoding: header on incoming messages.

interpretencoding 

Ignoring the Encoding Header Line

Interpret Encoding: header on incoming messages, if the need arises.

nodefragment 

Automatic Defragmentation of Message/Partial Messages

Disables defragmention. 

Table 12–4 Character Sets and Eigth Bit Data

Keyword 

Definition 

charset7 

Character Set Labeling and Eight-Bit Data

Default character set to associate with 7-bit text messages 

charset8 

Character Set Labeling and Eight-Bit Data

Default character set to associate with 8-bit text messages 

charsetesc 

Character Set Labeling and Eight-Bit Data

Default character set to associate with 7-bit text containing the escape character 

eightbit 

Character Set Labeling and Eight-Bit Data

Channel supports eight-bit characters. 

eightnegotiate 

Character Set Labeling and Eight-Bit Data

Channel should negotiate use of eight-bit transmission if possible. 

eightstrict 

Character Set Labeling and Eight-Bit Data

Reject messages with headers that contain unnegotiated eight-bit data. 

sevenbit 

Character Set Labeling and Eight-Bit Data

Do not support 8-bit characters; 8-bit characters must be encoded. 

Table 12–5 File Creation in the MTA Queue Area

Keyword 

Page 

Definition 

addrsperfile 

Handling Mail Delivery to Over Quota Users

Limit on the maximum number of recipients that can be associated with a single message file in a channel queue 

expandchannel 

Expansion of Multiple Addresses

Specifies channel in which to perform deferred expansion due to application of expandlimit. 

expandlimit 

Expansion of Multiple Addresses

Processes an incoming message “off-line” when the number of addressees exceeds this limit. 

multiple 

Handling Mail Delivery to Over Quota Users

No limit on the number of recipients in a message file, however the SMTP channel defaults to 99. 

single 

Handling Mail Delivery to Over Quota Users

A separate copy of the message will be created for each destination address on the channel. 

single_sys 

Handling Mail Delivery to Over Quota Users

Create a single message copy for each destination system used. 

subdirs 

Spreading a Channel Message Queue Across Multiple Subdirectories

Specifies the number of subdirectories across which to spread messages for the channel queues. 

Table 12–6 Header Keywords

Keyword 

Definition 

authrewrite 

TCP/IP Connection and DNS Lookup Support

Used on a source channel to have the MTA propagate authenticated originator information, if available, into the headers. 

commentinc 

Handling Comments in Address Header Lines

Leave comments in message header lines intact. 

commentmap 

Handling Comments in Address Header Lines

Runs comment strings in message header lines through the COMMENT_STRINGS mapping table.

commentomit 

Handling Comments in Address Header Lines

Remove comments from message header lines. 

commentstrip 

Handling Comments in Address Header Lines

Remove problematic characters from comment fields in message header lines. 

commenttotal 

Handling Comments in Address Header Lines

Strip comments (material in parentheses) from all header lines, except Received: header lines. Not recommended. 

datefour 

Converting Date to Two- or Four-Digits

Expand all year fields to four digits. 

datetwo 

Converting Date to Two- or Four-Digits

Remove the leading two digits from four-digit dates. Provides compatibility with mail systems that require two digit dates; it should never be used for any other purpose. 

dayofweek 

Specifying Day of Week in Date

Retain day of the week information and adds this information to date and time headers if it is missing. 

defaulthost 

Specifying a Host Name to Use When Correcting Incomplete Addresses

Specify a domain name to use to complete addresses 

dropblank 

Stripping Illegal Blank Recipient Headers

Strip illegal blank headers from incoming messages. 

header_733 

Address Types and Conventions

Use % routing in the message header. 

header_822 

Address Types and Conventions

Use source routes in the message header. 

headerlabelalign 

Header Alignment and Folding

Controls the alignment point for message headers enqueued on this channel; it takes an integer-valued argument. 

headerlinelength 

Header Alignment and Folding

Controls the length of header lines enqueued on this channel. 

headerread 

Removing Selected Message Header Lines

Apply header trimming rules from an options file to the message headers upon message enqueue (use with caution) before the original message headers are processed. 

headertrim 

Removing Selected Message Header Lines

Applies header trimming rules from an options file to the message headers after the original message headers are processed. 

header_uucp 

Address Types and Conventions

Use ! routing in the header 

inner 

Rewriting Embedded Headers

Parse messages and rewrite inner headers. 

innertrim 

Removing Selected Message Header Lines

Apply header trimming rules from an options file to inner message headers (use with caution). 

language 

Setting Default Language in Headers

Specifies the default language in headers. 

maxheaderaddrs 

Automatic Splitting of Long Header Lines

Controls how many addresses can appear on a single line. 

maxheaderchars 

Automatic Splitting of Long Header Lines

Controls how many characters can appear on a single line. 

missingrecipientpolicy 

Legalizing Messages Without Recipient Header Lines

Set policy for how to legalize (which header to add) messages that are lacking any recipient headers. 

nodayofweek 

Specifying Day of Week in Date

Removes day of the week from date and time headers. Provides compatibility with mail systems that cannot process this information; it should never be used for any other purpose. 

nodefaulthost 

Specifying a Host Name to Use When Correcting Incomplete Addresses

Do not specify a domain name to use to complete addresses 

nodropblank 

Stripping Illegal Blank Recipient Headers

Do not strip illegal blank headers from incoming messages. 

noheaderread 

Removing Selected Message Header Lines

Do not apply header trimming rules from option file. 

noheadertrim 

Removing Selected Message Header Lines

Do not apply header trimming rules from options file. 

noinner 

Rewriting Embedded Headers

Do not to rewrite inner message header lines. 

noinnertrim 

Removing Selected Message Header Lines

Do not apply header trimming to inner message headers. 

noreceivedfor 

Constructing Received Header Lines from Envelope To and From Addresses

Construct Received: header lines without including any envelope recipient information.

noreceivedfrom 

Constructing Received Header Lines from Envelope To and From Addresses

Construct Received: header lines without including the original envelope From: address.

noremotehost 

Specifying a Host Name to Use When Correcting Incomplete Addresses

Use local host’s domain name as the default domain name to complete addresses 

noreverse 

Enabling Channel-Specific Use of the Reverse Database

Exempts addresses in messages queued to the channel from address reversal processing 

norules 

Enabling Channel-specific Rewrite Rules Checks

Do not enforce channel-specific rewrite rule checks for this channel. 

nox_env_to 

Generating/Removing X-Envelope-to Header Lines

Remove X-Envelope-to header lines.

personalinc 

Handling Personal Names in Address Header Lines

Leave personal name fields in message header lines intact. 

personalmap 

Handling Personal Names in Address Header Lines

Run personal names through PERSONAL_NAMES mapping table. 

personalomit 

Handling Personal Names in Address Header Lines

Remove personal name fields from message header lines. 

personalstrip 

Handling Personal Names in Address Header Lines

Strip problem characters from personal name fields in header lines. 

receivedfor 

Constructing Received Header Lines from Envelope To and From Addresses

If a message is addressed to just one envelope recipient, to include that envelope To: address in the Received: header line it constructs.

receivedfrom 

Constructing Received Header Lines from Envelope To and From Addresses

Include the original envelope From: address when constructing a Received: header line for an incoming message if the MTA has changed the envelope From: address.

remotehost 

Specifying a Host Name to Use When Correcting Incomplete Addresses

Use remote host’s name as the default domain name to complete addresses 

restricted 

Enabling Restricted Mailbox Encoding

Channel connects to mail systems that require this encoding. 

reverse 

Enabling Channel-Specific Use of the Reverse Database

Check addresses against address reversal database or REVERSE mapping 

rules 

Enabling Channel-specific Rewrite Rules Checks

Enforce channel-specific rewrite rule checks for this channel. 

sensitivitycompanyconfidential 

Sensitivity Checking

Companyconfidential is the upper sensitivity limit of messages accepted.

sensitivitynormal 

Sensitivity Checking

Normal is the upper sensitivity limit of messages accepted.

sensitivitypersonal 

Sensitivity Checking

Personal is the upper sensitivity limit of messages accepted.

sensitivityprivate 

Sensitivity Checking

Private is the upper sensitivity limit of messages accepted.

sourcecommentinc 

Handling Comments in Address Header Lines

Leave comments in incoming message header lines. 

sourcecommentmap 

Handling Comments in Address Header Lines

Runs comment strings in header lines through source channels. 

sourcecommentomit 

Handling Comments in Address Header Lines

Remove comments from incoming message header lines, for example, To:, From:, and Cc: headers. 

sourcecommentstrip 

Handling Comments in Address Header Lines

Remove problematic characters from comment field in incoming header lines. 

sourcecommenttotal 

Handling Comments in Address Header Lines

Strip comments (material in parentheses) in incoming messages. 

sourcepersonalinc 

Handling Personal Names in Address Header Lines

Leave personal names in incoming message header lines intact. 

sourcepersonalmap 

Handling Personal Names in Address Header Lines

Run personal names through source channels. 

sourcepersonalomit 

Handling Personal Names in Address Header Lines

Remove personal name fields from incoming message header lines. 

sourcepersonalstrip 

Handling Personal Names in Address Header Lines

Strip problematic characters from personal name fields in incoming message header lines. 

unrestricted 

Enabling Restricted Mailbox Encoding

Tells the MTA not to perform RFC 1137 encoding and decoding. 

x_env_to 

Generating/Removing X-Envelope-to Header Lines

Enables generation of X-Envelope-to header lines.

Table 12–7 Incoming Channel Matching and Switching Keywords

Keyword 

Definition 

allowswitchchannel 

Alternate Channels for Incoming Mail (Switch Channels)

Allows switching to this channel from a switchchannel channel

nosaslswitchchannel 

SMTP Authentication, SASL, and TLS

No switching to this channel upon successful SASL authentication 

noswitchchannel 

Alternate Channels for Incoming Mail (Switch Channels)

No channel switching should be done to or from the channel. 

switchchannel 

Alternate Channels for Incoming Mail (Switch Channels)

Switches from the server channel to the channel associated with the originating host. 

saslswitchchannel 

SMTP Authentication, SASL, and TLS

Cause incoming connections to be switched to a specified channel upon a client’s successful use of SASL. 

tlsswitchchannel 

Transport Layer Security

Switches to another channel upon successful TLS negotiation. 

Table 12–8 Logging and Debugging Channel Keywords

Keyword 

Definition 

logging 

Logging Keywords

Log message enqueues and dequeues into the log file and activates logging for a particular channel. 

loopcheck 

Setting Loopcheck

Places a string into the SMTP EHLO response banner in order for the MTA to check if it is communicating with itself. 

master_debug 

Debugging Keywords

Create debugging output in the channel’s master program output. 

nologging 

Logging Keywords

Do not log message enqueues and dequeues into the log file. 

noloopcheck 

Setting Loopcheck

No string into the SMTP EHLO response banner. 

nomaster_debug 

Debugging Keywords

No debugging output in the channel’s master program output. 

noslave_debug 

Debugging Keywords

Do not generate slave debugging output. 

slave_debug 

Debugging Keywords

Generate slave debug output. 

Table 12–9 Long Address Lists or Headers Channel Keywords

Keyword 

Definition 

expandchannel 

Expansion of Multiple Addresses

Specifies channel in which to perform deferred expansion due to application of expandlimit. 

expandlimit 

Expansion of Multiple Addresses

Processes an incoming message “off-line” when the number of addressees exceeds this limit. 

holdlimit 

Expansion of Multiple Addresses

Holds a message when the number of addresses exceeds this limit. 

maxprocchars 

Header Alignment and Folding

Maximum length header that can be processed and rewritten. 

Table 12–10 Mailbox Filter Channel Keywords

Keyword 

Definition 

channelfilter 

Specifying Mailbox Filter File Location

Location of channel filter file; same as destinationfilter.

destinationfilter 

Location of channel filter file that applies to outgoing messages. 

destinationspamfilterXoptin 

Spam Filter Keywords

Run messages destined to this channel through spam filtering software X. 

fileinto 

Specifying Mailbox Filter File Location

Specify effect on address when a mailbox filter fileinto operation is applied.

filter 

Specifying Mailbox Filter File Location

Specify the location of user filter files. 

nochannelfilter 

Specifying Mailbox Filter File Location

No channel filtering for outgoing messages. Also known as nodestinationfilter.

nodestinationfilter 

Specifying Mailbox Filter File Location

Do not perform channel filtering for outgoing messages. 

nofileinto 

Specifying Mailbox Filter File Location

Mailbox filter fileinto operator has no effect. 

nofilter 

Specifying Mailbox Filter File Location

Do not perform user mailbox filtering. 

nosourcefilter 

Specifying Mailbox Filter File Location

Do not perform channel filtering for incoming messages. 

sourcefilter 

Specifying Mailbox Filter File Location

Specify the location of channel filter file for incoming messages. 

sourcespamfilterXoptin 

Spam Filter Keywords

Run messages originating from this channel through spam filtering software X. 

Table 12–11 NO-SOLICIT SMTP Extension Support Keywords

Keyword 

Definition 

sourcenosolicit 

NO-SOLICIT SMTP Extension Support

Specifies a comma-separated list of solicitation field values that will be blocked in mail submitted by this channel. 

destinationnosolicit 

NO-SOLICIT SMTP Extension Support

Specifies a comma-separated list of solicitation field values that will not be accepted in mail queued to this channel. 

Table 12–12 Notification and Postmaster Messages Keywords

Keyword 

Definition 

(See page Controlling Delivery Status Notification Messages for complete notification procedures)

aliaspostmaster 

Postmaster Returned Message Content

Messages addressed to the user name postmaster at the official channel name are redirected to postmaster@local-host, where local-host is the local host name (the name on the local channel). 

copysendpost 

Returned Failed Messages

Sends a copy of the failure notice to the postmaster unless the originator address on the failing message is blank. 

copywarnpost 

Warning Messages

Sends a copy of the warning message to the postmaster unless the originator address on the undelivered message is blank. 

errsendpost 

Returned Failed Messages

Sends a copy of the failure notice to the postmaster only when the notice cannot be returned to the originator. 

errwarnpost 

Warning Messages

Sends a copy of the warning message to the postmaster when the notice cannot be returned to the originator. 

includefinal 

To Include Altered Addresses in Status Notification Messages

Include final form of recipient address in delivery notifications. 

nonurgentnotices 

To Set Notification Message Delivery Intervals

Specifies the amount of time that may elapse before notices are sent and messages returned for messages of non-urgent priority. 

noreturnaddress 

Postmaster Returned Message Content

Use RETURN_ADDRESS option value as postmaster address name.

noreturnpersonal 

Postmaster Returned Message Content

Use RETURN_PERSONAL option value as postmaster personal name.

normalnotices 

To Set Notification Message Delivery Intervals

Specifies the amount of time that may elapse before notices are sent and messages returned for messages of normal priority. 

nosendpost 

Returned Failed Messages

Disables sending a copy of all failed messages to the postmaster. 

notices 

To Set Notification Message Delivery Intervals

Specifies the amount of time that may elapse before notices are sent and messages returned. 

nowarnpost 

Warning Messages

Disables sending a copy of warning messages to the postmaster. 

postheadbody 

Postmaster Returned Message Content

Returns both the headers and the contents of the message. 

postheadonly 

Postmaster Returned Message Content

Returns only headers to the postmaster. 

returnaddress 

Postmaster Returned Message Content

Specifies the return address for the local postmaster. 

returnenvelope 

Blank Envelope Return Addresses

Control use of blank envelope return addresses. 

returnpersonal 

Postmaster Returned Message Content

Set the personal name for the local postmaster. 

sendpost 

Returned Failed Messages

Enables sending a copy of all failed messages to the postmaster. 

suppressfinal 

To Include Altered Addresses in Status Notification Messages

Suppress the final address form from notification messages, if an original address form is present, from notification messages. 

urgentnotices 

To Set Notification Message Delivery Intervals

Specify the amount of time which may elapse before notices are sent and messages returned for messages of urgent priority. 

useintermediate 

To Include Altered Addresses in Status Notification Messages

Uses an intermediate form of the address produced after list expansion, but prior to user mailbox name generation. 

warnpost 

Warning Messages

Enables sending a copy of warning messages to the postmaster. 

Table 12–13 Processing Control and Job Submission Keywords

Keyword 

Definition 

(See Configuring Message Processing and Delivery for greater functional granularity)

backoff 

Specifying the Retry Frequency for Messages that Failed Delivery

Frequency of attempted redelivery of unsuccessfully delivered messages. Can be overridden by the keywords normalbackoff, nonurgentbackoff, urgentbackoff.

bidirectional 

Setting Channel Directionality

Channel served by a master and slave program. 

deferred 

Implementing Deferred Delivery Dates

Recognize and honor of the Deferred-delivery: header line.

expandchannel 

Expansion of Multiple Addresses

Specifies channel in which to perform deferred expansion due to application of expandlimit. 

expandlimit 

Expansion of Multiple Addresses

Processes an incoming message “off-line” when the number of addressees exceeds this limit. 

filesperjob 

Service Job Limits

Number of queue entries to be processed by a single job. 

immnonurgent

Implementing Deferred Delivery Dates

Starts delivery immediately after submission for urgent, normal, and non-urgent messages. 

master 

Setting Channel Directionality

Channel served by a master program (master).

maxjobs 

Service Job Limits

Maximum number of jobs that can be running concurrently for the channel. 

nodeferred 

Implementing Deferred Delivery Dates

Specifies that Deferred-delivery: header line not be honored.

nonurgentbackoff 

Specifying the Retry Frequency for Messages that Failed Delivery

The frequency for attempted redelivery of nonurgent messages. 

nonurgentblocklimit 

Message Priority Based on Size

Forces messages above this size to lower than nonurgent priority (second class priority), meaning that the messages will always wait for the next periodic job for further processing. 

normalbackoff 

Specifying the Retry Frequency for Messages that Failed Delivery

The frequency for attempted redelivery of normal messages. 

normalblocklimit 

Message Priority Based on Size

Forces messages above this size to nonurgent priority. 

noservice 

Enable Service Conversions

Service conversions for messages coming into this channel must be enabled via CHARSET-CONVERSION.

pool 

Processing Pools for Channel Execution Jobs

Specifies a pool for a channel. Must be followed by the pool name to which delivery jobs for the current channel should be pooled. 

service 

Enable Service Conversions

Unconditionally enables service conversions regardless of CHARSET-CONVERSION entry.

slave 

Setting Channel Directionality

Channel served by a slave program (slave). 

threaddepth 

SMTP Channel Threads

Number of messages triggering new thread with multithreaded SMTP client. 

transactionlimit 

Limits the number of messages allowed per connection. 

urgentbackoff 

Specifying the Retry Frequency for Messages that Failed Delivery

The frequency for attempted redelivery of urgent messages. 

urgentblocklimit 

Message Priority Based on Size

Forces messages above this size to normal priority. 

user 

Pipe Channel

Used on pipe channels to indicate under what user name to run. 

Table 12–14 Sensitivity Limit Keywords

Keyword 

Definition 

sensitivitycompanyconfidential 

Sensitivity Checking

Upper sensitivity limit of messages accepted. 

sensitivitynormal 

Sensitivity Checking

Normal is the upper sensitivity limit of messages accepted.

sensitivitypersonal 

Sensitivity Checking

Personal is the upper sensitivity limit of messages accepted.

sensitivityprivate 

Sensitivity Checking

Private is the upper sensitivity limit of messages accepted.

Table 12–15 Keywords for Limits on Messages, User Quotas, Privileges, and Authentication Attempts

Keyword 

Definition 

alternatechannel 

Retargeting Messages Exceeding Limit on Size or Recipients

Alternate destination channel for alternateblocklimit, alternatelinelimit, and alternaterecipientlimit 

alternateblocklimit 

Retargeting Messages Exceeding Limit on Size or Recipients

Specifies limit on the number of blocks in a message before it will be sent to alternativechannel. 

alternatelinelimit 

Retargeting Messages Exceeding Limit on Size or Recipients

Specifies limit on the number of lines in a message before it will be sent to alternativechannel. 

alternaterecipientlimit 

Retargeting Messages Exceeding Limit on Size or Recipients

Specifies limit on the number of recipients in a message before it will be sent to alternativechannel. 

blocklimit 

Specifying Absolute Message Size Limits

Maximum number of MTA blocks allowed per message. 

disconnectbadauthlimit 

Limits on Unsuccessful Authentication Attempts

Limit on the number of unsuccessful authentication attempts that will be allowed in a session before the session is disconnected. 

disconnectbadcommandlimit 

Setting Session Limits

Limits the number of session bad commands. 

disconnectrecipientlimit 

Setting Session Limits

Limits the number of session recipients. 

disconnectrejectlimit 

Setting Session Limits

Limits the number of rejected recipients. 

disconnecttransactionlimit 

Setting Session Limits

Limits the number of transactions. 

headerlimit 

Limiting Header Size

Limit on the maximum size of the primary (outermost) message header 

holdexquota 

Handling Mail Delivery to Over Quota Users

Hold messages for users that are over quota. 

holdlimit 

Expansion of Multiple Addresses

Holds an incoming message when the number of addresses exceeds this limit. 

linelength 

Imposing Message Line Length Restrictions

Limits the maximum permissible message line length on a channel-by-channel basis. 

linelimit 

Specifying Absolute Message Size Limits

Maximum number of lines allowed per message. 

maxblocks 

Automatic Fragmentation of Large Messages

Specifies the maximum number of blocks allowed in a message. 

maxlines 

Automatic Fragmentation of Large Messages

Specifies the maximum number of lines allowed in a message. 

nameparameterlengthlimit 

Controlling the Length of General and Filename Content-type and Content-disposition Parameters

Controls the points at which the name content-type and filename content-disposition parameters are truncated. 

noblocklimit 

Specifying Absolute Message Size Limits

No limit for the number of MTA blocks allowed per message. 

noexquota 

Handling Mail Delivery to Over Quota Users

Return to originator any messages to users who are over quota. 

nolinelimit 

Specifying Absolute Message Size Limits

No limit specified for the number of lines allowed per message. 

nonurgentblocklimit 

Message Priority Based on Size

Forces messages above this size to lower than nonurgent priority (second class priority), meaning that the messages will always wait for the next periodic job for further processing. 

normalblocklimit 

Message Priority Based on Size

Forces messages above this size to nonurgent priority. 

parameterlengthlimit 

Controlling the Length of General and Filename Content-type and Content-disposition Parameters

Controls the points at which general content-type and content-disposition parameters are truncated. 

recipientcutoff. 

Limiting Message Recipients

Rejects message if recipients exceed this value. 

recipientlimit 

Limiting Message Recipients

Limits the number of recipient addresses that will be accepted for the message. 

rejectsmtplonglines 

Handling SMTP Mail with Lines Exceeding 1000 Characters

Rejects messages that contain lines longer than 1000 characters (including CRLF). 

sourceblocklimit 

Specifying Absolute Message Size Limits

Maximum number of MTA blocks allowed per incoming message. 

truncatesmtplonglines 

Handling SMTP Mail with Lines Exceeding 1000 Characters

Truncate the line when it is over 1000 characters. 

wrapsmtplonglines 

Handling SMTP Mail with Lines Exceeding 1000 Characters

Wrap the line when it is over 1000 characters. 

urgentblocklimit 

Message Priority Based on Size

Forces messages above this size to normal priority. 

Table 12–16 SMTP Authentication, SASL and TLS Keywords

Keyword 

Definition 

(See SMTP Authentication, SASL, and TLS for greater functional granularity)

authrewrite 

TCP/IP Connection and DNS Lookup Support

Used on a source channel to have the MTA propagate authenticated originator information, if available, into the headers. 

maysaslserver 

SMTP Authentication, SASL, and TLS

Permit clients to attempt to use SASL authentication. 

maytls 

Transport Layer Security

Causes the MTA to offer TLS to incoming connections and to attempt TLS upon outgoing connections. 

maytlsclient 

Transport Layer Security

The MTA SMTP client will attempt TLS use when sending outgoing messages, if sending to an SMTP server that supports TLS. 

maytlsserver 

Transport Layer Security

The MTA SMTP server will advertise support for the STARTTLS extension and will allow TLS use when receiving messages. 

msexchange 

Specifying Microsoft Exchange Gateway Channels

Used on TCP/IP channels to tell the MTA that this is a channel that communicates with Microsoft Exchange gateways and clients. 

mustsaslserver 

SMTP Authentication, SASL, and TLS

SMTP server does not accept messages unless remote client successfully authenticates. 

musttls 

Transport Layer Security

Insist upon TLS in both outgoing and incoming connections. 

musttlsclient 

Transport Layer Security

The MTA SMTP client will insist on TLS use when sending outgoing messages (the MTA will issue the STARTTLS command and that command must succeed). 

musttlsserver 

Transport Layer Security

The MTA SMTP server will advertise support for the STARTTLS extension and will insist upon TLS use when receiving incoming messages. 

nomsexchange 

TCP/IP Connection and DNS Lookup Support

Default. 

nosasl 

SMTP Authentication, SASL, and TLS

SASL authentication is not permitted or attempted. 

nosaslserver 

SMTP Authentication, SASL, and TLS

SASL authentication is not permitted. 

notls 

Transport Layer Security

TLS will not be permitted or attempted. 

notlsclient 

Transport Layer Security

TLS use will not be attempted by the MTA SMTP client on outgoing connections (the STARTTLS command will not be issued during outgoing connections). 

notlsserver 

Transport Layer Security

TLS use will not be permitted by the MTA SMTP server on incoming connections (the STARTTLS extension will not be advertised by the SMTP server nor the command itself accepted). 

saslswitchchannel 

SMTP Authentication, SASL, and TLS

Cause incoming connections to be switched to a specified channel upon a client’s successful use of SASL. 

tlsswitchchannel 

Transport Layer Security

Cause incoming connections to be switched to a specified channel upon a client's successful TLS negotiation. It takes a required value, specifying the channel to which to switch. 

Table 12–17 SMTP Commands and Protocol Keywords

Keyword 

Definition 

(See SMTP Command and Protocol Support for greater functional granularity)

allowetrn 

ETRN Command Support

Honors ETRN commands. 

blocketrn 

ETRN Command Support

Blocks ETRN commands. 

checkehlo 

EHLO Command Support

Checks the SMTP response banner to determine whether to use EHLO or HELO. 

disableetrn 

ETRN Command Support

Disable support for the ETRN SMTP command. 

domainetrn 

ETRN Command Support

Honors only those ETRN commands that specify a domain. 

domainvrfy 

VRFY Command Support

Issues VRFY commands using a full address. 

ehlo 

EHLO Command Support

Uses the SMTP EHLO command on initial connections. 

eightbit 

Character Set Labeling and Eight-Bit Data

Channel supports eight-bit characters. 

eightnegotiate 

Character Set Labeling and Eight-Bit Data

Channel should negotiate use of eight-bit transmission if possible. 

eightstrict 

Character Set Labeling and Eight-Bit Data

Reject messages with headers that contain unnegotiated eight-bit data. 

expnallow 

EXPN Support

Allows EXPN even if it has been disabled at the SMTP server level with the DISABLE_EXPAND SMTP channel option.

expndisable 

EXPN Support

Disables EXPN unconditionally.

expndefault 

EXPN Support

Allows EXPN if the SMTP server is set to allow it.

localvrfy 

VRFY Command Support

Issues VRFY commands using a local address. 

mailfromdnsverify 

DNS Domain Verification

Verifies domain used on MAIL FROM: command exists in the DNS.

noehlo 

EHLO Command Support

Does not use the EHLO command. 

nomailfromdnsverify 

DNS Domain Verification

Does not verify that the domain used on the MAIL FROM: command exists in the DNS.

nosendetrn 

ETRN Command Support

Does not send ETRN commands. 

nosmtp 

Channel Protocol Selection and Line Terminators

Does not support the SMTP protocol. This is the default. 

novrfy 

VRFY Command Support

Does not issue VRFY commands. 

sendetrn 

ETRN Command Support

Sends ETRN commands. 

sevenbit 

Character Set Labeling and Eight-Bit Data

Do not support 8-bit characters; 8-bit characters must be encoded. 

silentetrn 

ETRN Command Support

Honors ETRN commands without echoing channel information. 

smtp 

Channel Protocol Selection and Line Terminators

Supports the SMTP protocol. The keyword smtp is mandatory for all SMTP channels. (This keyword is equivalent to smtp_crorlf.)

smtp_cr 

Channel Protocol Selection and Line Terminators

Accepts lines terminated with a carriage return (CR) without a following line feed (LF). 

smtp_crlf 

Channel Protocol Selection and Line Terminators

Lines must be terminated with a carriage return (CR) line feed (LF) sequence. 

smtp_crorlf 

Channel Protocol Selection and Line Terminators

Lines may be terminated with any of a carriage return (CR), or a line feed (LF) sequence, or a full CRLF. 

smtp_lf 

Channel Protocol Selection and Line Terminators

Accepts lines terminated with linefeed (LF) without preceding CR. 

streaming 

Protocol Streaming

Controls the degree of protocol streaming used in the protocol associated with a channel. 

vrfyallow 

VRFY Command Support

Provides informative responses to VRFY commands. 

vrfydefault 

VRFY Command Support

Provides default responses to VRFY command, according to channel’s HIDE_VERIFY option setting. 

vrfyhide 

VRFY Command Support

Provides obfuscatory responses to SMTP VRFY command. 

Table 12–18 TCP/IP Connection and DNS Lookup Support Keywords

Keyword 

Definition 

TCP/IP Connection and DNS Lookup Support 

(See TCP/IP Connection and DNS Lookup Support for greater functional granularity)

cacheeverything 

Caching for Channel Connection Information

Caches all connection information. 

cachefailures 

Caching for Channel Connection Information

Caches only connection failure information. 

cachesuccesses 

Caching for Channel Connection Information

Caches only connection success information. 

connectalias 

Address Rewriting Upon Message Dequeue

Deliver to whatever host is listed in the recipient address. 

connectcanonical 

Address Rewriting Upon Message Dequeue

Connect to the host alias for the system to which the MTA would be connected. 

daemon 

Target Host Choice

Connects to a specific host system regardless of the envelope address. 

defaultmx 

TCP/IP MX Record Support

Channel determines whether to do MX lookups from network. 

defaultnameservers 

Nameserver Lookups

Consults TCP/IP stack’s choice of nameservers. 

forwardcheckdelete 

Reverse DNS Lookups

If reverse DNS lookup performed, next performs a forward lookup on the returned name to check that the returned IP number matches the original; if not, deletes the name and use the IP address. 

forwardchecknone 

Reverse DNS Lookups

Does not perform a forward lookup after a DNS reverse lookup. 

forwardchecktag 

Reverse DNS Lookups

If a reverse DNS lookup has been performed, next performs a forward lookup on the returned name to check that the returned IP number matches the original; if not, tags the name with *. 

identnone 

IDENT Lookups

No perform IDENT lookups; performs IP to hostname translation; includes both hostname and IP address in Received: header.

identnonelimited 

IDENT Lookups

No IDENT lookups; does perform IP to hostname translation, but does not use the hostname during channel switching; includes both hostname and IP address in Received: header.

identnonenumeric 

IDENT Lookups

Does not perform IDENT lookups or IP to hostname translation. 

identnonesymbolic 

IDENT Lookups

Does not perform IDENT lookups; does perform IP to hostname translation; includes only the hostname in Received: header.

identtcp 

IDENT Lookups

Performs IDENT lookups on incoming SMTP connections and IP to hostname translation; include both hostname and IP address in Received: header

identtcplimited 

IDENT Lookups

Performs IDENT lookups on incoming SMTP connections and IP to hostname translation, but do not use the hostname during channel switching. Include hostname and IP address in Received: header.

indenttcpnumeric 

IDENT Lookups

Performs IDENT lookups on incoming SMTP connections, but does not perform IP to hostname translation. 

identtcpsymbolic 

IDENT Lookups

Performs IDENT lookups on incoming SMTP connections and IP to hostname translation; includes only hostname in Received: header.

interfaceaddress 

TCP/IP Port Number and Interface Address

Binds to the specified TCP/IP interface address. 

lastresort 

Last Resort Host

Specifies a last resort host. 

mailfromdnsverify 

DNS Domain Verification

Verifies that the domain used on the MAIL FROM: command exists in the DNS.

mx 

TCP/IP MX Record Support

TCP/IP network and software supports MX records lookup. 

nameservers 

Nameserver Lookups

Specifies a list of nameservers to consult rather than consulting the TCP/IP stack's own choice of nameservers; nameservers requires a space separated list of IP addresses for the nameservers.

nocache 

Caching for Channel Connection Information

Does not cache any connection information. 

nomailfromdnsverify 

DNS Domain Verification

Does not verify that the domain used on the MAIL FROM: command exists in the DNS.

nomx 

TCP/IP MX Record Support

TCP/IP network does not support MX lookups. 

nonrandomemx 

TCP/IP MX Record Support

Does MX lookups; does not randomize returned entries with equal precedence. 

port 

TCP/IP Port Number and Interface Address

Specifies the default port number for SMTP connections. The standard port is 25. 

randommx 

TCP/IP MX Record Support

Does MX lookups; randomizes returned entries with equal precedence. 

single 

Target Host Choice

Specifies that a separate copy of the message should be created for each destination address on the channel. 

single_sys 

Target Host Choice

Creates single copy of message for each destination system used. 

threaddepth 

SMTP Channel Threads

Number of messages triggering new thread with multithreaded SMTP client. 

Table 12–19 Miscellaneous Keywords

Keyword 

Definition 

deferralrejectlimit 

Setting Limits on Bad RCPT TO Addresses

Sets limit on the number of bad RCPT TO: addresses 

dispositionchannel 

Process Channel Overrides

Overrides the process channel as the place to initially queue delivery status notifications (DSNs). 

destinationfilter 

Specifying Mailbox Filter File Location

Used on general MTA channels to specify a channel-level filter to apply to outgoing messages. 

filter 

Specifying Mailbox Filter File Location

Takes a required URL argument describing the filter file location 

nodestinationfilter 

Specifying Mailbox Filter File Location

No channel mailbox filter is enabled for either direction of the channel. 

nosourcefilter 

Specifying Mailbox Filter File Location

No channel mailbox filter is enabled for source channel. 

nofilter 

Specifying Mailbox Filter File Location

The default and means that a user mailbox filters are not enabled for the channel. 

notificationchannel 

Process Channel Overrides

Overrides the process channel as the place to initially queue message disposition notifications (MDNs). 

sourcefilter 

Specifying Mailbox Filter File Location

Used on general MTA channels to specify a channel-level filter to apply to incoming messages 

submit 

Channel Operation Type

Used to mark a channel as a submit-only channel. 

user 

Pipe Channel

Used on pipe channels to indicate under what user name to run.