X-Git-Url: https://git.phdru.name/?a=blobdiff_plain;f=mimedecode.docbook;h=75ec36798b496bf80a167002f8ee25719b07043f;hb=3c86e4400fa8a21b6f390d5355c803ab6b5ffe12;hp=87bd3643cb7b2def88c2681e56554723da608a13;hpb=eff0fc85b15fae0cb100cbd7bc5b25a6bed941e8;p=mimedecode.git diff --git a/mimedecode.docbook b/mimedecode.docbook index 87bd364..75ec367 100644 --- a/mimedecode.docbook +++ b/mimedecode.docbook @@ -48,17 +48,31 @@ - + - + - + + + + + + + + + + + + + + + @@ -76,13 +90,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. @@ -91,21 +105,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. @@ -129,6 +145,13 @@ command-line options. + + + Please be warned that in the following options asterisk is a shell + metacharacter and should be escaped or quoted. Either write -d \*,-h1,-h2 + or -d '*,-h1,-h2' or such. + + OPTIONS @@ -194,12 +217,25 @@ command-line options. - -d header + -d header1[,header2,header3...] - Add the header to a list of headers to decode; initially the list - contains headers "From", "To", "Cc", "Reply-To", "Mail-Followup-To" - and "Subject". + Add the header(s) to a list of headers to decode; initially the + list contains headers "From", "To", "Cc", "Reply-To", + "Mail-Followup-To" and "Subject". + + + + + + -d *[,-header1,-header2,-header3...] + + + This variant completely changes headers decoding. First, the list of + headers to decode is cleared. Then all the headers are decoded + except the given list of exceptions (headers listed with '-'). In + this mode it would be meaningless to give more than one -d options + but the program doesn't enforce it. @@ -214,13 +250,42 @@ command-line options. - -p header:param + -p header1[,header2,header3,...]:param1[,param2,param3,...] - 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". + Add the parameters(s) to a list of headers parameters to decode; + the parameters will be decoded only for the given header(s). + Initially the list contains header "Content-Type", parameter "name"; + and header "Content-Disposition", parameter "filename". + + + + + + -p *[,-header1,-header2,-header3,...]:param1[,param2,param3,...] + + + Add the parameters(s) to a list of headers parameters to decode; + the parameters will be decoded for all headers except the given + ones. + + + + + + -p header1[,header2,header3,...]:*[,-param1,-param2,-param3,...] + + + Decode all parameters except listed for the given list of headers. + + + + + + -p *[,-header1,-header2,-header3,...]:*[,-param1,-param2,-param3,...] + + + Decode all parameters except listed for all headers (except listed). @@ -235,11 +300,20 @@ command-line options. - -r header + -r header1[,header2,header3...] + + + Add the header(s) to a list of headers to remove completely; + initially the list is empty. + + + + + + -r *[,-header1,-header2,-header3...] - Add the header to a list of headers to remove completely; initially - the list is empty. + Remove all headers except listed. @@ -254,6 +328,16 @@ command-line options. + + --remove-params=header + + + Add the header to a list of headers from which all parameters will + be removed; initially the list is empty. + + + + -b mask @@ -311,11 +395,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: