blob: 2fbd35aa89b46e0b2e58a65b570bd81be0753eec [file] [log] [blame]
Guido van Rossume76b7a81997-04-27 21:25:52 +00001\section{Standard Module \sectcode{quopri}}
Guido van Rossume47da0a1997-07-17 16:34:52 +00002\label{module-quopri}
Guido van Rossume76b7a81997-04-27 21:25:52 +00003\stmodindex{quopri}
4
5This module performs quoted-printable transport encoding and decoding,
6as defined in RFC 1521: ``MIME (Multipurpose Internet Mail Extensions)
7Part One''. The quoted-printable encoding is designed for data where
8there are relatively few nonprintable characters; the base-64 encoding
9scheme available via the \code{base64} module is more compact if there
10are many such characters, as when sending a graphics file.
11\indexii{quoted printable}{encoding}
12\indexii{RFC}{1521}
13\index{MIME!quoted-printable encoding}
14
15\begin{funcdesc}{decode}{input\, output}
16Decode the contents of the \var{input} file and write the resulting
17decoded binary data to the \var{output} file.
18\var{input} and \var{output} must either be file objects or objects that
19mimic the file object interface. \var{input} will be read until
20\code{\var{input}.read()} returns an empty string.
21\end{funcdesc}
22
23\begin{funcdesc}{encode}{input\, output\, quotetabs}
24Encode the contents of the \var{input} file and write the resulting
25quoted-printable data to the \var{output} file.
26\var{input} and \var{output} must either be file objects or objects that
27mimic the file object interface. \var{input} will be read until
28\code{\var{input}.read()} returns an empty string.
29\end{funcdesc}
30
31
32