5 .\" include the -mh macro file
8 .TH MHLIST %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
10 mhlist \- list information about MIME messages
14 mhlist \%[+folder] \%[msgs] \%[\-file file]
16 \%[\-part number]... \%[\-type content]...
18 \%[\-headers] \%[\-noheaders]
19 \%[\-realsize] \%[\-norealsize]
21 \%[\-rcache policy] \%[\-wcache policy]
22 \%[\-check] \%[\-nocheck]
24 \%[\-verbose] \%[\-noverbose]
30 The \fImhlist\fR command allows you to list information (essentially
31 a table of contents) about the various parts of a collection of
32 MIME (multi-media) messages.
34 \fImhlist\fR manipulates MIME (multi-media messages) as specified
35 in RFC\-2045 thru RFC\-2049.
37 The `\-headers' switch indicates that a one-line banner should be
38 displayed above the listing.
40 The `\-realsize' switch tells \fImhlist\fR to evaluate the
41 \*(lqnative\*(rq (decoded) format of each content prior to listing.
42 This provides an accurate count at the expense of a small delay.
44 If the `\-verbose' switch is present, then the listing will show
45 any \*(lqextra\*(rq information that is present in the message,
46 such as comments in the Content-Type header.
48 The option `\-file\ file' directs \fImhlist\fR to use the specified
49 file as the source message, rather than a message from a folder.
50 If you specify this file as \*(lq-\*(rq, then \fImhlist\fR will
51 accept the source message on the standard input. Note that the
52 file, or input from standard input should be a validly formatted
53 message, just like any other \fInmh\fR message. It should \fBNOT\fR
54 be in mail drop format (to convert a file in mail drop format to
55 a folder of \fInmh\fR messages, see \fIinc\fR\0(1)).
57 By default, \fImhlist\fR will list information about the entire
58 message (all of its parts). By using the `\-part' and `\-type'
59 switches, you may limit the scope of this command to particular
60 subparts (of a multipart content) and/or particular content types.
62 A part specification consists of a series of numbers separated by dots.
63 For example, in a multipart content containing three parts, these
64 would be named as 1, 2, and 3, respectively. If part 2 was also a
65 multipart content containing two parts, these would be named as 2.1 and
66 2.2, respectively. Note that the `\-part' switch is effective for only
67 messages containing a multipart content. If a message has some other
68 kind of content, or if the part is itself another multipart content, the
69 `\-part' switch will not prevent the content from being acted upon.
71 A content specification consists of a content type and a subtype.
72 The initial list of \*(lqstandard\*(rq content types and subtypes can
73 be found in RFC\-2046.
75 A list of commonly used contents is briefly reproduced here:
83 multipart mixed, alternative, digest, parallel
84 message rfc822, partial, external-body
85 application octet-stream, postscript
93 A legal MIME message must contain a subtype specification.
95 To specify a content, regardless of its subtype, just use the
96 name of the content, e.g., \*(lqaudio\*(rq. To specify a specific
97 subtype, separate the two with a slash, e.g., \*(lqaudio/basic\*(rq.
98 Note that regardless of the values given to the `\-type' switch, a
99 multipart content (of any subtype listed above) is always acted upon.
100 Further note that if the `\-type' switch is used, and it is desirable to
101 act on a message/external-body content, then the `\-type' switch must
102 be used twice: once for message/external-body and once for the content
103 externally referenced.
105 .Uh "Checking the Contents"
106 The `\-check' switch tells \fImhlist\fR to check each content for an
107 integrity checksum. If a content has such a checksum (specified as a
108 Content-MD5 header field), then \fImhlist\fR will attempt to verify the
109 integrity of the content.
111 ^$HOME/\&.mh\(ruprofile~^The user profile
113 ^Path:~^To determine the user's nmh directory
115 ^Current\-Folder:~^To find the default current folder
117 mhbuild(1), mhshow(1), mhstore(1), sendfiles(1)
121 \fIMultipurpose Internet Mail Extensions (MIME) Part One:
123 Format of Internet Message Bodies\fR,
127 \fIMultipurpose Internet Mail Extensions (MIME) Part Two:
133 \fIMultipurpose Internet Mail Extensions (MIME) Part Three:
135 Message Header Extensions for Non-ASCII Text\fR,
139 \fIMultipurpose Internet Mail Extensions (MIME) Part Four:
141 Registration Procedures\fR,
145 \fIMultipurpose Internet Mail Extensions (MIME) Part Five:
147 Conformance Criteria and Examples\fR.
149 `+folder' defaults to the current folder
151 `msgs' defaults to cur
165 If a folder is given, it will become the current folder. The last
166 message selected will become the current message.