Barry Warsaw avatar Barry Warsaw committed bc183b5

Updated docs for email.Message.get_filename()

Comments (0)

Files changed (1)

Doc/lib/emailmessage.tex

 
 \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}}
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.