4 .TH MHSTORE %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
6 mhstore \- store contents of MIME messages into files
21 .RB [ \-auto " | " \-noauto ]
28 command allows you to store the contents of a
29 collection of MIME (multi-media) messages into files or other
33 manipulates multi-media messages as specified in
34 RFC\-2045 thru RFC\-2049.
38 will store all the parts of each message.
39 Each part will be store in a separate file. The header fields of
40 the message are not stored. By using the
44 switches, you may limit the scope of
47 subparts (of a multipart content) and/or particular content types.
55 file as the source message, rather than a message from a folder.
56 If you specify this file as \*(lq-\*(rq, then
59 accept the source message on the standard input. Note that the
60 file, or input from standard input should be a validly formatted
61 message, just like any other
65 be in mail drop format (to convert a file in mail drop format to
71 A part specification consists of a series of numbers separated by
72 dots. For example, in a multipart content containing three parts,
73 these would be named as 1, 2, and 3, respectively. If part 2 was
74 also a multipart content containing two parts, these would be named
75 as 2.1 and 2.2, respectively. Note that the
78 effective for only messages containing a multipart content. If a
79 message has some other kind of content, or if the part is itself
80 another multipart content, the
82 switch will not prevent
83 the content from being acted upon.
85 A content specification consists of a content type and a subtype.
86 The initial list of \*(lqstandard\*(rq content types and subtypes
87 can be found in RFC\-2046.
89 A list of commonly used contents is briefly reproduced here:
97 multipart mixed, alternative, digest, parallel
98 message rfc822, partial, external-body
99 application octet-stream, postscript
106 A legal MIME message must contain a subtype specification.
108 To specify a content, regardless of its subtype, just use the name
109 of the content, e.g., \*(lqaudio\*(rq. To specify a specific
110 subtype, separate the two with a slash, e.g., \*(lqaudio/basic\*(rq.
111 Note that regardless of the values given to the
114 a multipart content (of any subtype listed above) is always acted
115 upon. Further note that if the
117 switch is used, and it is
118 desirable to act on a message/external-body content, then the
120 switch must be used twice: once for message/external-body
121 and once for the content externally referenced.
122 .SS "Storing the Contents"
125 will store the contents of the named messages in
126 \*(lqnative\*(rq (decoded) format. Two things must be determined:
127 the directory to store the content, and the filenames. Files are
128 written in the directory given by the \*(lqnmh-storage\*(rq profile
135 If this entry isn't present,
136 the current working directory is used.
138 By default (or if the
140 switch is given), then
143 the message contains information indicating the filename that should
144 be used to store the content. This information should be specified
145 as the attribute \*(lqname=filename\*(rq in the \*(lqContent-Type\*(rq header
146 for the content you are storing. For security reasons, this filename
147 will be ignored if it begins with the character '/', '.', '|', or '!',
148 or if it contains the character '%'. Now that tar files are not extracted
149 automatically anymore, having
151 as the default is quite safe.
152 Attachments are only stored below the current (or the storage)
153 directory. In the worst case, existing files there will be overwritten.
157 switch is not given (or is being ignored for security
160 will look in the user's profile for a
161 \*(lqformatting string\*(rq to determine how the different contents
162 should be stored. First,
164 will look for an entry of
168 mhstore-store-<type>/<subtype>
171 to determine the formatting string. If this isn't found,
173 will look for an entry of the form:
179 to determine the formatting string.
181 If the formatting string starts with a \*(lq+\*(rq character, then
182 content is stored in the named folder. A formatting string consisting
183 solely of a \*(lq+\*(rq character is interpreted to be the current
186 If the formatting string consists solely of a \*(lq-\*(rq character,
187 then the content is sent to the standard output.
189 If the formatting string starts with a '|', then the display string
190 will represent a command for
192 to execute which should
193 ultimately store the content. The content will be passed to the
194 standard input of the command. Before the command is executed,
196 will change to the appropriate directory, and any
197 escapes (given below) in the display string will be expanded.
199 Otherwise the formatting string will represent a pathname in which
200 to store the content. If the formatting string starts with a '/',
201 then the content will be stored in the full path given, else the
202 file name will be relative to the value of \*(lqnmh-storage\*(rq or
203 the current working directory. Any escapes (given below) will be
204 expanded, except for the a-escape. Note that if \*(lqnmh-storage\*(rq
205 is not an absolute path, it will be relative to the folder that
206 contains the message(s).
208 A command or pathname formatting string may contain the following
209 escapes. If the content isn't part of a multipart (of any subtype
210 listed above) content, the p-escapes are ignored.
215 %a Parameters from Content-type (only valid with command)
216 %m Insert message number
217 %P Insert part number with leading dot
218 %p Insert part number without leading dot
219 %t Insert content type
220 %s Insert content subtype
221 %% Insert character %
225 If no formatting string is found,
227 will check to see if the content is a message. If
230 will use the value \*(lq+\*(rq. As a last resort,
232 will use the value \*(lq%m%P.%s\*(rq.
234 Example profile entries might be:
238 mhstore-store-text: %m%P.txt
239 mhstore-store-text: +inbox
240 mhstore-store-message/partial: +
241 mhstore-store-audio/basic: | raw2audio -e ulaw -s 8000 -c 1 > %m%P.au
242 mhstore-store-image/jpeg: %m%P.jpg
243 mhstore-store-application/PostScript: %m%P.ps
247 .SS "Reassembling Messages of Type message/partial"
249 is also able to reassemble messages that have been
250 split into multiple messages of type \*(lqmessage/partial\*(rq.
252 When asked to store a content containing a partial message,
254 will try to locate all of the portions and combine
255 them accordingly. The default is to store the combined parts as
256 a new message in the current folder, although this can be changed
257 using formatting strings as discussed above. Thus, if someone has
258 sent you a message in several parts (such as the output from
260 you can easily reassemble them all into a single
261 message in the following fashion:
266 msg part type/subtype size description
267 5 message/partial 47K part 1 of 4
268 6 message/partial 47K part 2 of 4
269 7 message/partial 47K part 3 of 4
270 8 message/partial 18K part 4 of 4
272 reassembling partials 5,6,7,8 to folder inbox as message 9
274 msg part type/subtype size description
275 9 application/octet-stream 118K
276 (extract with uncompress | tar xvpf -)
282 This will store exactly one message, containing the sum of the
283 parts. It doesn't matter whether the partials are specified in
286 will sort the partials, so that they
287 are combined in the correct order. But if
290 locate every partial necessary to reassemble the message, it will
293 .SS "External Access"
294 For contents of type message/external-body,
295 \fImhstore\fR supports these access-types:
308 For the \*(lqanon-ftp\*(rq and \*(lqftp\*(rq access types,
310 will look for the \*(lqnmh-access-ftp\*(rq
314 nmh-access-ftp: myftp.sh
317 to determine the pathname of a program to perform the FTP retrieval.
318 This program is invoked with these arguments:
322 domain name of FTP-site
328 \*(lqascii\*(rq or \*(lqbinary\*(rq
332 The program should terminate with an exit status of zero if the
333 retrieval is successful, and a non-zero exit status otherwise.
334 .SS "User Environment"
335 Because the display environment in which
337 operates may vary for
340 will look for the environment variable
342 If present, this specifies the name of an additional
343 user profile which should be read. Hence, when a user logs in on a
344 particular machine, this environment variable should be set to
345 refer to a file containing definitions useful for that machine.
348 will attempt to consult one other additional
352 %etcdir%/mhn.defaults
355 which is created automatically during
362 .ta \w'%etcdir%/ExtraBigFileName 'u
363 ^$HOME/.mmh/profile~^The user profile
364 ^$MHSTORE~^Additional profile entries
365 ^%etcdir%/mhn.defaults~^System default MIME profile entries
368 .SH "PROFILE COMPONENTS"
372 .ta \w'ExtraBigProfileName 'u
373 ^Path:~^To determine the user's mail storage
374 ^Current\-Folder:~^To find the default current folder
375 ^nmh-access-ftp:~^Program to retrieve contents via FTP
376 ^nmh-storage~^Directory to store contents
377 ^mhstore-store-<type>*~^Template for storing contents
381 mhbuild(1), mhlist(1), mhshow(1), sendfiles(1)
385 .RB ` +folder "' defaults to the current folder"
386 .RB ` msgs "' defaults to cur"
390 If a folder is given, it will become the current folder. The last
391 message selected will become the current message.
394 Partial messages contained within a multipart content are not reassembled.
projects / mmh / blob