47 lines · 2.0 KB · TeX
RawDownload
\declaremodule{standard}{email.encoders}\modulesynopsis{Encoders for email message payloads.} When creating \class{Message} objects from scratch, you often need toencode 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 defaultencodings.  All encoder functions take exactly one argument, the messageobject to encode.  They usually extract the payload, encode it, and reset thepayload 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 inthe data.}.This is a good encoding to use when most of your payload is normalprintable 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 payloadis unprintable data since it is a more compact form thanquoted-printable.  The drawback of base64 encoding is that itrenders the text non-human readable.\end{funcdesc} \begin{funcdesc}{encode_7or8bit}{msg}This doesn't actually modify the message's payload, but it does setthe \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}