trAvis - MANAGER

Edit File: reformime.html

<?xml version="1.0"?>
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/><title>reformime</title><link rel="stylesheet" type="text/css" href="style.css"/><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"/><link rel="home" href="#idm255220000832" title="reformime"/><link xmlns="" rel="stylesheet" type="text/css" href="manpage.css"/><meta xmlns="" name="MSSmartTagsPreventParsing" content="TRUE"/><link xmlns="" rel="icon" href="icon.gif" type="image/gif"/><!--

--></head><body><div class="refentry"><a id="idm255220000832" shape="rect"> </a><div class="titlepage"/><div class="refnamediv"><h2>Name</h2>reformime — MIME E-mail reformatting tool</div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><code class="command">reformime</code> [<code>options</code>...]</div></div><div class="refsect1"><a id="idm255224454544" shape="rect"> </a><h2>DESCRIPTION</h2>
reformime is a utility for reformatting
MIME messages.
Generally, reformime expects to see an
<a class="ulink" href="http://www.rfc-editor.org/rfc/rfc2045.txt" target="_top" shape="rect">RFC 2045</a>
compliant message on standard input, except in few cases
such as the <code class="option">-m</code> option.
If no options are given, reformime prints the MIME
structure of the message. The output consists of so-called
"MIME reference tags", one per line.
For example:<div class="blockquote"><blockquote class="blockquote"><div class="informalexample"><pre class="programlisting" xml:space="preserve">
1
1.1
1.2
</pre></div></blockquote></div>
This shows that the message contains two different MIME sections. The
first line of the MIME structure output will always contain "1", which refers
to the entire message.
In this case it happens to be a <code class="literal">multipart/mixed</code>
message. "1.1" refers to the first section of the multipart message, which
happens to be a
<code class="literal">text/plain</code> section. "1.2" refers to the second
section of the message, which happens to be an
<code class="literal">application/octet-stream</code> section.
If the message is not a MIME message, or it does not contain any
attachments, reformime prints only "1", that refers
to the entire message itself:<div class="blockquote"><blockquote class="blockquote"><div class="informalexample"><pre class="programlisting" xml:space="preserve">
1
</pre></div></blockquote></div>
Here's the output from
reformime when the first part of the message was itself a
<code class="literal">multipart/alternative</code> section:<div class="blockquote"><blockquote class="blockquote"><div class="informalexample"><pre class="programlisting" xml:space="preserve">
1
1.1
1.1.1
1.1.2
1.2
</pre></div></blockquote></div>
Arbitrarily complex MIME constructs are possible.</div><div class="refsect1"><a id="idm255222804272" shape="rect"> </a><h2>OPTIONS</h2><div class="variablelist"><dl class="variablelist"><dt>-d</dt><dd>
Parse a delivery status notification MIME message
(<a class="ulink" href="http://www.rfc-editor.org/rfc/rfc1894.txt" target="_top" shape="rect">RFC 1894</a>).
reformime
expects to see on standard input a MIME message that consists of
a delivery status notification, as defined by RFC 1894.
reformime
reads
the message and prints on standard output a list of addresses and their
corresponding delivery status, as specified in the delivery status
notification. Each line printed by
reformime
consists of a delivery
status, a space, and the address.
reformime then terminates with a 0 exit status.
reformime produces no output and terminates with an exit
status of 1 if the standard input does not contain a delivery status
notification.</dd><dt>-D</dt><dd>
Like the <code class="option">-d</code> except that
reformime lists the address
found in the <code class="literal">Original-Recipient:</code> header,
if it exists.</dd><dt>-e</dt><dd>
Extract the contents of the indicated MIME section, and display it
on standard output.
The <code class="option">-s</code> option is required when
<code class="option">-e</code> is specified. If the
specified section or
sections use either the <code class="literal">base64</code> or
<code class="literal">quoted-printable</code> encoding method,
reformime automatically
decodes it. In this case you're better off redirecting the standard output
into a file.</dd><dt>-i</dt><dd>
Display MIME information for each section. reformime
displays the contents of the
<code class="literal">Content-Type:</code> header, any encoding used,
and the character set.
reformime also displays the byte offset in the message
where each section starts and ends (and where the
actual contents of the section start, after skipping all the headers).</dd><dt>-m</dt><dd>
Create a <code class="literal">multipart/digest</code> MIME message digest.</dd><dt>-r</dt><dd>
Rewrite message, adding or standardizing
<a class="ulink" href="http://www.rfc-editor.org/rfc/rfc2045.txt" target="_top" shape="rect">RFC 2045</a>
MIME headers.</dd><dt>-r7</dt><dd>
Like <code class="option">-r</code> but also convert <code class="literal">8bit</code>-encoded
MIME sections to <code class="literal">quoted-printable</code>.</dd><dt>-r8</dt><dd>
Like <code class="option">-r</code> but also convert
<code class="literal">quoted-printable</code>-encoded MIME sections to
<code class="literal">8bit</code>.</dd><dt>-s <code>section</code></dt><dd>
Display MIME information for this section only.
<code>section</code> is
a MIME specification tag. The <code class="option">-s</code> option is required if
<code class="option">-e</code> is also
specified, and is optional with <code class="option">-i</code>.
Multiple sections may be specified by separating them with commas.
reformime processes each section using the other options
that were specified.</dd><dt>-x</dt><dd>
Extract the contents of the indicated MIME section to a file.</dd><dt>-X</dt><dd>
Pipe the contents of the indicated MIME section to a program.</dd></dl></div><div class="refsect2"><a id="idm255222765808" shape="rect"> </a><h3>Extracting RFC 2045 MIME section(s) to file(s)</h3>
The <code class="option">-x</code> and <code class="option">-X</code> options extract a specific
MIME section to a file or to a pipe to an external program.
Use the <code class="option">-s</code> option to identify the MIME section
to extract. If the <code class="option">-s</code> option is not specified,
every MIME section in the message is extracted, one at a time.
If <code class="option">-s</code> lists multiple sections, each section gets
extracted separately.
<code class="literal">quoted-printable</code> and <code class="literal">base64</code> encoding are
automatically decoded.<div class="variablelist"><dl class="variablelist"><dt>-x</dt><dd>
Interactive extraction. reformime prints the MIME
content type of each section. Answer with 'y' or 'Y' to extract the MIME
section. Specify the filename at the next prompt. reformime
prompts with a default filename.
reformime tries to choose the default
filename based on the MIME headers, if possible. If not, the default
filename will be <code class="literal">attachment1.dat</code> (if the -s option is not
specified, the next filename will be <code class="literal">attachment2.dat</code>,
and so on).</dd><dt>-x<code>PREFIX</code></dt><dd>
Automatic extraction. reformime automatically
extracts one or more MIME sections, and saves them to a file.
The filename is formed by taking
<code>PREFIX</code>, and appending the default filename to it.
Note that there's no space between "-x" and "PREFIX". For example:<div class="blockquote"><blockquote class="blockquote"><div class="informalexample"><pre class="programlisting" xml:space="preserve">
reformime -xfiles-
</pre></div></blockquote></div>
This command saves MIME sections as
<code class="filename">files-attachment1.dat</code>, then
<code class="filename">files-attachment2.dat</code>, etc.
reformime tries to append the filename specified in the
MIME headers for each section, where possible.
reformime replaces all suspect characters with the
underscore character.</dd><dt>-X prog arg1 arg2 ...</dt><dd>
The <code class="option">-X</code> option must be the last option to
reformime. reformime runs an external
program prog, and pipes the contents of the MIME section to
the program. reformime sets the environment variable
<code class="envar">CONTENT_TYPE</code> to the MIME content type. The environment
variable <code class="envar">FILENAME</code> gets set to the default filename of
reformime's liking. If the <code class="option">-s</code> option is
not specified, the program runs once
for every MIME section in the message.
The external program, prog must terminate with a zero
exit status in order for reformime to proceed to the
next MIME section in the message (or the next section specified by
<code class="option">-s</code>).
In any case, if prog terminates with a non-zero exit
status, reformime terminates with the exit status of
20 plus prog's exit status.</dd></dl></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3>
reformime extracts every MIME section in the message
unless the <code class="option">-s</code> option is specified.
This includes even the <code class="literal">text/plain</code> MIME
content that usually precedes a binary attachment.</div></div><div class="refsect2"><a id="idm255218960144" shape="rect"> </a><h3>Adding RFC 2045 MIME headers</h3>
The <code class="option">-r</code> option performs the following actions:
If there is no <code class="literal">Mime-Version:</code>,
<code class="literal">Content-Type:</code>, or
<code class="literal">Content-Transfer-Encoding:</code> header,
reformime adds one.
If the <code class="literal">Content-Transfer-Encoding:</code> header contains
<code class="literal">8bit</code> or <code class="literal">raw</code>, but only seven-bit data is
found, reformime changes
the <code class="literal">Content-Transfer-Encoding</code> header to
<code class="literal">7bit</code>.<code class="option">-r7</code> does the same thing, but also converts
<code class="literal">8bit</code>-encoded content that contains eight-bit characters to
<code class="literal">quoted-printable</code> encoding.<code class="option">-r8</code> does the same thing, but also converts
<code class="literal">quoted-printable</code>-encoded content to
<code class="literal">8bit</code>, except in some situations.</div><div class="refsect2"><a id="idm255220933056" shape="rect"> </a><h3>Creating <code class="literal">multipart/digest</code> MIME digests</h3>The <code class="option">-m</code> option creates a MIME digest.
reformime reads a list of filenames on standard input.
Each line read from standard input contains the name of a file that is
presumed to contain an RFC 2822-formatted message.
reformime splices all files into a
multipart/digest MIME section,
and writes it to standard output.</div><div class="refsect2"><a id="idm255222147536" shape="rect"> </a><h3>Translating MIME headers</h3>
The following options do not read a message from standard input.
These options process MIME headers via the command line, and are designed
to be conveniently used by mail-handling scripts.<div class="variablelist"><dl class="variablelist"><dt>-h "<code>header</code>"</dt><dd>
Decode a MIME-encoded "<code>header</code>" and print the
decoded 8-bit content on standard output.
The decoding gets carried out as if the contents occurred in the
“Subject” header.
Example:<div class="informalexample"><pre class="programlisting" xml:space="preserve">
$ reformime -h '=?iso-8859-1?Q?H=F3la!?='
Hóla!
</pre></div></dd><dt>-H "<code>header</code>"</dt><dd>
Like <code class="option">-h</code> except that <code>header</code> is
parsed as a list of
email addresses, like “From” or “To”.</dd><dt>-o "<code>text</code>"</dt><dd>
MIME-encode "<code>text</code>", and print the results
on standard output.</dd><dt>-O "<code>text</code>"</dt><dd>
Like the <code class="option">-o option</code>, except that
<code>text</code>
is a structured header with RFC 2822 addresses.</dd><dt>-c "<code>charset</code>"</dt><dd>
	 Use <code>charset</code> as the character set
	 setting, by the
	 <code class="option">-h</code>,
	 <code class="option">-H</code>,
	 <code class="option">-o</code> and
	 <code class="option">-O</code> options.
	 </dd><dt>-u</dt><dd>
	 This “undocumented” option reads a MIME message on
	 standard input, and converts its contents to an UTF-8-encoded
	 character stream, which is written to standard output.
	 
	 The standard output receives a concatenated amalgam of the
	 headers and “text” MIME object data. It is meant to
	 be used as part of a generic search function. This option
	 decodes various kinds of header MIME encoding, the
	 <code class="literal">quoted-printable</code> and <code class="literal">base64</code>
	 transfer encodings of “text” MIME objects.
	 </dd></dl></div></div></div><div class="refsect1"><a id="idm255221166624" shape="rect"> </a><h2>SEE ALSO</h2>
<a class="ulink" href="reformail.html" target="_top" shape="rect">reformail(1)</a>,
sendmail(8),
<a class="ulink" href="mailbot.html" target="_top" shape="rect">mailbot(1)</a>,
<a class="ulink" href="maildrop.html" target="_top" shape="rect">maildrop(1)</a>,
<a class="ulink" href="maildropfilter.html" target="_top" shape="rect">maildropfilter(5)</a>,
egrep(1),
grep(1),
sendmail(8).</div></div></body></html>