blob: 6b1d20916199fe32e2c2109e105b1a35a08f7386 [file] [log] [blame]
Fred Draked59db4f1998-04-03 07:06:56 +00001\section{Standard Module \module{quopri}}
Fred Drakeb91e9341998-07-23 17:59:49 +00002\declaremodule{standard}{quopri}
3
4\modulesynopsis{Encode/decode binary files using the MIME quoted-printable encoding.}
5
Guido van Rossume76b7a81997-04-27 21:25:52 +00006
7This module performs quoted-printable transport encoding and decoding,
Fred Drakec5891241998-02-09 19:16:20 +00008as defined in \rfc{1521}: ``MIME (Multipurpose Internet Mail Extensions)
Guido van Rossume76b7a81997-04-27 21:25:52 +00009Part One''. The quoted-printable encoding is designed for data where
Fred Draked59db4f1998-04-03 07:06:56 +000010there are relatively few nonprintable characters; the base64 encoding
11scheme available via the \module{base64} module is more compact if there
Guido van Rossume76b7a81997-04-27 21:25:52 +000012are many such characters, as when sending a graphics file.
Fred Draked59db4f1998-04-03 07:06:56 +000013\indexii{quoted-printable}{encoding}
Guido van Rossume76b7a81997-04-27 21:25:52 +000014\index{MIME!quoted-printable encoding}
15
Fred Drake798654f1997-11-30 05:53:22 +000016
Fred Drakecce10901998-03-17 06:33:25 +000017\begin{funcdesc}{decode}{input, output}
Guido van Rossume76b7a81997-04-27 21:25:52 +000018Decode the contents of the \var{input} file and write the resulting
19decoded binary data to the \var{output} file.
20\var{input} and \var{output} must either be file objects or objects that
21mimic the file object interface. \var{input} will be read until
22\code{\var{input}.read()} returns an empty string.
23\end{funcdesc}
24
Fred Drakecce10901998-03-17 06:33:25 +000025\begin{funcdesc}{encode}{input, output, quotetabs}
Guido van Rossume76b7a81997-04-27 21:25:52 +000026Encode the contents of the \var{input} file and write the resulting
27quoted-printable data to the \var{output} file.
28\var{input} and \var{output} must either be file objects or objects that
29mimic the file object interface. \var{input} will be read until
30\code{\var{input}.read()} returns an empty string.
31\end{funcdesc}
32
33
34