X-Git-Url: https://git.phdru.name/?a=blobdiff_plain;f=mimedecode.docbook;h=83b0e54cd213791c4a1f40517d07b2ed43fc5345;hb=5a0b966d01b89f668ce0cea40208d511e1bc04f7;hp=8fda9a21cb1510165bd7b48fda1a846d05021847;hpb=eefabcd05d2257ff8de79d5d291f721e06a3c827;p=mimedecode.git diff --git a/mimedecode.docbook b/mimedecode.docbook index 8fda9a2..83b0e54 100644 --- a/mimedecode.docbook +++ b/mimedecode.docbook @@ -53,6 +53,12 @@ + + + + + + @@ -70,13 +76,13 @@ DESCRIPTION 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. + 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. @@ -85,21 +91,23 @@ much desirable. 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. + 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. - 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. + First, for every part the program removes headers and parameters listed with + -r and -R options. Then, Subject and Content-Disposition headers (and all + headers listed with -d and -p options) are examined. If any of those exists, + they are 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. @@ -211,7 +219,7 @@ command-line options. -p header:param - Add the pair (header, param) to a list of headers' parameters to + 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". @@ -223,7 +231,27 @@ command-line options. -P - Clear the list of headers' parameters to decode (make it empty). + Clear the list of headers parameters to decode (make it empty). + + + + + + -r header + + + Add the header to a list of headers to remove completely; initially + the list is empty. + + + + + + -R header:param + + + Add the pair (header, param) to a list of headers parameters to + remove; initially the list is empty. @@ -285,11 +313,11 @@ cat input_file | mimedecode.py -o output_file - 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: + 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: