[Python-checkins] r42082 - python/branches/release24-maint/Doc/lib/emailmessage.tex

[barry.warsaw]

Author: barry.warsaw
Date: Tue Jan 17 06:29:56 2006
New Revision: 42082

Modified:
   python/branches/release24-maint/Doc/lib/emailmessage.tex
Log:
Update documentation for email.Message.get_filename().


Modified: python/branches/release24-maint/Doc/lib/emailmessage.tex
==============================================================================
--- python/branches/release24-maint/Doc/lib/emailmessage.tex	(original)
+++ python/branches/release24-maint/Doc/lib/emailmessage.tex	Tue Jan 17 06:29:56 2006
@@ -435,10 +435,11 @@
 
 \begin{methoddesc}[Message]{get_filename}{\optional{failobj}}
 Return the value of the \code{filename} parameter of the
-\mailheader{Content-Disposition} header of the message, or \var{failobj} if
-either the header is missing, or has no \code{filename} parameter.
-The returned string will always be unquoted as per
-\method{Utils.unquote()}.
+\mailheader{Content-Disposition} header of the message.  If the header does
+not have a \code{filename} parameter, this method falls back to looking for
+the \code{name} parameter.  If neither is found, or the header is missing,
+then \var{failobj} is returned.  The returned string will always be unquoted
+as per \method{Utils.unquote()}.
 \end{methoddesc}
 
 \begin{methoddesc}[Message]{get_boundary}{\optional{failobj}}