blob: 176aeea7b6b848f6c2f15044668943f7b9f3e5fa [file] [log] [blame]
Fred Drake295da241998-08-10 19:42:37 +00001\section{\module{quopri} ---
Fred Drake180b68b1999-02-22 13:45:09 +00002 Encode and decode MIME quoted-printable data}
Fred Drakeb91e9341998-07-23 17:59:49 +00003
Fred Drake180b68b1999-02-22 13:45:09 +00004\declaremodule{standard}{quopri}
Fred Drake295da241998-08-10 19:42:37 +00005\modulesynopsis{Encode and decode files using the MIME
Fred Drakeffbe6871999-04-22 21:23:22 +00006 quoted-printable encoding.}
Fred Drakeb91e9341998-07-23 17:59:49 +00007
Guido van Rossume76b7a81997-04-27 21:25:52 +00008
9This module performs quoted-printable transport encoding and decoding,
Fred Drakec5891241998-02-09 19:16:20 +000010as defined in \rfc{1521}: ``MIME (Multipurpose Internet Mail Extensions)
Guido van Rossume76b7a81997-04-27 21:25:52 +000011Part One''. The quoted-printable encoding is designed for data where
Fred Draked59db4f1998-04-03 07:06:56 +000012there are relatively few nonprintable characters; the base64 encoding
Fred Drakeffbe6871999-04-22 21:23:22 +000013scheme available via the \refmodule{base64} module is more compact if there
Guido van Rossume76b7a81997-04-27 21:25:52 +000014are many such characters, as when sending a graphics file.
Fred Draked59db4f1998-04-03 07:06:56 +000015\indexii{quoted-printable}{encoding}
Guido van Rossume76b7a81997-04-27 21:25:52 +000016\index{MIME!quoted-printable encoding}
17
Fred Drake798654f1997-11-30 05:53:22 +000018
Fred Drakecce10901998-03-17 06:33:25 +000019\begin{funcdesc}{decode}{input, output}
Guido van Rossume76b7a81997-04-27 21:25:52 +000020Decode the contents of the \var{input} file and write the resulting
21decoded binary data to the \var{output} file.
22\var{input} and \var{output} must either be file objects or objects that
23mimic the file object interface. \var{input} will be read until
24\code{\var{input}.read()} returns an empty string.
25\end{funcdesc}
26
Fred Drakecce10901998-03-17 06:33:25 +000027\begin{funcdesc}{encode}{input, output, quotetabs}
Guido van Rossume76b7a81997-04-27 21:25:52 +000028Encode the contents of the \var{input} file and write the resulting
29quoted-printable data to the \var{output} file.
30\var{input} and \var{output} must either be file objects or objects that
31mimic the file object interface. \var{input} will be read until
32\code{\var{input}.read()} returns an empty string.
33\end{funcdesc}
34
35
Fred Drake12ed3652000-04-04 20:43:50 +000036\begin{seealso}
37 \seemodule{mimify}{General utilities for processing of MIME messages.}
38\end{seealso}