PMDF User's Guide
OpenVMS Edition
Previous Next Contents Index

SET & SHOW HEADER_TRIMMING

Control which message header lines are displayed.

Syntax

SET HEADER_TRIMMING header-name[,...]

SHOW HEADER_TRIMMING

Qualifiers Defaults
/ALL None
/BOLD None
/DISPLAYED /DISPLAYED
/INPUT=in-file-spec See text
/MAX_LINES=lines Unlimited
/MAX_OCCURRENCES=occurrences Unlimited
/OMITTED /DISPLAYED
/OUTPUT=out-file-spec /NOOUTPUT
/PRECEDENCE=precedence None
/REVERSE None
/TRIM See text
/UNDERLINE None

Parameters

header-name

Parameter specifying the name of the header line types to effect the setting for. This parameter is required when the /ALL qualifier is not used. The list of legal values for this parameter are not shown in this document. Use the question mark, ?, key to see the list of possible values as shown in the Example section. The header names are merely the names of header lines; e.g., From, To, Subject, etc.

Description

You can instruct PMDF MAIL to not show certain header lines when you read your mail. This is often referred to as "header trimming". Note, however, that the header is not actually trimmed --- PMDF MAIL merely omits displaying the header lines which you do not want to see. You can view the full, untrimmed header with the /NOTRIM option of the message reading commands.

You should store your personal header trimming settings in the file PMDF_INIT:PMDF_MAIL_HEADERS.OPT. 5 Whenever you invoke PMDF MAIL, this file will be read and your header trimming settings established. If you do not explicitly save your settings with the /OUTPUT qualifier, then when you exit PMDF MAIL you will be asked whether or not they should be output. If you answer yes, they will be written to the file cited previously.

Qualifiers

/ALL

Settings are to affect all header lines. By default, only the header lines you specify are affected. Do not specify the header-name parameter when the /ALL qualifier is used. When used with the SHOW command, the /ALL qualifier indicates that the disposition (trim vs. no trim) of each header line is to be shown. By default, only those header lines which are not trimmed are shown.

/BOLD

/NOBOLD

Specify whether or not to display the specified header lines with a bold face font. May be used in conjunction with /REVERSE and /UNDERLINE. Only the field name of the header line is affected.

/DISPLAYED (default)

/OMITTED

The /DISPLAYED and /OMITTED qualifiers may only be used with the SHOW HEADER_TRIMMING command. They are equivalent to /NOTRIM and /TRIM.

/INPUT=in-file-spec

Load or re-load an initial set of header trimming settings from the specified input file.

/MAX_LINES=lines

The maximum number of lines of text to output for a given type of header line.6 If not specified, then an unlimited number of lines may be displayed. You may not specify /MAX_LINES in conjunction with SET/TRIM.

/MAX_OCCURRENCES=occurrences

The maximum number of instances to display for a given type of header line.6. If not specified, then any number of instances may be displayed. You may not specify /MAX_OCCURRENCES in conjunction with SET/TRIM.

/OUTPUT[=out-file-spec]

Specifies a file to write the new header trimming settings to. If the output file name is omitted, then the setting will be written to the file PMDF_INIT:PMDF_MAIL_HEADERS.OPT.

/PRECEDENCE=precedence

/NOPRECEDENCE

Each header line may be assigned a precedence value between 0 and 100 inclusive. When header lines are displayed, the header line with the largest precedence is displayed first, followed by the header line with next largest precedence, etc. PMDF's internal precedence rules are used to order header lines of the same precedence. The /NOPRECEDENCE qualifier assigns a precedence of zero, which is the default precedence value.

/REVERSE

/NOREVERSE

Specify whether or not to display the specified header lines in reverse video mode. May be used in conjunction with /BOLD and /UNDERLINE. Only the field name of the header line is affected.

/TRIM

/NOTRIM

When used with the SET command, indicates whether or not the specified header lines will be displayed. /NOTRIM indicates that they are to be displayed while /TRIM indicates that they are not be displayed. While specifying /TRIM is equivalent to either /MAX_LINES=0 or /MAX_OCCURRENCES=0, it is more efficient if you use /TRIM. You may not specify /TRIM in conjunction with /MAX_OCCURRENCES or /MAX_LINES. When used with the SHOW command, the /TRIM and /OMITTED qualifiers request that only the header lines which are trimmed be shown. The /NOTRIM and /DISPLAYED qualifiers request that the untrimmed header lines be shown. The default, if none of these four are specified, is /NOTRIM. Use the /ALL qualifier to show the disposition of all header lines.

