mirror of
https://github.com/python/cpython.git
synced 2025-12-04 00:30:19 +00:00
Updates do email package documentation for markup, style, and
organization.
This commit is contained in:
parent
c86f6ca2b6
commit
c5f8fe3a27
8 changed files with 156 additions and 220 deletions
|
|
@ -1,16 +1,10 @@
|
|||
\section{\module{email.Encoders} ---
|
||||
Email message payload encoders}
|
||||
|
||||
\declaremodule{standard}{email.Encoders}
|
||||
\modulesynopsis{Encoders for email message payloads.}
|
||||
\sectionauthor{Barry A. Warsaw}{barry@zope.com}
|
||||
|
||||
\versionadded{2.2}
|
||||
|
||||
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 \code{image/*} and \code{text/*} type
|
||||
messages containing binary data.
|
||||
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
|
||||
|
|
@ -18,7 +12,7 @@ The \module{email} package provides some convenient encodings in its
|
|||
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 \code{Content-Transfer-Encoding:} header as appropriate.
|
||||
set the \mailheader{Content-Transfer-Encoding} header as appropriate.
|
||||
|
||||
Here are the encoding functions provided:
|
||||
|
||||
|
|
@ -34,7 +28,7 @@ printable data, but contains a few unprintable characters.
|
|||
|
||||
\begin{funcdesc}{encode_base64}{msg}
|
||||
Encodes the payload into \emph{Base64} form and sets the
|
||||
\code{Content-Transfer-Encoding:} header to
|
||||
\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
|
||||
|
|
@ -43,11 +37,11 @@ renders the text non-human readable.
|
|||
|
||||
\begin{funcdesc}{encode_7or8bit}{msg}
|
||||
This doesn't actually modify the message's payload, but it does set
|
||||
the \code{Content-Transfer-Encoding:} header to either \code{7bit} or
|
||||
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
|
||||
\code{Content-Transfer-Encoding:} header.
|
||||
\mailheader{Content-Transfer-Encoding} header.
|
||||
\end{funcdesc}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue