Conversion entry parameters

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


The rule parameters currently provided are shown listed by functional groups in Available conversion parameters.

Parameters not listed in this table (below) are ignored.

Available conversion parameters, grouped by functionality
Parameter Meaning
Command parameters
CALL Routine to call. The argument takes the form image|routine|argument.
COMMAND Command to execute to perform conversion. This parameter (or a CALL or DELETE parameter) is normally required; if no command is specified, the entry is ignored during conversion channel processing.1
DELETE 0 or 1. If this flag is set, the message part will be deleted. (If this is the only part in a message, then a single empty text part will be substituted.)
RELABEL 0 or 1. This flag causes an entry to be ignored during conversion channel processing. However, if this flag is 1, then MIME header relabelling is performed during character set conversion.3
SERVICE-CALL Routine to call to perform service conversion. The argument takes the form image|routine|argument. Note that this flag causes an entry to be ignored during conversion channel processing; SERVICE-CALL entries are instead performed during character set conversion processing.2
SERVICE-COMMAND The command to execute to perform service conversion. This parameter (or SERVICE-CALL) is required in order to perform a service conversion; if no command (or call) is specified, the entry is ignored for that phase of processing. Note that this flag causes an entry to be ignored during conversion channel processing; SERVICE-COMMAND entries are instead performed during character set conversion processing.2
Matching parameters
ATTACHMENT-NUMBER Sequential number of the part, starting at number 0 for the first part of the message. Compare with PART-NUMBER, which is the MIME structured number for the part.
IN-A1-FORMAT Input A1-Format: value from the enclosing message/rfc822 part.
IN-A1-TYPE Input A1-Type: value from the enclosing message/rfc822 part.
IN-CHAN Input channel to match for conversion (wildcards allowed). The conversion specified by this entry will only be performed if the message is coming from the specified channel.
IN-CHANNEL Synonym for IN-CHAN.
IN-DESCRIPTION Input MIME Content-description: value.
IN-DISPOSITION Input MIME Content-disposition.
IN-DPARAMETER-DEFAULT-n Input MIME Content-disposition parameter value default if parameter is not present. This value is used as a default for the IN-DPARAMETER-VALUE-n test when no such parameter is specified in the body part.
IN-DPARAMETER-NAME-n Input MIME Content-disposition parameter name whose value is to be checked; n = 0, 1, 2, ....
IN-DPARAMETER-VALUE-n Input MIME Content-disposition parameter value that must match corresponding IN-DPARAMETER-NAME (wildcards allowed). The conversion specified by this entry is only performed if this field matches the corresponding parameter in the body part's Content-disposition: parameter list.
IN-ENCODING (New in MS 7.0.5) Input Content-transfer-encoding: value.
IN-LANGUAGE Input Content-language: value.
IN-MESSAGE-CONTEXT Input Message-context: value.
IN-PARAMETER-DEFAULT-n Input MIME Content-type parameter value default if parameter is not present. This value is used as a default for the IN-PARAMETER-VALUE-n test when no such parameter is specified in the body part.
IN-PARAMETER-NAME-n Input MIME Content-type parameter name whose value is to be checked; n = 0, 1, 2, ....
IN-PARAMETER-VALUE-n Input MIME Content-type parameter value that must match corresponding IN-PARAMETER-NAME (wildcards allowed). The conversion specified by this entry is only performed if this field matches the corresponding parameter in the body part's Content-type: parameter list.
IN-SUBJECT Input Subject from enclosing message/rfc822 part.
IN-SUBTYPE Input MIME subtype to match for conversion (wildcards allowed). The conversion specified by this entry is only performed if this field matches the MIME subtype of the body part.
IN-TYPE Input MIME type to match for conversion (wildcards allowed). The conversion specified by this entry is only performed if this field matches the MIME type of the body part.
OUT-CHAN Output channel to match for conversion (wildcards allowed). The conversion specified by this entry will only be performed if the message is destined for the specified channel.
OUT-CHANNEL Synonym for OUT-CHAN.
PART-NUMBER Dotted integers, e.g., a.b.c... The part number of the MIME body part.
TAG Input conversion tag must match; such conversion tags might have been set in various ways, including via a mailing list [CONVERSION_TAG] named parameter, or via an alias_conversion_tag alias option, or in direct LDAP mode set via a user's own mailConversionTag attribute or via the user's domain's mailDomainConversionTag attribute, or via Sieve filter conversion tag actions.
Conversion script environment parameters
DPARAMETER-SYMBOL-n Content-disposition parameters to convert to environment variables if present; n = 0, 1, 2, .... Takes as argument the name of the MIME parameter to convert, as matched by an IN-DPARAMETER-NAME-m clause. Each DPARAMETER-SYMBOL-n is extracted from the Content-disposition: parameter list and placed in an environment variable of the same name prior to executing the converter.
MESSAGE-HEADER-FILE 0, 1, or 2. If set to 1, the original headers of the immediately enclosing message part are written to the file represented by the MESSAGE_HEADERS symbol. If set to 2, the original headers of the message as a whole (the outermost message headers) are written to MESSAGE_HEADERS. As of MS 6.1, in the MESSAGE-HEADER-FILE=2 case, besides the original headers, the envelope information will also be written, in the form of an X-Envelope-from: header line and an X-Envelope-to: header line.
ORIGINAL-HEADER-FILE 0 or 1. If set to 1, the original headers of the enclosing part are written to the file represented by the INPUT_HEADERS symbol.
PARAMETER-SYMBOL-n Content-type parameters to convert to environment variables if present; n = 0, 1, 2, .... Takes as argument the name of the MIME parameter to convert, as matched by an IN-PARAMETER-NAME-m clause. Each PARAMETER-SYMBOL-n is extracted from the Content-type: parameter list and placed in an environment variable of the same name prior to executing the converter.
Override/output parameters
DPARAMETER-COPY-n A list of the Content-disposition: parameters to copy from the input body part's Content-disposition: parameter list to the output body part's Content-disposition: parameter list; n = 0, 1, 2, .... Takes as argument the name of the MIME parameter to copy, as matched by an IN-DPARAMETER-NAME-m clause. Wildcards may be used in the argument. In particular, an argument of * means to copy all the original Content-disposition: parameters.
OUT-A1-FORMAT Output A1-Format.
OUT-A1-TYPE Output A1-Type.
OUT-DESCRIPTION Output MIME Content-description if it is different than the input MIME Content-description.
OUT-DISPOSITION Output MIME Content-disposition if it is different than the input MIME Content-disposition.
OUT-DPARAMETER-NAME-n Output MIME Content-disposition parameter name; n = 0, 1, 2, ....
OUT-DPARAMETER-VALUE-n Output MIME Content-disposition parameter value corresponding to OUT-DPARAMETER-NAME-n.
OUT-MODE Mode in which to read the converted file. This should be one of: BLOCK, RECORD, RECORD-ATTRIBUTE, TEXT.
OUT-ENCODING Encoding to apply to the converted file.
OUT-LANGUAGE Output Content-language: value.
OUT-MESSAGE-CONTEXT (New in 6.0) Set the output Message-context: value
OUT-PARAMETER-NAME-n Output MIME Content-type parameter name; n = 0, 1, 2, ....
OUT-PARAMETER-VALUE-n Output MIME Content-type parameter value corresponding to OUT-PARAMETER-NAME-n.
OUT-SUBTYPE Output MIME type if it is different than the input MIME type.
OUT-TYPE Output MIME type if it is different than the input type
OVERRIDE-HEADER-FILE 0 or 1. If set, then MIME headers are read from the OUTPUT_HEADERS symbol, overriding the original MIME headers in the enclosing part.
OVERRIDE-OPTION-FILE 0 or 1. If set, then the conversion channel reads options from the OUTPUT_OPTIONS symbol.
PARAMETER-COPY-n A list of the Content-type: parameters to copy from the input body part's Content-type: parameter list to the output body part's Content-type: parameter list; n = 0, 1, 2, .... Takes as argument the name of the MIME parameter to copy, as matched by an IN-PARAMETER-NAME-m clause. Wildcards may be used in the argument. In particular, an argument of * means to copy all the original Content-type: parameters.

1Except see the RELABEL, SERVICE-CALL, and SERVICE-COMMAND parameters, which cause entries to be ignored during conversion channel processing, but do affect character set conversion.
2See Service conversions for more information on character set conversion and using the SERVICE-COMMAND parameter.
3See Relabelling MIME header lines for more information on character set conversion and using the RELABEL parameter.
----


See also: