blob: e379e4add3546f42e09ce99946947630d6563509 [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,
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
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}
Guido van Rossume76b7a81997-04-27 21:25:52 +000012\index{MIME!quoted-printable encoding}
13
Fred Drake19479911998-02-13 06:58:54 +000014\setindexsubitem{(in module quopri)}
Fred Drake798654f1997-11-30 05:53:22 +000015
Fred Drakecce10901998-03-17 06:33:25 +000016\begin{funcdesc}{decode}{input, output}
Guido van Rossume76b7a81997-04-27 21:25:52 +000017Decode the contents of the \var{input} file and write the resulting
18decoded binary data to the \var{output} file.
19\var{input} and \var{output} must either be file objects or objects that
20mimic the file object interface. \var{input} will be read until
21\code{\var{input}.read()} returns an empty string.
22\end{funcdesc}
23
Fred Drakecce10901998-03-17 06:33:25 +000024\begin{funcdesc}{encode}{input, output, quotetabs}
Guido van Rossume76b7a81997-04-27 21:25:52 +000025Encode the contents of the \var{input} file and write the resulting
26quoted-printable data to the \var{output} file.
27\var{input} and \var{output} must either be file objects or objects that
28mimic the file object interface. \var{input} will be read until
29\code{\var{input}.read()} returns an empty string.
30\end{funcdesc}
31
32
33