+++ /dev/null
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
- "file:///usr/share/xml/docbook/schema/dtd/4.5/docbookx.dtd">
-
-<refentry id="mimedecode.py">
-
-<refentryinfo>
- <title>mimedecode.py</title>
- <productname>mimedecode.docbook</productname>
- <author>
- <firstname>Oleg</firstname>
- <surname>Broytman</surname>
- <email>phd@phdru.name</email>
- <personblurb/>
- </author>
- <copyright>
- <year>2001-2014</year>
- <holder>PhiloSoft Design.</holder>
- </copyright>
-</refentryinfo>
-
-<refmeta>
- <refentrytitle>mimedecode.py</refentrytitle>
- <manvolnum>1</manvolnum>
-</refmeta>
-
-<refnamediv>
- <refname>mimedecode.py</refname>
- <refpurpose>decode MIME message</refpurpose>
-</refnamediv>
-
-<refsynopsisdiv>
- <cmdsynopsis>
- <command>mimedecode.py</command>
- <arg choice="opt">
- <option>-h|--help</option>
- </arg>
- <arg choice="opt">
- <option>-V|--version</option>
- </arg>
- <arg choice="opt">
- <option>-cCDP</option>
- </arg>
- <arg choice="opt">
- <option>-f charset</option>
- </arg>
- <arg choice="opt">
- <option>-H|--host=hostname</option>
- </arg>
- <arg choice="opt">
- <option>-d header</option>
- </arg>
- <arg choice="opt">
- <option>-p header:param</option>
- </arg>
- <arg choice="opt">
- <option>-beit mask</option>
- </arg>
- <arg choice="opt">
- <option>-o output_file</option>
- </arg>
- <arg choice="opt">input_file
- <arg choice="opt">output_file</arg>
- </arg>
- </cmdsynopsis>
-</refsynopsisdiv>
-
-
-<refsect1>
-<title>DESCRIPTION</title>
-<para>
- Mail users, especially in non-English countries, often find that mail
-messages arrived in different formats, with different content types, in
-different encodings and charsets. Usually it is good because it allows to use
-an appropriate format/encoding/whatever. Sometimes, though, some unification is
-desirable. For example, one may want to put mail messages into an archive,
-make HTML indices, run search indexer, etc. In such situations converting
-messages to text in one character set and skipping some binary attachments is
-much desirable.
-</para>
-
-<para>
- Here is the solution - mimedecode.py!
-</para>
-
-<para>
- This is a program to decode MIME messages. The program expects one input
-file (either on command line or on stdin) which is treated as an RFC822
-message, and decodes to stdout or an output file. If the file is not an RFC822
-message it is just copied to the output one-to-one. If the file is a simple
-RFC822 message it is decoded as one part. If it is a MIME message with multiple
-parts ("attachments") all parts are decoded. Decoding can be controlled by
-command-line options.
-</para>
-
-<para>
- First, Subject and Content-Disposition headers are examined. If any of those
- exists, it is decoded according to RFC2047. Content-Disposition header is
- not decoded - only its "filename" parameter. Encoded header parameters
- violate the RFC, but widely deployed anyway by ignorant coders who never
- even heard about RFCs. Correct parameter encoding specified by RFC2231. This
- program decodes RFC2231-encoded parameters, too.
-</para>
-
-<para>
- Then the body of the message (or the current part) is decoded. Decoding
- starts with looking at header Content-Transfer-Encoding. If the header
- specifies non-8bit encoding (usually base64 or quoted-printable), the body
- converted to 8bit. Then, if its content type is multipart (multipart/related
- or multipart/mixed, e.g) every part is recursively decoded. If it is not
- multipart, mailcap database is consulted to find a way to convert the body
- to plain text. (I have no idea how mailcap can be configured on OSes other
- than POSIX, please don't ask me; real OS users can consult my example at
- <ulink url="http://phdru.name/Software/dotfiles/mailcap.html">http://phdru.name/Software/dotfiles/mailcap.html</ulink>).
- The decoding process uses the first copiousoutput filter it can find. If
- there are no filters the body just passed as is.
-</para>
-
-<para>
- Then Content-Type header is consulted for charset. If it is not equal to the
- current locale charset and recoding is allowed the body text is recoded.
- Finally message headers and the body are flushed to stdout.
-</para>
-</refsect1>
-
-
-<refsect1>
-<title>OPTIONS</title>
-<variablelist>
- <varlistentry>
- <term>-h</term>
- <term>-help</term>
- <listitem>
- <para>
- Print brief usage help and exit.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-V</term>
- <term>--version</term>
- <listitem>
- <para>
- Print version and exit.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-c</term>
- <listitem>
- <para>
- Recode different character sets in message bodies to the current
- default charset; this is the default.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-C</term>
- <listitem>
- <para>
- Do not recode character sets in message bodies.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-f charset</term>
- <listitem>
- <para>
- Force this charset to be the current default charset instead of
- the current locale.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-H hostname</term>
- <term>--host=hostname</term>
- <listitem>
- <para>
- Use this hostname in X-MIME-Autoconverted headers instead of the
- current hostname.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-d header</term>
- <listitem>
- <para>
- Add the header to a list of headers to decode; initially the list
- contains headers "From", "To", "Cc", "Reply-To" and "Subject".
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-D</term>
- <listitem>
- <para>
- Clear the list of headers to decode (make it empty).
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-p header:param</term>
- <listitem>
- <para>
- Add the pair (header, param) to a list of headers' parameters to
- decode; initially the list contains header "Content-Type",
- parameter "name" and header "Content-Disposition", parameter
- "filename".
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-P</term>
- <listitem>
- <para>
- Clear the list of headers' parameters to decode (make it empty).
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-b mask</term>
- <listitem>
- <para>
- Append mask to the list of binary content types; if the message to
- decode has a part of this type the program will pass the part as is,
- without any additional processing.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-e mask</term>
- <listitem>
- <para>
- Append mask to the list of error content types; if the message to
- decode has a part of this type the program fails with ValueError.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-i mask</term>
- <listitem>
- <para>
- Append mask to the list of content types to ignore; if the message to
- decode has a part of this type the program will not pass it, instead
- a line "Message body of type `%s' skipped." will be issued.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-t mask</term>
- <listitem>
- <para>
- Append mask to the list of content types to convert to text; if the
- message to decode has a part of this type the program will consult
- mailcap database, find first copiousoutput filter and convert the
- part.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-o output_file</term>
- <listitem>
- <para>
- Useful to set the output file in case of redirected stdin:
- <programlisting language="sh">mimedecode.py -o output_file < input_file
-cat input_file | mimedecode.py -o output_file</programlisting>
- </para>
- </listitem>
- </varlistentry>
-</variablelist>
-
-<para>
- The 4 list options (-beit) require more explanation. They allow a user
-to control body decoding with great flexibility. Think about said mail
-archive; for example, its maintainer wants to put there only texts, convert
-Postscript/PDF to text, pass HTML and images as is, and ignore everything
-else. Easy:
-</para>
-
-<para>
-<code language="sh">
- mimedecode.py -t application/postscript -t application/pdf -b text/html
- -b 'image/*' -i '*/*'
-</code>
-</para>
-
-<para>
- When the program decodes a message (non-MIME or a non-multipart subpart of a
- MIME message), it consults Content-Type header. The content type is searched
- in all 4 lists, in order "text-binary-ignore-error". If found, appropriate
- action performed. If not found, the program search the same lists for
- "type/*" mask (the type of "text/html" is just "text"). If found,
- appropriate action performed. If not found, the program search the same
- lists for "*/*" mask. If found, appropriate action performed. If not found,
- the program uses default action, which is to decode everything to text (if
- mailcap specifies a filter).
-</para>
-
-<para>
- Initially all 4 lists are empty, so without any additional parameters
-the program always uses the default decoding.
-</para>
-</refsect1>
-
-
-<refsect1>
-<title>ENVIRONMENT</title>
-<variablelist>
- <varlistentry><term>LANG</term></varlistentry>
- <varlistentry><term>LC_ALL</term></varlistentry>
- <varlistentry><term>LC_CTYPE</term></varlistentry>
-</variablelist>
-<para>
- Define current locale settings. Used to determine current default charset (if
- your Python is properly installed and configured).
-</para>
-</refsect1>
-
-
-<refsect1>
-<title>BUGS</title>
-<para>
- The program may produce incorrect MIME message. The purpose of the program
- is to decode whatever it is possible to decode, not to produce absolutely
- correct MIME output. The incorrect parts are obvious - decoded
- From/To/Cc/Reply-To/Subject headers and filenames. Other than that output is
- correct MIME message. The program does not try to guess whether the headers
- are correct. For example, if a message header states that charset is
- iso8859-5, but the body is actually in utf-8 the program will recode the
- message with the wrong charset.
-</para>
-</refsect1>
-
-
-<refsect1>
-<title>AUTHOR</title>
-<para>
- <firstname>Oleg</firstname>
- <surname>Broytman</surname>
- <email>phd@phdru.name</email>
-</para>
-</refsect1>
-
-
-<refsect1>
-<title>COPYRIGHT</title>
-<para>
- Copyright (C) 2001-2014 PhiloSoft Design.
-</para>
-</refsect1>
-
-
-<refsect1>
-<title>LICENSE</title>
-<para>
- GNU GPL
-</para>
-</refsect1>
-
-
-<refsect1>
-<title>NO WARRANTIES</title>
-<para>
- This program is distributed in the hope that it will be useful, but WITHOUT
- ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
- more details.
-</para>
-</refsect1>
-
-
-<refsect1>
-<title>SEE ALSO</title>
-<para>
- mimedecode.py home page:
- <ulink url="http://phdru.name/Software/Python/#mimedecode">http://phdru.name/Software/Python/#mimedecode</ulink>
-</para>
-</refsect1>
-
-</refentry>
projects / mimedecode.git / blobdiff