Conversion predefined symbols and environment variables

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


Symbols in conversion file entries shows symbols available for use within conversion file entries; that is, symbol substitutions available directly in the conversion file. (In constrast, Environment variables for use by conversion channel shell procedures below shows environment variables available for use within a conversion shell script procedure.)

Symbols in conversion file entries
Symbol Description
A1-FORMAT  
A1-FUNCTION  
A1-TYPE  
DESCRIPTION The content description of the input message part.
DISPOSITION The content disposition of the input message part.
LANGUAGE The language tag from the Content-language: header line of the input message part.
SERVICE  
SUBJECT The Subject: of the enclosing message/rfc822 part.
TAG The conversion tag(s) of the input message.

Symbols may be substituted into a conversion entry by enclosing the symbol name in single quotes.

To obtain a literal single quote in a conversion entry, quote it with the backslash character, \'. To obtain a literal backslash in a conversion entry, use two backslashes, \\.

Environment variables for use by conversion channel shell proceduresshows the basic set of environment variables (UNIX) available for use by the conversion command.

Environment variables for use by conversion channel shell procedures
Environment variable Description
ATTACHMENT_NUMBER The 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.
CONVERSION_TAG The conversion tag(s) of the input message (only defined if the message has one or more conversion tags set).
INPUT_CHANNEL The source channel.
INPUT_ENCODING The encoding originally present on the body part.
INPUT_FILE The name of the file containing the original body part. The converter should read this file.
INPUT_HEADERS The name of the file containing the original headers for the enclosing part. The converter should read this file.
INPUT_DESCRIPTION The content description of the input message part.
INPUT_DISPOSITION The content disposition of the input message part.
INPUT_LANGUAGE The content language of the input message part.
INPUT_TYPE The content type of the input message part.
INPUT_SUBTYPE The content subtype of the input message part.
MESSAGE_HEADERS The name of the file containing the original headers for an enclosing message. The converter should read this file.
OUTPUT_CHANNEL The destination channel.
OUTPUT_FILE The name of the file where the converter should store its output. The converter should create and write this file.
OUTPUT_HEADERS The name of the file where the converter should store MIME headers for an enclosing part. The converter should create and write this file. Note that the file should have a format of header line, header line,..., blank line; be sure to include the final blank line.
OUTPUT_OPTIONS The name of the file from which the converter should read options (such as status values on UNIX).
PART_NUMBER The MIME structured number for the part. Compare with ATTACHMENT_NUMBER, which is the sequential number of the part.
PART_SIZE The size, in bytes, of the part.
content-disposition parameters  
content-type parameters  

Additional environment variables (UNIX or NT) containing Content-type: parameter information or Content-disposition: parameter information can be created as they are needed using the PARAMETER-SYMBOL-n and DPARAMETER-SYMBOL-n facilities, respectively; see Available conversion parameters, grouped by functionality.

Override options for passing information back to the conversion channelshows additional "override" options available (on UNIX) for use by the conversion channel. The converter procedure may use these to pass information back to the conversion channel. To set these options on UNIX, set OVERRIDE-OPTION-FILE=1 in the desired conversion entry and then have the converter procedure set the desired options in the OUTPUT_OPTIONS file.

Override options for passing information back to the conversion channel
Override option Description
OUTPUT_TYPE The content type of the output message part.
OUTPUT_SUBTYPE The content subtype of the output message part.
OUTPUT_DESCRIPTION The content description of the output message part.
OUTPUT_DIAGNOSTIC Text to include in the error text returned to the message sender if a message is forcibly bounced (via PMDF__FORCERETURN) by the conversion channel.
OUTPUT_DISPOSITION The content disposition of the output message part.
OUTPUT_ENCODING The content transfer encoding to use on the output message part.
OUTPUT_LANGUAGE The content language of the output message part.
OUTPUT_MODE The mode with which the conversion channel should write the output message part, hence the mode with which recipients should read the output message part.
STATUS The MTA exit status for the converter.


See also: