From d1adc8a6af818dddff37735717c4aa6c8c8fcc62 Mon Sep 17 00:00:00 2001 From: Barry Warsaw Date: Mon, 30 Dec 2002 19:17:37 +0000 Subject: [PATCH] Describe the new `errors' argument to Header.__init__() and Header.append() --- Doc/lib/emailheaders.tex | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/Doc/lib/emailheaders.tex b/Doc/lib/emailheaders.tex index 66eb716e97b..8d5964b52af 100644 --- a/Doc/lib/emailheaders.tex +++ b/Doc/lib/emailheaders.tex @@ -48,7 +48,8 @@ embedded ISO-8859-1 character. Here is the \class{Header} class description: \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 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. \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. 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 in order: \code{us-ascii}, the \var{charset} hint, \code{utf-8}. The 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} \begin{methoddesc}[Header]{encode}{}