annotate Doc/lib/libquopri.tex @ 5817:48b94de85bf3 legacy-trunk

Extensive changes by AMK.
author Guido van Rossum <guido@python.org>
date Thu, 17 Jul 1997 16:29:42 +0000
parents 9ca27188da23
children 3468ea8645ca
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5344
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1 \section{Standard Module \sectcode{quopri}}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
2 \stmodindex{quopri}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
3
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
4 This module performs quoted-printable transport encoding and decoding,
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
5 as defined in RFC 1521: ``MIME (Multipurpose Internet Mail Extensions)
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
6 Part One''. The quoted-printable encoding is designed for data where
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
7 there are relatively few nonprintable characters; the base-64 encoding
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
8 scheme available via the \code{base64} module is more compact if there
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
9 are many such characters, as when sending a graphics file.
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
10 \indexii{quoted printable}{encoding}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
11 \indexii{RFC}{1521}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
12 \index{MIME!quoted-printable encoding}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
13
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
14 \begin{funcdesc}{decode}{input\, output}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
15 Decode the contents of the \var{input} file and write the resulting
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
16 decoded binary data to the \var{output} file.
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
17 \var{input} and \var{output} must either be file objects or objects that
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
18 mimic the file object interface. \var{input} will be read until
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
19 \code{\var{input}.read()} returns an empty string.
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
20 \end{funcdesc}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
21
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
22 \begin{funcdesc}{encode}{input\, output\, quotetabs}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
23 Encode the contents of the \var{input} file and write the resulting
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
24 quoted-printable data to the \var{output} file.
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
25 \var{input} and \var{output} must either be file objects or objects that
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
26 mimic the file object interface. \var{input} will be read until
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
27 \code{\var{input}.read()} returns an empty string.
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
28 \end{funcdesc}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
29
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
30
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
31