blob: abe07df3289143c53ab854deb538026f581c8c32 [file] [log] [blame]
Fred Draked59db4f1998-04-03 07:06:56 +00001\section{Standard Module \module{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,
Fred Drakec5891241998-02-09 19:16:20 +00006as defined in \rfc{1521}: ``MIME (Multipurpose Internet Mail Extensions)
Guido van Rossume76b7a81997-04-27 21:25:52 +00007Part One''. The quoted-printable encoding is designed for data where
Fred Draked59db4f1998-04-03 07:06:56 +00008there are relatively few nonprintable characters; the base64 encoding
9scheme available via the \module{base64} module is more compact if there
Guido van Rossume76b7a81997-04-27 21:25:52 +000010are many such characters, as when sending a graphics file.
Fred Draked59db4f1998-04-03 07:06:56 +000011\indexii{quoted-printable}{encoding}
Guido van Rossume76b7a81997-04-27 21:25:52 +000012\index{MIME!quoted-printable encoding}
13
Fred Drake798654f1997-11-30 05:53:22 +000014
Fred Drakecce10901998-03-17 06:33:25 +000015\begin{funcdesc}{decode}{input, output}
Guido van Rossume76b7a81997-04-27 21:25:52 +000016Decode 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
Fred Drakecce10901998-03-17 06:33:25 +000023\begin{funcdesc}{encode}{input, output, quotetabs}
Guido van Rossume76b7a81997-04-27 21:25:52 +000024Encode 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