diff options
author | cinap_lenrek <cinap_lenrek@localhost> | 2011-05-03 11:25:13 +0000 |
---|---|---|
committer | cinap_lenrek <cinap_lenrek@localhost> | 2011-05-03 11:25:13 +0000 |
commit | 458120dd40db6b4df55a4e96b650e16798ef06a0 (patch) | |
tree | 8f82685be24fef97e715c6f5ca4c68d34d5074ee /sys/src/cmd/python/Doc/lib/libmimify.tex | |
parent | 3a742c699f6806c1145aea5149bf15de15a0afd7 (diff) |
add hg and python
Diffstat (limited to 'sys/src/cmd/python/Doc/lib/libmimify.tex')
-rw-r--r-- | sys/src/cmd/python/Doc/lib/libmimify.tex | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/sys/src/cmd/python/Doc/lib/libmimify.tex b/sys/src/cmd/python/Doc/lib/libmimify.tex new file mode 100644 index 000000000..d99567ab3 --- /dev/null +++ b/sys/src/cmd/python/Doc/lib/libmimify.tex @@ -0,0 +1,94 @@ +\section{\module{mimify} --- + MIME processing of mail messages} + +\declaremodule{standard}{mimify} +\modulesynopsis{Mimification and unmimification of mail messages.} + +\deprecated{2.3}{The \refmodule{email} package should be used in + preference to the \module{mimify} module. This + module is present only to maintain backward + compatibility.} + +The \module{mimify} module defines two functions to convert mail messages to +and from MIME format. The mail message can be either a simple message +or a so-called multipart message. Each part is treated separately. +Mimifying (a part of) a message entails encoding the message as +quoted-printable if it contains any characters that cannot be +represented using 7-bit \ASCII. Unmimifying (a part of) a message +entails undoing the quoted-printable encoding. Mimify and unmimify +are especially useful when a message has to be edited before being +sent. Typical use would be: + +\begin{verbatim} +unmimify message +edit message +mimify message +send message +\end{verbatim} + +The modules defines the following user-callable functions and +user-settable variables: + +\begin{funcdesc}{mimify}{infile, outfile} +Copy the message in \var{infile} to \var{outfile}, converting parts to +quoted-printable and adding MIME mail headers when necessary. +\var{infile} and \var{outfile} can be file objects (actually, any +object that has a \method{readline()} method (for \var{infile}) or a +\method{write()} method (for \var{outfile})) or strings naming the files. +If \var{infile} and \var{outfile} are both strings, they may have the +same value. +\end{funcdesc} + +\begin{funcdesc}{unmimify}{infile, outfile\optional{, decode_base64}} +Copy the message in \var{infile} to \var{outfile}, decoding all +quoted-printable parts. \var{infile} and \var{outfile} can be file +objects (actually, any object that has a \method{readline()} method (for +\var{infile}) or a \method{write()} method (for \var{outfile})) or strings +naming the files. If \var{infile} and \var{outfile} are both strings, +they may have the same value. +If the \var{decode_base64} argument is provided and tests true, any +parts that are coded in the base64 encoding are decoded as well. +\end{funcdesc} + +\begin{funcdesc}{mime_decode_header}{line} +Return a decoded version of the encoded header line in \var{line}. +This only supports the ISO 8859-1 charset (Latin-1). +\end{funcdesc} + +\begin{funcdesc}{mime_encode_header}{line} +Return a MIME-encoded version of the header line in \var{line}. +\end{funcdesc} + +\begin{datadesc}{MAXLEN} +By default, a part will be encoded as quoted-printable when it +contains any non-\ASCII{} characters (characters with the 8th bit +set), or if there are any lines longer than \constant{MAXLEN} characters +(default value 200). +\end{datadesc} + +\begin{datadesc}{CHARSET} +When not specified in the mail headers, a character set must be filled +in. The string used is stored in \constant{CHARSET}, and the default +value is ISO-8859-1 (also known as Latin1 (latin-one)). +\end{datadesc} + +This module can also be used from the command line. Usage is as +follows: +\begin{verbatim} +mimify.py -e [-l length] [infile [outfile]] +mimify.py -d [-b] [infile [outfile]] +\end{verbatim} +to encode (mimify) and decode (unmimify) respectively. \var{infile} +defaults to standard input, \var{outfile} defaults to standard output. +The same file can be specified for input and output. + +If the \strong{-l} option is given when encoding, if there are any lines +longer than the specified \var{length}, the containing part will be +encoded. + +If the \strong{-b} option is given when decoding, any base64 parts will +be decoded as well. + +\begin{seealso} + \seemodule{quopri}{Encode and decode MIME quoted-printable files.} +\end{seealso} |