Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Describe the new `errors' argument to Header.__init__() and 

Header.append()
This commit is contained in:
Barry Warsaw 2002-12-30 19:17:37 +00:00
parent 10ee7a7f15
commit d1adc8a6af
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Doc/lib/emailheaders.tex
View File

@ -48,7 +48,8 @@ embedded ISO-8859-1 character.
Here is the \class{Header} class description: Here is the \class{Header} class description:
\begin{classdesc}{Header}{\optional{s\optional{, charset\optional{, \begin{classdesc}{Header}{\optional{s\optional{, charset\optional{,
maxlinelen\optional{, header_name\optional{, continuation_ws}}}}}} maxlinelen\optional{, header_name\optional{, continuation_ws\optional{,
errors}}}}}}}
Create a MIME-compliant header that can contain strings in different Create a MIME-compliant header that can contain strings in different
character sets. character sets.
@ -79,7 +80,10 @@ whitespace, and is usually either a space or a hard tab character.
This character will be prepended to continuation lines. This character will be prepended to continuation lines.
\end{classdesc} \end{classdesc}
\begin{methoddesc}[Header]{append}{s\optional{, charset}} Optional \var{errors} is passed straight through to the
\method{append()} method.
\begin{methoddesc}[Header]{append}{s\optional{, charset\optional{, errors}}}
Append the string \var{s} to the MIME header. Append the string \var{s} to the MIME header.
Optional \var{charset}, if given, should be a \class{Charset} instance Optional \var{charset}, if given, should be a \class{Charset} instance
@ -100,6 +104,9 @@ case, when producing an \rfc{2822}-compliant header using \rfc{2047}
rules, the Unicode string will be encoded using the following charsets rules, the Unicode string will be encoded using the following charsets
in order: \code{us-ascii}, the \var{charset} hint, \code{utf-8}. The in order: \code{us-ascii}, the \var{charset} hint, \code{utf-8}. The
first character set to not provoke a \exception{UnicodeError} is used. first character set to not provoke a \exception{UnicodeError} is used.
Optional \var{errors} is passed through to any \function{unicode()} or
\function{ustr.encode()} call, and defaults to ``strict''.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}[Header]{encode}{} \begin{methoddesc}[Header]{encode}{}