Guido van Rossum | 20af95b | 1997-03-25 22:01:35 +0000 | [diff] [blame] | 1 | \section{Standard Module \sectcode{mailcap}} |
Guido van Rossum | e47da0a | 1997-07-17 16:34:52 +0000 | [diff] [blame] | 2 | \label{module-mailcap} |
Fred Drake | c589124 | 1998-02-09 19:16:20 +0000 | [diff] [blame] | 3 | \rfcindex{1524} |
Guido van Rossum | 20af95b | 1997-03-25 22:01:35 +0000 | [diff] [blame] | 4 | \stmodindex{mailcap} |
| 5 | \renewcommand{\indexsubitem}{(in module mailcap)} |
| 6 | |
| 7 | Mailcap files are used to configure how MIME-aware applications such |
| 8 | as mail readers and Web browsers react to files with different MIME |
| 9 | types. (The name ``mailcap'' is derived from the phrase ``mail |
| 10 | capability''.) For example, a mailcap file might contain a line like |
Fred Drake | 1656d17 | 1997-12-29 16:55:50 +0000 | [diff] [blame] | 11 | \samp{video/mpeg; xmpeg \%s}. Then, if the user encounters an email |
| 12 | message or Web document with the MIME type video/mpeg, \code{\%s} will be |
Guido van Rossum | 20af95b | 1997-03-25 22:01:35 +0000 | [diff] [blame] | 13 | replaced by a filename (usually one belonging to a temporary file) and |
| 14 | the xmpeg program can be automatically started to view the file. |
| 15 | |
Fred Drake | c589124 | 1998-02-09 19:16:20 +0000 | [diff] [blame] | 16 | The mailcap format is documented in \rfc{1524}, ``A User Agent |
Guido van Rossum | 20af95b | 1997-03-25 22:01:35 +0000 | [diff] [blame] | 17 | Configuration Mechanism For Multimedia Mail Format Information'', but |
| 18 | is not an Internet standard. However, mailcap files are supported on |
Fred Drake | 6862b46 | 1998-01-13 19:03:36 +0000 | [diff] [blame] | 19 | most \UNIX{} systems. |
Guido van Rossum | 20af95b | 1997-03-25 22:01:35 +0000 | [diff] [blame] | 20 | |
| 21 | \begin{funcdesc}{findmatch}{caps\, MIMEtype\, key\, filename\, plist} |
| 22 | Return a 2-tuple; the first element is a string containing the command |
| 23 | line to be executed |
| 24 | (which can be passed to \code{os.system()}), and the second element is |
| 25 | the mailcap entry for a given MIME type. If no matching MIME |
| 26 | type can be found, \code{(None, None)} is returned. |
| 27 | |
Fred Drake | c589124 | 1998-02-09 19:16:20 +0000 | [diff] [blame] | 28 | \var{key} is the name of the field desired, which represents the type |
| 29 | of activity to be performed; the default value is 'view', since in the |
Guido van Rossum | 20af95b | 1997-03-25 22:01:35 +0000 | [diff] [blame] | 30 | most common case you simply want to view the body of the MIME-typed |
| 31 | data. Other possible values might be 'compose' and 'edit', if you |
| 32 | wanted to create a new body of the given MIME type or alter the |
Fred Drake | c589124 | 1998-02-09 19:16:20 +0000 | [diff] [blame] | 33 | existing body data. See \rfc{1524} for a complete list of these |
| 34 | fields. |
Guido van Rossum | 20af95b | 1997-03-25 22:01:35 +0000 | [diff] [blame] | 35 | |
| 36 | \var{filename} is the filename to be substituted for \%s in the |
| 37 | command line; the default value is |
| 38 | \file{/dev/null} which is almost certainly not what you want, so |
| 39 | usually you'll override it by specifying a filename. |
| 40 | |
| 41 | \var{plist} can be a list containing named parameters; the default |
| 42 | value is simply an empty list. Each entry in the list must be a |
Fred Drake | 1656d17 | 1997-12-29 16:55:50 +0000 | [diff] [blame] | 43 | string containing the parameter name, an equals sign (\code{=}), and the |
Guido van Rossum | 20af95b | 1997-03-25 22:01:35 +0000 | [diff] [blame] | 44 | parameter's value. Mailcap entries can contain |
Fred Drake | 1656d17 | 1997-12-29 16:55:50 +0000 | [diff] [blame] | 45 | named parameters like \code{\%\{foo\}}, which will be replaced by the |
Guido van Rossum | 20af95b | 1997-03-25 22:01:35 +0000 | [diff] [blame] | 46 | value of the parameter named 'foo'. For example, if the command line |
Fred Drake | 1656d17 | 1997-12-29 16:55:50 +0000 | [diff] [blame] | 47 | \samp{showpartial \%\{id\} \%\{number\} \%\{total\}} |
Guido van Rossum | 20af95b | 1997-03-25 22:01:35 +0000 | [diff] [blame] | 48 | was in a mailcap file, and \var{plist} was set to \code{['id=1', |
| 49 | 'number=2', 'total=3']}, the resulting command line would be |
| 50 | \code{"showpartial 1 2 3"}. |
| 51 | |
| 52 | In a mailcap file, the "test" field can optionally be specified to |
| 53 | test some external condition (e.g., the machine architecture, or the |
| 54 | window system in use) to determine whether or not the mailcap line |
| 55 | applies. \code{findmatch()} will automatically check such conditions |
| 56 | and skip the entry if the check fails. |
| 57 | \end{funcdesc} |
| 58 | |
| 59 | \begin{funcdesc}{getcaps}{} |
| 60 | Returns a dictionary mapping MIME types to a list of mailcap file |
Fred Drake | 1656d17 | 1997-12-29 16:55:50 +0000 | [diff] [blame] | 61 | entries. This dictionary must be passed to the \code{findmatch()} |
Guido van Rossum | 20af95b | 1997-03-25 22:01:35 +0000 | [diff] [blame] | 62 | function. An entry is stored as a list of dictionaries, but it |
| 63 | shouldn't be necessary to know the details of this representation. |
| 64 | |
| 65 | The information is derived from all of the mailcap files found on the |
| 66 | system. Settings in the user's mailcap file \file{\$HOME/.mailcap} |
| 67 | will override settings in the system mailcap files |
| 68 | \file{/etc/mailcap}, \file{/usr/etc/mailcap}, and |
| 69 | \file{/usr/local/etc/mailcap}. |
| 70 | \end{funcdesc} |
| 71 | |
| 72 | An example usage: |
Guido van Rossum | e47da0a | 1997-07-17 16:34:52 +0000 | [diff] [blame] | 73 | \bcode\begin{verbatim} |
Guido van Rossum | 20af95b | 1997-03-25 22:01:35 +0000 | [diff] [blame] | 74 | >>> import mailcap |
| 75 | >>> d=mailcap.getcaps() |
| 76 | >>> mailcap.findmatch(d, 'video/mpeg', filename='/tmp/tmp1223') |
| 77 | ('xmpeg /tmp/tmp1223', {'view': 'xmpeg %s'}) |
Guido van Rossum | e47da0a | 1997-07-17 16:34:52 +0000 | [diff] [blame] | 78 | \end{verbatim}\ecode |