/UNDERLINE

/NOUNDERLINE

Specify whether or not to underline the specified header lines when displaying them. May be used in conjunction with /BOLD and /REVERSE. Only the field name of the header line is affected.

Examples

#1 

EMAIL> SET HEADER_TRIMMING ?
Optional group of keywords, must be chosen from:
 (1) a1-format            A1-format: header line
 (2) a1-forward           A1-forward: header line
 (3) a1-function          A1-function: header line
 (4) a1-type              A1-type: header line
 (5) addresses-referred-t Addresses-referred-to: header line
 (6) alternate-recipient  Alternate-recipient: header line
 (7) application-name     Application-name: header line
 (8) attachment           Attachment: header line
 
         .
         .
         .
More? N
 
-or-
Required qualifier, must be chosen from:
 (1) /all                  Setting is to affect all header lines
 (2) /input                Input header line options
 (3) /max_lines            Maximum number of lines to retain
 (4) /max_occurrences      Maximum number of occurrences to retain
 (5) /nooutput             Do not output settings to a file
 (6) /notrim               Display specified header lines
 (7) /output               Output updated settings to a file
 (8) /trim                 Do not display specified header lines
EMAIL> SET HEADER_TRIMMING

Here, the question mark, ?, is used to obtain information on the allowed values for the header name parameter.

#2 

EMAIL>
EMAIL> SET HEADER_TRIMMING/TRIM/ALL
EMAIL> SET HEADER_TRIMMING/NOTRIM/BOLD cc,comments,content-type,date,from
EMAIL> SET HEADER_TRIMMING/NOTRIM/BOLD keywords,organization,reply-to,
EMAIL> SET HEADER_TRIMMING/NOTRIM/BOLD sender,subject,to
EMAIL> SET HEADER_TRIMMING/NOTRIM/BOLD/REVERSE bcc
EMAIL> SET HEADER_TRIMMING/NOTRIM/BOLD/UNDERLINE resent-bcc,resent-cc
EMAIL> SET HEADER_TRIMMING/NOTRIM/BOLD/UNDERLINE resent-date,resent-from
EMAIL> SET HEADER_TRIMMING/NOTRIM/BOLD/UNDERLINE resent-reply-to
EMAIL> SET HEADER_TRIMMING/NOTRIM/BOLD/UNDERLINE resent-sender,resent-to
EMAIL> SET HEADER_TRIMMING/NOTRIM/BOLD/REVERSE/UNDERLINE resent-bcc
EMAIL> SET HEADER_TRIMMING/OUTPUT
EMAIL>

In this example, the first command specifies that no header lines are to be displayed. The next four commands then request which header lines should be displayed. The final command then saves these settings to the file PMDF_INIT:PMDF_MAIL_HEADERS.OPT so that they can be recalled every time you use PMDF MAIL.

#3 

EMAIL> SHOW HEADER_TRIMMING
Bcc:             emphasis=bold,reverse
Cc:              emphasis=bold
Comments:        emphasis=bold
Content-type:    emphasis=bold
Date:            emphasis=bold
From:            emphasis=bold
Resent-bcc:      emphasis=bold,reverse,underline
Resent-cc:       emphasis=bold,underline
Resent-date:     emphasis=bold,underline
Resent-from:     emphasis=bold,underline
Resent-reply-to: emphasis=bold,underline
Resent-sender:   emphasis=bold,underline
Resent-to:       emphasis=bold,underline
Sender:          emphasis=bold
Subject:         emphasis=bold
To:              emphasis=bold
EMAIL>

In this example, the active header trimming settings are displayed. In this case, these are the trimmings established by the commands shown above.

Note

5 PMDF_INIT is a logical which normally points to your login directory. You can redefine this logical to point somewhere else if you wish.

6 Do not be confused by the two types of "lines" being discussed here. A single header line may be so long that to display it on a terminal screen requires writing several lines of text to the terminal. The /MAX_LINES qualifier limits the number of lines of text; whereas, /MAX_OCCURRENCES limits the number of header lines. Note further that the PMDF MAIL /MAX_LINES qualifier corresponds to the PMDF header trimming CUTLINES option.

Previous Next Contents Index