61 lines · 2.7 KB · TeX
RawDownload
\section{\module{quopri} ---         Encode and decode MIME quoted-printable data} \declaremodule{standard}{quopri}\modulesynopsis{Encode and decode files using the MIME                quoted-printable encoding.}  This module performs quoted-printable transport encoding and decoding,as defined in \rfc{1521}: ``MIME (Multipurpose Internet MailExtensions) Part One: Mechanisms for Specifying and Describing theFormat of Internet Message Bodies''.  The quoted-printable encoding isdesigned for data where there are relatively few nonprintablecharacters; the base64 encoding scheme available via the\refmodule{base64} module is more compact if there are many suchcharacters, as when sending a graphics file.\indexii{quoted-printable}{encoding}\index{MIME!quoted-printable encoding}  \begin{funcdesc}{decode}{input, output\optional{,header}}Decode the contents of the \var{input} file and write the resultingdecoded binary data to the \var{output} file.\var{input} and \var{output} must either be file objects or objects thatmimic 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, underscorewill 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}Encode the contents of the \var{input} file and write the resultingquoted-printable data to the \var{output} file.\var{input} and \var{output} must either be file objects or objects thatmimic the file object interface. \var{input} will be read until\code{\var{input}.readline()} returns an empty string.\var{quotetabs} is a flag which controls whether to encode embeddedspaces and tabs; when true it encodes such embedded whitespace, andwhen false it leaves them unencoded.  Note that spaces and tabsappearing at the end of lines are always encoded, as per \rfc{1521}.\end{funcdesc} \begin{funcdesc}{decodestring}{s\optional{,header}}Like \function{decode()}, except that it accepts a source string andreturns the corresponding decoded string.\end{funcdesc} \begin{funcdesc}{encodestring}{s\optional{, quotetabs}}Like \function{encode()}, except that it accepts a source string andreturns the corresponding encoded string.  \var{quotetabs} is optional(defaulting to 0), and is passed straight through to\function{encode()}.\end{funcdesc}  \begin{seealso}  \seemodule{mimify}{General utilities for processing of MIME messages.}  \seemodule{base64}{Encode and decode MIME base64 data}\end{seealso}