mimedecode.docbook

   1 <?xml version="1.0" standalone="no"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "file:///usr/share/xml/docbook/schema/dtd/4.5/docbookx.dtd">
   4
   5 <refentry id="mimedecode.py">
   6
   7 <refentryinfo>
   8   <title>mimedecode.py</title>
   9   <productname>mimedecode.docbook</productname>
  10   <author>
  11     <firstname>Oleg</firstname>
  12     <surname>Broytman</surname>
  13     <email>phd@phdru.name</email>
  14     <personblurb/>
  15   </author>
  16   <copyright>
  17     <year>2001-2014</year>
  18     <holder>PhiloSoft Design.</holder>
  19   </copyright>
  20 </refentryinfo>
  21
  22 <refmeta>
  23    <refentrytitle>mimedecode.py</refentrytitle>
  24    <manvolnum>1</manvolnum>
  25 </refmeta>
  26
  27 <refnamediv>
  28    <refname>mimedecode.py</refname>
  29    <refpurpose>decode MIME message</refpurpose>
  30 </refnamediv>
  31
  32 <refsynopsisdiv>
  33    <cmdsynopsis>
  34       <command>mimedecode.py</command>
  35       <arg choice="opt">
  36          <option>-h|--help</option>
  37       </arg>
  38       <arg choice="opt">
  39          <option>-V|--version</option>
  40       </arg>
  41       <arg choice="opt">
  42          <option>-cCDP</option>
  43       </arg>
  44       <arg choice="opt">
  45          <option>-f charset</option>
  46       </arg>
  47       <arg choice="opt">
  48          <option>-H|--host=hostname</option>
  49       </arg>
  50       <arg choice="opt">
  51          <option>-d header</option>
  52       </arg>
  53       <arg choice="opt">
  54          <option>-p header:param</option>
  55       </arg>
  56       <arg choice="opt">
  57          <option>-beit mask</option>
  58       </arg>
  59       <arg choice="opt">
  60          <option>-o output_file</option>
  61       </arg>
  62       <arg choice="opt">input_file
  63         <arg choice="opt">output_file</arg>
  64       </arg>
  65    </cmdsynopsis>
  66 </refsynopsisdiv>
  67
  68
  69 <refsect1>
  70 <title>DESCRIPTION</title>
  71 <para>
  72    Mail users, especially in non-English countries, often find that mail
  73 messages arrived in different formats, with different content types, in
  74 different encodings and charsets. Usually it is good because it allows to use
  75 an appropriate format/encoding/whatever. Sometimes, though, some unification is
  76 desirable. For example, one may want to put mail messages into an archive,
  77 make HTML indices, run search indexer, etc. In such situations converting
  78 messages to text in one character set and skipping some binary attachments is
  79 much desirable.
  80 </para>
  81
  82 <para>
  83    Here is the solution - mimedecode.py!
  84 </para>
  85
  86 <para>
  87    This is a program to decode MIME messages. The program expects one input
  88 file (either on command line or on stdin) which is treated as an RFC822
  89 message, and decodes to stdout or an output file. If the file is not an RFC822
  90 message it is just copied to the output one-to-one. If the file is a simple
  91 RFC822 message it is decoded as one part. If it is a MIME message with multiple
  92 parts ("attachments") all parts are decoded. Decoding can be controlled by
  93 command-line options.
  94 </para>
  95
  96 <para>
  97    First, Subject and Content-Disposition headers are examined. If any of those
  98    exists, it is decoded according to RFC2047. Content-Disposition header is
  99    not decoded - only its "filename" parameter. Encoded header parameters
 100    violate the RFC, but widely deployed anyway by ignorant coders who never
 101    even heard about RFCs. Correct parameter encoding specified by RFC2231. This
 102    program decodes RFC2231-encoded parameters, too.
 103 </para>
 104
 105 <para>
 106    Then the body of the message (or the current part) is decoded. Decoding
 107    starts with looking at header Content-Transfer-Encoding. If the header
 108    specifies non-8bit encoding (usually base64 or quoted-printable), the body
 109    converted to 8bit. Then, if its content type is multipart (multipart/related
 110    or multipart/mixed, e.g) every part is recursively decoded. If it is not
 111    multipart, mailcap database is consulted to find a way to convert the body
 112    to plain text. (I have no idea how mailcap can be configured on OSes other
 113    than POSIX, please don't ask me; real OS users can consult my example at
 114    <ulink url="http://phdru.name/Software/dotfiles/mailcap.html">http://phdru.name/Software/dotfiles/mailcap.html</ulink>).
 115    The decoding process uses the first copiousoutput filter it can find. If
 116    there are no filters the body just passed as is.
 117 </para>
 118
 119 <para>
 120    Then Content-Type header is consulted for charset. If it is not equal to the
 121    current locale charset and recoding is allowed the body text is recoded.
 122    Finally message headers and the body are flushed to stdout.
 123 </para>
 124 </refsect1>
 125
 126
 127 <refsect1>
 128 <title>OPTIONS</title>
 129 <variablelist>
 130    <varlistentry>
 131       <term>-h</term>
 132       <term>-help</term>
 133       <listitem>
 134          <para>
 135             Print brief usage help and exit.
 136          </para>
 137       </listitem>
 138    </varlistentry>
 139
 140    <varlistentry>
 141       <term>-V</term>
 142       <term>--version</term>
 143       <listitem>
 144          <para>
 145             Print version and exit.
 146          </para>
 147       </listitem>
 148    </varlistentry>
 149
 150    <varlistentry>
 151       <term>-c</term>
 152       <listitem>
 153          <para>
 154             Recode different character sets in message bodies to the current
 155             default charset; this is the default.
 156          </para>
 157       </listitem>
 158    </varlistentry>
 159
 160    <varlistentry>
 161       <term>-C</term>
 162       <listitem>
 163          <para>
 164             Do not recode character sets in message bodies.
 165          </para>
 166       </listitem>
 167    </varlistentry>
 168
 169    <varlistentry>
 170       <term>-f charset</term>
 171       <listitem>
 172          <para>
 173             Force this charset to be the current default charset instead of
 174             the current locale.
 175          </para>
 176       </listitem>
 177    </varlistentry>
 178
 179    <varlistentry>
 180       <term>-H hostname</term>
 181       <term>--host=hostname</term>
 182       <listitem>
 183          <para>
 184            Use this hostname in X-MIME-Autoconverted headers instead of the
 185            current hostname.
 186          </para>
 187       </listitem>
 188    </varlistentry>
 189
 190    <varlistentry>
 191       <term>-d header</term>
 192       <listitem>
 193          <para>
 194             Add the header to a list of headers to decode; initially the list
 195             contains headers "From", "To", "Cc" and "Subject".
 196          </para>
 197       </listitem>
 198    </varlistentry>
 199
 200    <varlistentry>
 201       <term>-D</term>
 202       <listitem>
 203          <para>
 204             Clear the list of headers to decode (make it empty).
 205          </para>
 206       </listitem>
 207    </varlistentry>
 208
 209    <varlistentry>
 210       <term>-p header:param</term>
 211       <listitem>
 212          <para>
 213             Add the pair (header, param) to a list of headers' parameters to
 214             decode; initially the list contains header "Content-Type",
 215             parameter "name" and header "Content-Disposition", parameter
 216             "filename".
 217          </para>
 218       </listitem>
 219    </varlistentry>
 220
 221    <varlistentry>
 222       <term>-P</term>
 223       <listitem>
 224          <para>
 225             Clear the list of headers' parameters to decode (make it empty).
 226          </para>
 227       </listitem>
 228    </varlistentry>
 229
 230    <varlistentry>
 231       <term>-b mask</term>
 232       <listitem>
 233          <para>
 234             Append mask to the list of binary content types; if the message to
 235             decode has a part of this type the program will pass the part as is,
 236             without any additional processing.
 237          </para>
 238       </listitem>
 239    </varlistentry>
 240
 241    <varlistentry>
 242       <term>-e mask</term>
 243       <listitem>
 244          <para>
 245             Append mask to the list of error content types; if the message to
 246             decode has a part of this type the program fails with ValueError.
 247          </para>
 248       </listitem>
 249    </varlistentry>
 250
 251    <varlistentry>
 252       <term>-i mask</term>
 253       <listitem>
 254          <para>
 255             Append mask to the list of content types to ignore; if the message to
 256             decode has a part of this type the program will not pass it, instead
 257             a line "Message body of type `%s' skipped." will be issued.
 258          </para>
 259       </listitem>
 260    </varlistentry>
 261
 262    <varlistentry>
 263       <term>-t mask</term>
 264       <listitem>
 265          <para>
 266             Append mask to the list of content types to convert to text; if the
 267             message to decode has a part of this type the program will consult
 268             mailcap database, find first copiousoutput filter and convert the
 269             part.
 270          </para>
 271       </listitem>
 272    </varlistentry>
 273
 274    <varlistentry>
 275       <term>-o output_file</term>
 276       <listitem>
 277          <para>
 278             Useful to set the output file in case of redirected stdin:
 279             <programlisting language="sh">mimedecode.py -o output_file &lt; input_file
 280 cat input_file | mimedecode.py -o output_file</programlisting>
 281          </para>
 282       </listitem>
 283    </varlistentry>
 284 </variablelist>
 285
 286 <para>
 287    The 4 list options (-beit) require more explanation. They allow a user
 288 to control body decoding with great flexibility. Think about said mail
 289 archive; for example, its maintainer wants to put there only texts, convert
 290 Postscript/PDF to text, pass HTML and images as is, and ignore everything
 291 else. Easy:
 292 </para>
 293
 294 <para>
 295 <code language="sh">
 296    mimedecode.py -t application/postscript -t application/pdf -b text/html
 297          -b 'image/*' -i '*/*'
 298 </code>
 299 </para>
 300
 301 <para>
 302    When the program decodes a message (non-MIME or a non-multipart subpart of a
 303    MIME message), it consults Content-Type header. The content type is searched
 304    in all 4 lists, in order "text-binary-ignore-error". If found, appropriate
 305    action performed. If not found, the program search the same lists for
 306    "type/*" mask (the type of "text/html" is just "text"). If found,
 307    appropriate action performed. If not found, the program search the same
 308    lists for "*/*" mask. If found, appropriate action performed. If not found,
 309    the program uses default action, which is to decode everything to text (if
 310    mailcap specifies a filter).
 311 </para>
 312
 313 <para>
 314    Initially all 4 lists are empty, so without any additional parameters
 315 the program always uses the default decoding.
 316 </para>
 317 </refsect1>
 318
 319
 320 <refsect1>
 321 <title>ENVIRONMENT</title>
 322 <variablelist>
 323   <varlistentry><term>LANG</term></varlistentry>
 324   <varlistentry><term>LC_ALL</term></varlistentry>
 325   <varlistentry><term>LC_CTYPE</term></varlistentry>
 326 </variablelist>
 327 <para>
 328   Define current locale settings. Used to determine current default charset (if
 329   your Python is properly installed and configured).
 330 </para>
 331 </refsect1>
 332
 333
 334 <refsect1>
 335 <title>BUGS</title>
 336 <para>
 337    The program may produce incorrect MIME message. The purpose of the program
 338    is to decode whatever it is possible to decode, not to produce absolutely
 339    correct MIME output. The incorrect parts are obvious - decoded
 340    From/To/Cc/Subject headers and filenames. Other than that output is correct
 341    MIME message. The program does not try to guess whether the headers are
 342    correct. For example, if a message header states that charset is iso8859-5,
 343    but the body is actually in utf-8 the program will recode the message with
 344    the wrong charset.
 345 </para>
 346 </refsect1>
 347
 348
 349 <refsect1>
 350 <title>AUTHOR</title>
 351 <para>
 352   <firstname>Oleg</firstname>
 353   <surname>Broytman</surname>
 354   <email>phd@phdru.name</email>
 355 </para>
 356 </refsect1>
 357
 358
 359 <refsect1>
 360 <title>COPYRIGHT</title>
 361 <para>
 362   Copyright (C) 2001-2014 PhiloSoft Design.
 363 </para>
 364 </refsect1>
 365
 366
 367 <refsect1>
 368 <title>LICENSE</title>
 369 <para>
 370    GNU GPL
 371 </para>
 372 </refsect1>
 373
 374
 375 <refsect1>
 376 <title>NO WARRANTIES</title>
 377 <para>
 378    This program is distributed in the hope that it will be useful, but WITHOUT
 379    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 380    FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 381    more details.
 382 </para>
 383 </refsect1>
 384
 385
 386 <refsect1>
 387 <title>SEE ALSO</title>
 388 <para>
 389   mimedecode.py home page:
 390   <ulink url="http://phdru.name/Software/Python/#mimedecode">http://phdru.name/Software/Python/#mimedecode</ulink>
 391 </para>
 392 </refsect1>
 393
 394 </refentry>