Added 'description' class attribute to every command class (to help the
[python/dscho.git] / Doc / lib / libquopri.tex
blob9cc88003f9ff1f07eb9477f2704a915fe23b1bd4
1 \section{\module{quopri} ---
2 Encode and decode MIME quoted-printable data}
4 \declaremodule{standard}{quopri}
5 \modulesynopsis{Encode and decode files using the MIME
6 quoted-printable encoding.}
9 This module performs quoted-printable transport encoding and decoding,
10 as defined in \rfc{1521}: ``MIME (Multipurpose Internet Mail Extensions)
11 Part One''. The quoted-printable encoding is designed for data where
12 there are relatively few nonprintable characters; the base64 encoding
13 scheme available via the \refmodule{base64} module is more compact if there
14 are many such characters, as when sending a graphics file.
15 \indexii{quoted-printable}{encoding}
16 \index{MIME!quoted-printable encoding}
19 \begin{funcdesc}{decode}{input, output}
20 Decode the contents of the \var{input} file and write the resulting
21 decoded binary data to the \var{output} file.
22 \var{input} and \var{output} must either be file objects or objects that
23 mimic the file object interface. \var{input} will be read until
24 \code{\var{input}.read()} returns an empty string.
25 \end{funcdesc}
27 \begin{funcdesc}{encode}{input, output, quotetabs}
28 Encode the contents of the \var{input} file and write the resulting
29 quoted-printable data to the \var{output} file.
30 \var{input} and \var{output} must either be file objects or objects that
31 mimic the file object interface. \var{input} will be read until
32 \code{\var{input}.read()} returns an empty string.
33 \end{funcdesc}