summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libquopri.tex
blob: a7395ecaaf2e92d66f9524fde05cdb45dc9e0837 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
\section{Standard Module \sectcode{quopri}}
\label{module-quopri}
\stmodindex{quopri}

This module performs quoted-printable transport encoding and decoding,
as defined in RFC 1521: ``MIME (Multipurpose Internet Mail Extensions)
Part One''.  The quoted-printable encoding is designed for data where
there are relatively few nonprintable characters; the base-64 encoding
scheme available via the \code{base64} module is more compact if there
are many such characters, as when sending a graphics file.
\indexii{quoted printable}{encoding}
\indexii{RFC}{1521}
\index{MIME!quoted-printable encoding}

\renewcommand{\indexsubitem}{(in module quopri)}

\begin{funcdesc}{decode}{input\, output}
Decode the contents of the \var{input} file and write the resulting
decoded binary data to the \var{output} file.
\var{input} and \var{output} must either be file objects or objects that
mimic the file object interface. \var{input} will be read until
\code{\var{input}.read()} returns an empty string.
\end{funcdesc}

\begin{funcdesc}{encode}{input\, output\, quotetabs}
Encode the contents of the \var{input} file and write the resulting
quoted-printable data to the \var{output} file.
\var{input} and \var{output} must either be file objects or objects that
mimic the file object interface. \var{input} will be read until
\code{\var{input}.read()} returns an empty string.
\end{funcdesc}