5 .TH MHSTORE %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
7 mhstore \- store contents of MIME messages into files
21 .RB [ \-auto " | " \-noauto ]
22 .RB [ \-verbose " | " \-noverbose ]
27 .RB [ \-check " | " \-nocheck ]
33 command allows you to store the contents of a
34 collection of MIME (multi-media) messages into files or other
38 manipulates multi-media messages as specified in
39 RFC\-2045 thru RFC\-2049.
43 will store all the parts of each message.
44 Each part will be store in a separate file. The header fields of
45 the message are not stored. By using the
49 switches, you may limit the scope of
52 subparts (of a multipart content) and/or particular content types.
60 file as the source message, rather than a message from a folder.
61 If you specify this file as \*(lq-\*(rq, then
64 accept the source message on the standard input. Note that the
65 file, or input from standard input should be a validly formatted
66 message, just like any other
70 be in mail drop format (to convert a file in mail drop format to
76 A part specification consists of a series of numbers separated by
77 dots. For example, in a multipart content containing three parts,
78 these would be named as 1, 2, and 3, respectively. If part 2 was
79 also a multipart content containing two parts, these would be named
80 as 2.1 and 2.2, respectively. Note that the
83 effective for only messages containing a multipart content. If a
84 message has some other kind of content, or if the part is itself
85 another multipart content, the
87 switch will not prevent
88 the content from being acted upon.
90 A content specification consists of a content type and a subtype.
91 The initial list of \*(lqstandard\*(rq content types and subtypes
92 can be found in RFC\-2046.
94 A list of commonly used contents is briefly reproduced here:
102 multipart mixed, alternative, digest, parallel
103 message rfc822, partial, external-body
104 application octet-stream, postscript
111 A legal MIME message must contain a subtype specification.
113 To specify a content, regardless of its subtype, just use the name
114 of the content, e.g., \*(lqaudio\*(rq. To specify a specific
115 subtype, separate the two with a slash, e.g., \*(lqaudio/basic\*(rq.
116 Note that regardless of the values given to the
119 a multipart content (of any subtype listed above) is always acted
120 upon. Further note that if the
122 switch is used, and it is
123 desirable to act on a message/external-body content, then the
125 switch must be used twice: once for message/external-body
126 and once for the content externally referenced.
127 .SS "Checking the Contents"
132 to check each content for
133 an integrity checksum. If a content has such a checksum (specified
134 as a Content-MD5 header field), then
137 verify the integrity of the content.
138 .SS "Storing the Contents"
141 will store the contents of the named messages in
142 \*(lqnative\*(rq (decoded) format. Two things must be determined:
143 the directory to store the content, and the filenames. Files are
144 written in the directory given by the \*(lqnmh-storage\*(rq profile
151 If this entry isn't present,
152 the current working directory is used.
156 switch is given, then
159 the message contains information indicating the filename that should
160 be used to store the content. This information should be specified
161 as the attribute \*(lqname=filename\*(rq in the \*(lqContent-Type\*(rq header
162 for the content you are storing. For security reasons, this filename
163 will be ignored if it begins with the character '/', '.', '|', or
164 '!', or if it contains the character '%'. For the sake of security,
165 this switch is not the default, and it is recommended that you do
174 switch is not given (or is being ignored for security
177 will look in the user's profile for a
178 \*(lqformatting string\*(rq to determine how the different contents
179 should be stored. First,
181 will look for an entry of
185 mhstore-store-<type>/<subtype>
188 to determine the formatting string. If this isn't found,
190 will look for an entry of the form:
196 to determine the formatting string.
198 If the formatting string starts with a \*(lq+\*(rq character, then
199 content is stored in the named folder. A formatting string consisting
200 solely of a \*(lq+\*(rq character is interpreted to be the current
203 If the formatting string consists solely of a \*(lq-\*(rq character,
204 then the content is sent to the standard output.
206 If the formatting string starts with a '|', then the display string
207 will represent a command for
209 to execute which should
210 ultimately store the content. The content will be passed to the
211 standard input of the command. Before the command is executed,
213 will change to the appropriate directory, and any
214 escapes (given below) in the display string will be expanded.
216 Otherwise the formatting string will represent a pathname in which
217 to store the content. If the formatting string starts with a '/',
218 then the content will be stored in the full path given, else the
219 file name will be relative to the value of \*(lqnmh-storage\*(rq or
220 the current working directory. Any escapes (given below) will be
221 expanded, except for the a-escape.
223 A command or pathname formatting string may contain the following
224 escapes. If the content isn't part of a multipart (of any subtype
225 listed above) content, the p-escapes are ignored.
230 %a Parameters from Content-type (only valid with command)
231 %m Insert message number
232 %P Insert part number with leading dot
233 %p Insert part number without leading dot
234 %t Insert content type
235 %s Insert content subtype
236 %% Insert character %
240 If no formatting string is found,
243 if the content is application/octet-stream with parameter
244 \*(lqtype=tar\*(rq. If so,
246 will choose an appropriate
247 filename. If the content is not application/octet-stream, then
249 will check to see if the content is a message. If
252 will use the value \*(lq+\*(rq. As a last resort,
254 will use the value \*(lq%m%P.%s\*(rq.
256 Example profile entries might be:
260 mhstore-store-text: %m%P.txt
261 mhstore-store-text: +inbox
262 mhstore-store-message/partial: +
263 mhstore-store-audio/basic: | raw2audio -e ulaw -s 8000 -c 1 > %m%P.au
264 mhstore-store-image/jpeg: %m%P.jpg
265 mhstore-store-application/PostScript: %m%P.ps
269 .SS "Reassembling Messages of Type message/partial"
271 is also able to reassemble messages that have been
272 split into multiple messages of type \*(lqmessage/partial\*(rq.
274 When asked to store a content containing a partial message,
276 will try to locate all of the portions and combine
277 them accordingly. The default is to store the combined parts as
278 a new message in the current folder, although this can be changed
279 using formatting strings as discussed above. Thus, if someone has
280 sent you a message in several parts (such as the output from
282 you can easily reassemble them all into a single
283 message in the following fashion:
288 msg part type/subtype size description
289 5 message/partial 47K part 1 of 4
290 6 message/partial 47K part 2 of 4
291 7 message/partial 47K part 3 of 4
292 8 message/partial 18K part 4 of 4
294 reassembling partials 5,6,7,8 to folder inbox as message 9
296 msg part type/subtype size description
297 9 application/octet-stream 118K
298 (extract with uncompress | tar xvpf -)
304 This will store exactly one message, containing the sum of the
305 parts. It doesn't matter whether the partials are specified in
308 will sort the partials, so that they
309 are combined in the correct order. But if
312 locate every partial necessary to reassemble the message, it will
314 .SS "External Access"
315 For contents of type message/external-body,
316 \fImhstore\fR supports these access-types:
329 For the \*(lqanon-ftp\*(rq and \*(lqftp\*(rq access types,
331 will look for the \*(lqnmh-access-ftp\*(rq
335 nmh-access-ftp: myftp.sh
338 to determine the pathname of a program to perform the FTP retrieval.
339 This program is invoked with these arguments:
343 domain name of FTP-site
349 \*(lqascii\*(rq or \*(lqbinary\*(rq
353 The program should terminate with an exit status of zero if the
354 retrieval is successful, and a non-zero exit status otherwise.
356 If this entry is not provided, then
359 built-in FTP client to perform the retrieval.
360 .SS "The Content Cache"
363 encounters an external content containing a
364 \*(lqContent-ID:\*(rq field, and if the content allows caching, then
365 depending on the caching behavior of
367 the content might be read from or written to a cache.
369 The caching behavior of
371 is controlled with the
375 switches, which define the policy for reading from,
376 and writing to, the cache, respectively. One of four policies may be
377 specified: \*(lqpublic\*(rq, indicating that
380 of a publically-accessible content cache; \*(lqprivate\*(rq, indicating
383 should make use of the user's private content cache;
384 \*(lqnever\*(rq, indicating that
386 should never make use of
387 caching; and, \*(lqask\*(rq, indicating that
391 There are two directories where contents may be cached: the profile entry
392 \*(lqnmh-cache\*(rq names a directory containing world-readable contents, and,
393 the profile entry \*(lqnmh-private-cache\*(rq names a directory containing
394 private contents. The former should be an absolute (rooted) directory
403 might be used if you didn't care that the cache got wiped after each
404 reboot of the system. The latter is interpreted relative to the user's
405 nmh directory, if not rooted, e.g.,
408 nmh-private-cache: .cache
411 (which is the default value).
412 .SS "User Environment"
413 Because the display environment in which
415 operates may vary for
418 will look for the environment variable
420 If present, this specifies the name of an additional
421 user profile which should be read. Hence, when a user logs in on a
422 particular machine, this environment variable should be set to
423 refer to a file containing definitions useful for that machine.
426 will attempt to consult one other additional
430 %etcdir%/mhn.defaults
433 which is created automatically during
440 .ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u
441 ^$HOME/\&.mh\(ruprofile~^The user profile
442 ^$MHSTORE~^Additional profile entries
443 ^%etcdir%/mhn.defaults~^System default MIME profile entries
446 .SH "PROFILE COMPONENTS"
450 .ta \w'ExtraBigProfileName 'u
451 ^Path:~^To determine the user's nmh directory
452 ^Current\-Folder:~^To find the default current folder
453 ^nmh-access-ftp:~^Program to retrieve contents via FTP
454 ^nmh-cache~^Public directory to store cached external contents
455 ^nmh-private-cache~^Personal directory to store cached external contents
456 ^nmh-storage~^Directory to store contents
457 ^mhstore-store-<type>*~^Template for storing contents
461 mhbuild(1), mhlist(1), mhshow(1), sendfiles(1)
465 .RB ` +folder "' defaults to the current folder"
466 .RB ` msgs "' defaults to cur"
474 If a folder is given, it will become the current folder. The last
475 message selected will become the current message.
478 Partial messages contained within a multipart content are not reassembled.
projects / mmh / blob