diff options
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/lib/libbinascii.tex | 20 | ||||
| -rw-r--r-- | Doc/lib/libquopri.tex | 20 |
2 files changed, 33 insertions, 7 deletions
diff --git a/Doc/lib/libbinascii.tex b/Doc/lib/libbinascii.tex index a569a47..0ce0996 100644 --- a/Doc/lib/libbinascii.tex +++ b/Doc/lib/libbinascii.tex @@ -40,6 +40,24 @@ The length of \var{data} should be at most 57 to adhere to the base64 standard. \end{funcdesc} +\begin{funcdesc}{a2b_qp}{string\optional{, header}} +Convert a block of quoted-printable data back to binary and return the +binary data. More than one line may be passed at a time. +If the optional argument \var{header} is present and true, underscores +will be decoded as spaces. +\end{funcdesc} + +\begin{funcdesc}{b2a_qp}{data\optional{, quotetabs, istext, header}} +Convert binary data to a line(s) of \ASCII{} characters in +quoted-printable encoding. The return value is the converted line(s). +If the optional argument \var{quotetabs} is present and true, all tabs +and spaces will be encoded. If the optional argument \var{header} is +present and true, spaces will be encoded as underscores per RFC1522. +If the optional argument \var{header} is present and false, newline +characters will be encoded as well, otherwise linefeed conversion might +corrupt the binary data stream. +\end{funcdesc} + \begin{funcdesc}{a2b_hqx}{string} Convert binhex4 formatted \ASCII{} data to binary, without doing RLE-decompression. The string should contain a complete number of @@ -118,4 +136,6 @@ again. \seemodule{binhex}{Support for the binhex format used on the Macintosh.} \seemodule{uu}{Support for UU encoding used on \UNIX.} + + \seemodule{quopri}{Support for quoted-printable encoding used in MIME email messages. } \end{seealso} diff --git a/Doc/lib/libquopri.tex b/Doc/lib/libquopri.tex index 4079d27..9e7895b 100644 --- a/Doc/lib/libquopri.tex +++ b/Doc/lib/libquopri.tex @@ -7,21 +7,27 @@ 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 base64 encoding -scheme available via the \refmodule{base64} module is more compact if there -are many such characters, as when sending a graphics file. +as defined in \rfc{1521}: ``MIME (Multipurpose Internet Mail +Extensions) Part One: Mechanisms for Specifying and Describing the +Format of Internet Message Bodies''. The quoted-printable encoding is +designed for data where there are relatively few nonprintable +characters; the base64 encoding scheme available via the +\refmodule{base64} module is more compact if there are many such +characters, as when sending a graphics file. \indexii{quoted-printable}{encoding} \index{MIME!quoted-printable encoding} -\begin{funcdesc}{decode}{input, output} +\begin{funcdesc}{decode}{input, output\optional{,header}} 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}.readline()} returns an empty string. +If the optional argument \var{header} is present and true, underscore +will be decoded as space. This is used to decode +``Q''-encoded headers as described in \rfc{1522}: ``MIME (Multipurpose Internet Mail Extensions) +Part Two: Message Header Extensions for Non-ASCII Text''. \end{funcdesc} \begin{funcdesc}{encode}{input, output, quotetabs} @@ -36,7 +42,7 @@ when false it leaves them unencoded. Note that spaces and tabs appearing at the end of lines are always encoded, as per \rfc{1521}. \end{funcdesc} -\begin{funcdesc}{decodestring}{s} +\begin{funcdesc}{decodestring}{s\optional{,header}} Like \function{decode()}, except that it accepts a source string and returns the corresponding decoded string. \end{funcdesc} |