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/emailencoders.tex | |
parent | 3a742c699f6806c1145aea5149bf15de15a0afd7 (diff) |
add hg and python
Diffstat (limited to 'sys/src/cmd/python/Doc/lib/emailencoders.tex')
-rw-r--r-- | sys/src/cmd/python/Doc/lib/emailencoders.tex | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/sys/src/cmd/python/Doc/lib/emailencoders.tex b/sys/src/cmd/python/Doc/lib/emailencoders.tex new file mode 100644 index 000000000..3d05c2ac3 --- /dev/null +++ b/sys/src/cmd/python/Doc/lib/emailencoders.tex @@ -0,0 +1,47 @@ +\declaremodule{standard}{email.encoders} +\modulesynopsis{Encoders for email message payloads.} + +When creating \class{Message} objects from scratch, you often need to +encode the payloads for transport through compliant mail servers. +This is especially true for \mimetype{image/*} and \mimetype{text/*} +type messages containing binary data. + +The \module{email} package provides some convenient encodings in its +\module{encoders} module. These encoders are actually used by the +\class{MIMEAudio} and \class{MIMEImage} class constructors to provide default +encodings. All encoder functions take exactly one argument, the message +object to encode. They usually extract the payload, encode it, and reset the +payload to this newly encoded value. They should also set the +\mailheader{Content-Transfer-Encoding} header as appropriate. + +Here are the encoding functions provided: + +\begin{funcdesc}{encode_quopri}{msg} +Encodes the payload into quoted-printable form and sets the +\mailheader{Content-Transfer-Encoding} header to +\code{quoted-printable}\footnote{Note that encoding with +\method{encode_quopri()} also encodes all tabs and space characters in +the data.}. +This is a good encoding to use when most of your payload is normal +printable data, but contains a few unprintable characters. +\end{funcdesc} + +\begin{funcdesc}{encode_base64}{msg} +Encodes the payload into base64 form and sets the +\mailheader{Content-Transfer-Encoding} header to +\code{base64}. This is a good encoding to use when most of your payload +is unprintable data since it is a more compact form than +quoted-printable. The drawback of base64 encoding is that it +renders the text non-human readable. +\end{funcdesc} + +\begin{funcdesc}{encode_7or8bit}{msg} +This doesn't actually modify the message's payload, but it does set +the \mailheader{Content-Transfer-Encoding} header to either \code{7bit} or +\code{8bit} as appropriate, based on the payload data. +\end{funcdesc} + +\begin{funcdesc}{encode_noop}{msg} +This does nothing; it doesn't even set the +\mailheader{Content-Transfer-Encoding} header. +\end{funcdesc} |