Guido van Rossum | 470be14 | 1995-03-17 16:07:09 +0000 | [diff] [blame] | 1 | \section{Standard Module \sectcode{mimetools}} |
Guido van Rossum | e47da0a | 1997-07-17 16:34:52 +0000 | [diff] [blame] | 2 | \label{module-mimetools} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 3 | \stmodindex{mimetools} |
Guido van Rossum | 8675115 | 1995-02-28 17:14:32 +0000 | [diff] [blame] | 4 | |
Fred Drake | 1947991 | 1998-02-13 06:58:54 +0000 | [diff] [blame] | 5 | \setindexsubitem{(in module mimetools)} |
Guido van Rossum | 8675115 | 1995-02-28 17:14:32 +0000 | [diff] [blame] | 6 | |
Guido van Rossum | cca8d2b | 1995-03-22 15:48:46 +0000 | [diff] [blame] | 7 | This module defines a subclass of the class \code{rfc822.Message} and |
| 8 | a number of utility functions that are useful for the manipulation for |
| 9 | MIME style multipart or encoded message. |
| 10 | |
| 11 | It defines the following items: |
| 12 | |
| 13 | \begin{funcdesc}{Message}{fp} |
| 14 | Return a new instance of the \code{mimetools.Message} class. This is |
| 15 | a subclass of the \code{rfc822.Message} class, with some additional |
| 16 | methods (see below). |
| 17 | \end{funcdesc} |
| 18 | |
| 19 | \begin{funcdesc}{choose_boundary}{} |
| 20 | Return a unique string that has a high likelihood of being usable as a |
| 21 | part boundary. The string has the form |
| 22 | \code{"\var{hostipaddr}.\var{uid}.\var{pid}.\var{timestamp}.\var{random}"}. |
| 23 | \end{funcdesc} |
| 24 | |
| 25 | \begin{funcdesc}{decode}{input\, output\, encoding} |
| 26 | Read data encoded using the allowed MIME \var{encoding} from open file |
| 27 | object \var{input} and write the decoded data to open file object |
| 28 | \var{output}. Valid values for \var{encoding} include |
| 29 | \code{"base64"}, \code{"quoted-printable"} and \code{"uuencode"}. |
| 30 | \end{funcdesc} |
| 31 | |
| 32 | \begin{funcdesc}{encode}{input\, output\, encoding} |
| 33 | Read data from open file object \var{input} and write it encoded using |
| 34 | the allowed MIME \var{encoding} to open file object \var{output}. |
| 35 | Valid values for \var{encoding} are the same as for \code{decode()}. |
| 36 | \end{funcdesc} |
| 37 | |
| 38 | \begin{funcdesc}{copyliteral}{input\, output} |
Fred Drake | 01dbb88 | 1998-02-13 22:13:07 +0000 | [diff] [blame] | 39 | Read lines until \EOF{} from open file \var{input} and write them to |
| 40 | open file \var{output}. |
Guido van Rossum | cca8d2b | 1995-03-22 15:48:46 +0000 | [diff] [blame] | 41 | \end{funcdesc} |
| 42 | |
| 43 | \begin{funcdesc}{copybinary}{input\, output} |
Fred Drake | 01dbb88 | 1998-02-13 22:13:07 +0000 | [diff] [blame] | 44 | Read blocks until \EOF{} from open file \var{input} and write them to |
| 45 | open file \var{output}. The block size is currently fixed at 8192. |
Guido van Rossum | cca8d2b | 1995-03-22 15:48:46 +0000 | [diff] [blame] | 46 | \end{funcdesc} |
| 47 | |
| 48 | |
Guido van Rossum | ecde781 | 1995-03-28 13:35:14 +0000 | [diff] [blame] | 49 | \subsection{Additional Methods of Message objects} |
Guido van Rossum | cca8d2b | 1995-03-22 15:48:46 +0000 | [diff] [blame] | 50 | \nodename{mimetools.Message Methods} |
| 51 | |
| 52 | The \code{mimetools.Message} class defines the following methods in |
| 53 | addition to the \code{rfc822.Message} class: |
| 54 | |
Fred Drake | 1947991 | 1998-02-13 06:58:54 +0000 | [diff] [blame] | 55 | \setindexsubitem{(mimetool.Message method)} |
Guido van Rossum | cca8d2b | 1995-03-22 15:48:46 +0000 | [diff] [blame] | 56 | |
| 57 | \begin{funcdesc}{getplist}{} |
| 58 | Return the parameter list of the \code{Content-type} header. This is |
| 59 | a list if strings. For parameters of the form |
| 60 | \samp{\var{key}=\var{value}}, \var{key} is converted to lower case but |
| 61 | \var{value} is not. For example, if the message contains the header |
| 62 | \samp{Content-type: text/html; spam=1; Spam=2; Spam} then |
| 63 | \code{getplist()} will return the Python list \code{['spam=1', |
| 64 | 'spam=2', 'Spam']}. |
| 65 | \end{funcdesc} |
| 66 | |
| 67 | \begin{funcdesc}{getparam}{name} |
| 68 | Return the \var{value} of the first parameter (as returned by |
| 69 | \code{getplist()} of the form \samp{\var{name}=\var{value}} for the |
| 70 | given \var{name}. If \var{value} is surrounded by quotes of the form |
Fred Drake | 01dbb88 | 1998-02-13 22:13:07 +0000 | [diff] [blame] | 71 | `\code{<}...\code{>}' or `\code{"}...\code{"}', these are removed. |
Guido van Rossum | cca8d2b | 1995-03-22 15:48:46 +0000 | [diff] [blame] | 72 | \end{funcdesc} |
| 73 | |
| 74 | \begin{funcdesc}{getencoding}{} |
| 75 | Return the encoding specified in the \samp{Content-transfer-encoding} |
| 76 | message header. If no such header exists, return \code{"7bit"}. The |
| 77 | encoding is converted to lower case. |
| 78 | \end{funcdesc} |
| 79 | |
| 80 | \begin{funcdesc}{gettype}{} |
Fred Drake | 4b3f031 | 1996-12-13 22:04:31 +0000 | [diff] [blame] | 81 | Return the message type (of the form \samp{\var{type}/\var{subtype}}) |
Guido van Rossum | cca8d2b | 1995-03-22 15:48:46 +0000 | [diff] [blame] | 82 | as specified in the \samp{Content-type} header. If no such header |
| 83 | exists, return \code{"text/plain"}. The type is converted to lower |
| 84 | case. |
| 85 | \end{funcdesc} |
| 86 | |
| 87 | \begin{funcdesc}{getmaintype}{} |
| 88 | Return the main type as specified in the \samp{Content-type} header. |
| 89 | If no such header exists, return \code{"text"}. The main type is |
| 90 | converted to lower case. |
| 91 | \end{funcdesc} |
| 92 | |
| 93 | \begin{funcdesc}{getsubtype}{} |
| 94 | Return the subtype as specified in the \samp{Content-type} header. If |
| 95 | no such header exists, return \code{"plain"}. The subtype is |
| 96 | converted to lower case. |
| 97 | \end{funcdesc} |