test

Sun Java System Messaging Server 6.3 Administration Reference

Predefined Environment Variables

Table 4–12 shows the basic set of environment variables available for use by the conversion command.

Table 4–12 Environment Variables used by the Conversion Channel

Environment Variable  

Description  

ATTACHMENT_NUMBER

Attachment number for the current part. This has the same format as the ATTACHMENT-NUMBER conversion match parameter.

CONVERSION_TAG

Current list of active conversion tags. This variable corresponds to the TAG conversion parameter.

INPUT_CHANNEL

Channel that enqueued the message to the conversion channel. This variable corresponds to the IN-CHANNEL conversion parameter.

INPUT_ENCODING

Encoding originally present on the body part. 

INPUT_FILE

Name of the file containing the original body part. The site-supplied program should read this file. 

INPUT_HEADERS

Name of the file containing the original headers for the enclosing part. The site-supplied program should read this file. 

INPUT_TYPE

MIME content type of the input message part. 

INPUT_SUBTYPE

MIME content subtype of the input message part. 

INPUT_DESCRIPTION

MIME content description of the input message part. 

INPUT_DISPOSITION

MIME content disposition of the input message part. 

MESSAGE_HEADERS

Name of the file containing the original headers for an enclosing message (not just the body part) or the header for the part’s most immediately enclosing MESSAGE/RFC822 part. The site-supplied program should read this file. 

OUTPUT_CHANNEL

Channel to which the message is headed. This variable corresponds to the IN-CHANNEL conversion parameter.

OUTPUT_FILE

Name of the file where the site-supplied program should store its output. The site-supplied program should create and write this file. 

OUTPUT_HEADERS

Name of the file where the site-supplied program should store MIME header lines for an enclosing part. The site-supplied program should create and write this file. Note that file should contain actual header lines (not option=value lines) followed by a blank line as its final line.

OUTPUT_OPTIONS

Name of the file from which the site-supplied program should read conversion channel options. Note that file should include header lines, followed by a blank line as its final line. 

PART_NUMBER

Part number for the current part. This has the same format as the PART-NUMBER conversion match parameter.

PART_SIZE

Size in bytes of the part being processed. 

Additional environment variables containing Content-type: parameter information or Content-disposition: parameter information can be created as needed using the PARAMETER-SYMBOL-n or DPARAMETER-SYMBOL-n parameters respectively.

Table 4–13 displays additional override options available for use by the conversion channel. The converter procedure may use these to pass information back to the conversion channel. To set these options, 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.

Table 4–13 Options for passing information back to the conversion channel

Option  

Description  

OUTPUT_TYPE

MIME content type of the output message part. 

OUTPUT_SUBTYPE

MIME content subtype of the output message part. 

OUTPUT_DESCRIPTION

MIME 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 by the conversion channel. 

OUTPUT_DISPOSITION

MIME content disposition of the output message part. 

OUTPUT_ENCODING

MIME content transfer encoding to use on the output message part. 

OUTPUT_MODE

MIME 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

Exit status for the converter. This is typically a special directive initiating some action by the conversion channel. A complete list of directives can be viewed in msg-svr-base/include/pmdf_err.h