Fred Drake | 295da24 | 1998-08-10 19:42:37 +0000 | [diff] [blame] | 1 | \section{\module{rfc822} --- |
Barry Warsaw | 95400a2 | 2001-07-16 20:47:58 +0000 | [diff] [blame] | 2 | Parse RFC 2822 mail headers} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 3 | |
Fred Drake | ffbe687 | 1999-04-22 21:23:22 +0000 | [diff] [blame] | 4 | \declaremodule{standard}{rfc822} |
Barry Warsaw | 95400a2 | 2001-07-16 20:47:58 +0000 | [diff] [blame] | 5 | \modulesynopsis{Parse \rfc{2822} style mail messages.} |
Fred Drake | b91e934 | 1998-07-23 17:59:49 +0000 | [diff] [blame] | 6 | |
Barry Warsaw | 95400a2 | 2001-07-16 20:47:58 +0000 | [diff] [blame] | 7 | This module defines a class, \class{Message}, which represents an |
| 8 | ``email message'' as defined by the Internet standard |
Fred Drake | e78661b | 2001-07-17 05:17:58 +0000 | [diff] [blame] | 9 | \rfc{2822}.\footnote{This module originally conformed to \rfc{822}, |
Barry Warsaw | 95400a2 | 2001-07-16 20:47:58 +0000 | [diff] [blame] | 10 | hence the name. Since then, \rfc{2822} has been released as an |
| 11 | update to \rfc{822}. This module should be considered |
| 12 | \rfc{2822}-conformant, especially in cases where the |
Fred Drake | e78661b | 2001-07-17 05:17:58 +0000 | [diff] [blame] | 13 | syntax or semantics have changed since \rfc{822}.} Such messages |
Barry Warsaw | 95400a2 | 2001-07-16 20:47:58 +0000 | [diff] [blame] | 14 | consist of a collection of message headers, and a message body. This |
| 15 | module also defines a helper class |
| 16 | \class{AddressList} for parsing \rfc{2822} addresses. Please refer to |
| 17 | the RFC for information on the specific syntax of \rfc{2822} messages. |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 18 | |
Fred Drake | 38e5d27 | 2000-04-03 20:13:55 +0000 | [diff] [blame] | 19 | The \refmodule{mailbox}\refstmodindex{mailbox} module provides classes |
| 20 | to read mailboxes produced by various end-user mail programs. |
Guido van Rossum | 067a2ac | 1997-06-02 17:30:03 +0000 | [diff] [blame] | 21 | |
Fred Drake | cdea8a3 | 1998-03-14 06:17:43 +0000 | [diff] [blame] | 22 | \begin{classdesc}{Message}{file\optional{, seekable}} |
Guido van Rossum | 1299100 | 1998-06-10 21:34:27 +0000 | [diff] [blame] | 23 | A \class{Message} instance is instantiated with an input object as |
| 24 | parameter. Message relies only on the input object having a |
Fred Drake | 23329d4 | 1998-08-10 17:46:22 +0000 | [diff] [blame] | 25 | \method{readline()} method; in particular, ordinary file objects |
| 26 | qualify. Instantiation reads headers from the input object up to a |
| 27 | delimiter line (normally a blank line) and stores them in the |
Eric S. Raymond | e7213c7 | 2001-01-27 10:56:14 +0000 | [diff] [blame] | 28 | instance. The message body, following the headers, is not consumed. |
Guido van Rossum | 1299100 | 1998-06-10 21:34:27 +0000 | [diff] [blame] | 29 | |
Fred Drake | 23329d4 | 1998-08-10 17:46:22 +0000 | [diff] [blame] | 30 | This class can work with any input object that supports a |
| 31 | \method{readline()} method. If the input object has seek and tell |
| 32 | capability, the \method{rewindbody()} method will work; also, illegal |
| 33 | lines will be pushed back onto the input stream. If the input object |
| 34 | lacks seek but has an \method{unread()} method that can push back a |
| 35 | line of input, \class{Message} will use that to push back illegal |
| 36 | lines. Thus this class can be used to parse messages coming from a |
| 37 | buffered stream. |
Guido van Rossum | 1299100 | 1998-06-10 21:34:27 +0000 | [diff] [blame] | 38 | |
Fred Drake | 23329d4 | 1998-08-10 17:46:22 +0000 | [diff] [blame] | 39 | The optional \var{seekable} argument is provided as a workaround for |
| 40 | certain stdio libraries in which \cfunction{tell()} discards buffered |
| 41 | data before discovering that the \cfunction{lseek()} system call |
| 42 | doesn't work. For maximum portability, you should set the seekable |
| 43 | argument to zero to prevent that initial \method{tell()} when passing |
| 44 | in an unseekable object such as a a file object created from a socket |
| 45 | object. |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 46 | |
| 47 | Input lines as read from the file may either be terminated by CR-LF or |
| 48 | by a single linefeed; a terminating CR-LF is replaced by a single |
| 49 | linefeed before the line is stored. |
| 50 | |
| 51 | All header matching is done independent of upper or lower case; |
Fred Drake | 23329d4 | 1998-08-10 17:46:22 +0000 | [diff] [blame] | 52 | e.g.\ \code{\var{m}['From']}, \code{\var{m}['from']} and |
Fred Drake | cdea8a3 | 1998-03-14 06:17:43 +0000 | [diff] [blame] | 53 | \code{\var{m}['FROM']} all yield the same result. |
| 54 | \end{classdesc} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 55 | |
Guido van Rossum | 8729483 | 1998-06-16 22:27:40 +0000 | [diff] [blame] | 56 | \begin{classdesc}{AddressList}{field} |
Fred Drake | ae0f292 | 1999-06-10 15:03:07 +0000 | [diff] [blame] | 57 | You may instantiate the \class{AddressList} helper class using a single |
Barry Warsaw | 95400a2 | 2001-07-16 20:47:58 +0000 | [diff] [blame] | 58 | string parameter, a comma-separated list of \rfc{2822} addresses to be |
Fred Drake | 23329d4 | 1998-08-10 17:46:22 +0000 | [diff] [blame] | 59 | parsed. (The parameter \code{None} yields an empty list.) |
Guido van Rossum | 8729483 | 1998-06-16 22:27:40 +0000 | [diff] [blame] | 60 | \end{classdesc} |
| 61 | |
Barry Warsaw | 95400a2 | 2001-07-16 20:47:58 +0000 | [diff] [blame] | 62 | \begin{funcdesc}{quote}{str} |
| 63 | Return a new string with backslashes in \var{str} replaced by two |
| 64 | backslashes and double quotes replaced by backslash-double quote. |
| 65 | \end{funcdesc} |
| 66 | |
| 67 | \begin{funcdesc}{unquote}{str} |
| 68 | Return a new string which is an \emph{unquoted} version of \var{str}. |
| 69 | If \var{str} ends and begins with double quotes, they are stripped |
| 70 | off. Likewise if \var{str} ends and begins with angle brackets, they |
| 71 | are stripped off. |
| 72 | \end{funcdesc} |
| 73 | |
| 74 | \begin{funcdesc}{parseaddr}{address} |
Fred Drake | d86038d | 2001-08-03 18:39:36 +0000 | [diff] [blame] | 75 | Parse \var{address}, which should be the value of some |
| 76 | address-containing field such as \mailheader{To} or \mailheader{Cc}, |
| 77 | into its constituent ``realname'' and ``email address'' parts. |
| 78 | Returns a tuple of that information, unless the parse fails, in which |
| 79 | case a 2-tuple \code{(None, None)} is returned. |
Barry Warsaw | 95400a2 | 2001-07-16 20:47:58 +0000 | [diff] [blame] | 80 | \end{funcdesc} |
| 81 | |
| 82 | \begin{funcdesc}{dump_address_pair}{pair} |
| 83 | The inverse of \method{parseaddr()}, this takes a 2-tuple of the form |
Fred Drake | d86038d | 2001-08-03 18:39:36 +0000 | [diff] [blame] | 84 | \code{(\var{realname}, \var{email_address})} and returns the string |
| 85 | value suitable for a \mailheader{To} or \mailheader{Cc} header. If |
| 86 | the first element of \var{pair} is false, then the second element is |
| 87 | returned unmodified. |
Barry Warsaw | 95400a2 | 2001-07-16 20:47:58 +0000 | [diff] [blame] | 88 | \end{funcdesc} |
| 89 | |
Guido van Rossum | 843e712 | 1996-12-06 21:23:53 +0000 | [diff] [blame] | 90 | \begin{funcdesc}{parsedate}{date} |
Barry Warsaw | 95400a2 | 2001-07-16 20:47:58 +0000 | [diff] [blame] | 91 | Attempts to parse a date according to the rules in \rfc{2822}. |
Fred Drake | cdea8a3 | 1998-03-14 06:17:43 +0000 | [diff] [blame] | 92 | however, some mailers don't follow that format as specified, so |
| 93 | \function{parsedate()} tries to guess correctly in such cases. |
Barry Warsaw | 95400a2 | 2001-07-16 20:47:58 +0000 | [diff] [blame] | 94 | \var{date} is a string containing an \rfc{2822} date, such as |
Fred Drake | cdea8a3 | 1998-03-14 06:17:43 +0000 | [diff] [blame] | 95 | \code{'Mon, 20 Nov 1995 19:12:08 -0500'}. If it succeeds in parsing |
| 96 | the date, \function{parsedate()} returns a 9-tuple that can be passed |
| 97 | directly to \function{time.mktime()}; otherwise \code{None} will be |
Fred Drake | 38e5d27 | 2000-04-03 20:13:55 +0000 | [diff] [blame] | 98 | returned. Note that fields 6, 7, and 8 of the result tuple are not |
| 99 | usable. |
Guido van Rossum | 843e712 | 1996-12-06 21:23:53 +0000 | [diff] [blame] | 100 | \end{funcdesc} |
| 101 | |
| 102 | \begin{funcdesc}{parsedate_tz}{date} |
Fred Drake | cdea8a3 | 1998-03-14 06:17:43 +0000 | [diff] [blame] | 103 | Performs the same function as \function{parsedate()}, but returns |
| 104 | either \code{None} or a 10-tuple; the first 9 elements make up a tuple |
| 105 | that can be passed directly to \function{time.mktime()}, and the tenth |
| 106 | is the offset of the date's timezone from UTC (which is the official |
| 107 | term for Greenwich Mean Time). (Note that the sign of the timezone |
| 108 | offset is the opposite of the sign of the \code{time.timezone} |
| 109 | variable for the same timezone; the latter variable follows the |
Barry Warsaw | 95400a2 | 2001-07-16 20:47:58 +0000 | [diff] [blame] | 110 | \POSIX{} standard while this module follows \rfc{2822}.) If the input |
Fred Drake | cdea8a3 | 1998-03-14 06:17:43 +0000 | [diff] [blame] | 111 | string has no timezone, the last element of the tuple returned is |
Fred Drake | 38e5d27 | 2000-04-03 20:13:55 +0000 | [diff] [blame] | 112 | \code{None}. Note that fields 6, 7, and 8 of the result tuple are not |
| 113 | usable. |
Guido van Rossum | 843e712 | 1996-12-06 21:23:53 +0000 | [diff] [blame] | 114 | \end{funcdesc} |
| 115 | |
Guido van Rossum | 8cf94e6 | 1998-02-18 05:09:14 +0000 | [diff] [blame] | 116 | \begin{funcdesc}{mktime_tz}{tuple} |
Fred Drake | cdea8a3 | 1998-03-14 06:17:43 +0000 | [diff] [blame] | 117 | Turn a 10-tuple as returned by \function{parsedate_tz()} into a UTC |
| 118 | timestamp. It the timezone item in the tuple is \code{None}, assume |
| 119 | local time. Minor deficiency: this first interprets the first 8 |
| 120 | elements as a local time and then compensates for the timezone |
| 121 | difference; this may yield a slight error around daylight savings time |
Guido van Rossum | 8cf94e6 | 1998-02-18 05:09:14 +0000 | [diff] [blame] | 122 | switch dates. Not enough to worry about for common use. |
| 123 | \end{funcdesc} |
| 124 | |
Fred Drake | ea00205 | 1999-04-28 18:11:09 +0000 | [diff] [blame] | 125 | |
Fred Drake | 38e5d27 | 2000-04-03 20:13:55 +0000 | [diff] [blame] | 126 | \begin{seealso} |
| 127 | \seemodule{mailbox}{Classes to read various mailbox formats produced |
| 128 | by end-user mail programs.} |
Skip Montanaro | 6634b14 | 2000-09-15 18:20:20 +0000 | [diff] [blame] | 129 | \seemodule{mimetools}{Subclass of rfc.Message that handles MIME encoded |
| 130 | messages.} |
Fred Drake | 38e5d27 | 2000-04-03 20:13:55 +0000 | [diff] [blame] | 131 | \end{seealso} |
| 132 | |
| 133 | |
Fred Drake | ea00205 | 1999-04-28 18:11:09 +0000 | [diff] [blame] | 134 | \subsection{Message Objects \label{message-objects}} |
Guido van Rossum | ecde781 | 1995-03-28 13:35:14 +0000 | [diff] [blame] | 135 | |
Fred Drake | cdea8a3 | 1998-03-14 06:17:43 +0000 | [diff] [blame] | 136 | A \class{Message} instance has the following methods: |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 137 | |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 138 | \begin{methoddesc}{rewindbody}{} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 139 | Seek to the start of the message body. This only works if the file |
| 140 | object is seekable. |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 141 | \end{methoddesc} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 142 | |
Guido van Rossum | 444d0f8 | 1998-06-11 13:50:02 +0000 | [diff] [blame] | 143 | \begin{methoddesc}{isheader}{line} |
| 144 | Returns a line's canonicalized fieldname (the dictionary key that will |
Barry Warsaw | 95400a2 | 2001-07-16 20:47:58 +0000 | [diff] [blame] | 145 | be used to index it) if the line is a legal \rfc{2822} header; otherwise |
Fred Drake | d86038d | 2001-08-03 18:39:36 +0000 | [diff] [blame] | 146 | returns \code{None} (implying that parsing should stop here and the |
| 147 | line be pushed back on the input stream). It is sometimes useful to |
| 148 | override this method in a subclass. |
Guido van Rossum | 444d0f8 | 1998-06-11 13:50:02 +0000 | [diff] [blame] | 149 | \end{methoddesc} |
| 150 | |
Guido van Rossum | 1299100 | 1998-06-10 21:34:27 +0000 | [diff] [blame] | 151 | \begin{methoddesc}{islast}{line} |
| 152 | Return true if the given line is a delimiter on which Message should |
Guido van Rossum | 444d0f8 | 1998-06-11 13:50:02 +0000 | [diff] [blame] | 153 | stop. The delimiter line is consumed, and the file object's read |
| 154 | location positioned immediately after it. By default this method just |
| 155 | checks that the line is blank, but you can override it in a subclass. |
Guido van Rossum | 1299100 | 1998-06-10 21:34:27 +0000 | [diff] [blame] | 156 | \end{methoddesc} |
| 157 | |
| 158 | \begin{methoddesc}{iscomment}{line} |
| 159 | Return true if the given line should be ignored entirely, just skipped. |
| 160 | By default this is a stub that always returns false, but you can |
| 161 | override it in a subclass. |
| 162 | \end{methoddesc} |
| 163 | |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 164 | \begin{methoddesc}{getallmatchingheaders}{name} |
Guido van Rossum | 6c4f003 | 1995-03-07 10:14:09 +0000 | [diff] [blame] | 165 | Return a list of lines consisting of all headers matching |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 166 | \var{name}, if any. Each physical line, whether it is a continuation |
| 167 | line or not, is a separate list item. Return the empty list if no |
| 168 | header matches \var{name}. |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 169 | \end{methoddesc} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 170 | |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 171 | \begin{methoddesc}{getfirstmatchingheader}{name} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 172 | Return a list of lines comprising the first header matching |
Fred Drake | ea00205 | 1999-04-28 18:11:09 +0000 | [diff] [blame] | 173 | \var{name}, and its continuation line(s), if any. Return |
| 174 | \code{None} if there is no header matching \var{name}. |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 175 | \end{methoddesc} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 176 | |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 177 | \begin{methoddesc}{getrawheader}{name} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 178 | Return a single string consisting of the text after the colon in the |
| 179 | first header matching \var{name}. This includes leading whitespace, |
| 180 | the trailing linefeed, and internal linefeeds and whitespace if there |
| 181 | any continuation line(s) were present. Return \code{None} if there is |
| 182 | no header matching \var{name}. |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 183 | \end{methoddesc} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 184 | |
Guido van Rossum | 1299100 | 1998-06-10 21:34:27 +0000 | [diff] [blame] | 185 | \begin{methoddesc}{getheader}{name\optional{, default}} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 186 | Like \code{getrawheader(\var{name})}, but strip leading and trailing |
Guido van Rossum | 1299100 | 1998-06-10 21:34:27 +0000 | [diff] [blame] | 187 | whitespace. Internal whitespace is not stripped. The optional |
| 188 | \var{default} argument can be used to specify a different default to |
| 189 | be returned when there is no header matching \var{name}. |
| 190 | \end{methoddesc} |
| 191 | |
| 192 | \begin{methoddesc}{get}{name\optional{, default}} |
Fred Drake | 23329d4 | 1998-08-10 17:46:22 +0000 | [diff] [blame] | 193 | An alias for \method{getheader()}, to make the interface more compatible |
Guido van Rossum | 1299100 | 1998-06-10 21:34:27 +0000 | [diff] [blame] | 194 | with regular dictionaries. |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 195 | \end{methoddesc} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 196 | |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 197 | \begin{methoddesc}{getaddr}{name} |
Fred Drake | cdea8a3 | 1998-03-14 06:17:43 +0000 | [diff] [blame] | 198 | Return a pair \code{(\var{full name}, \var{email address})} parsed |
| 199 | from the string returned by \code{getheader(\var{name})}. If no |
| 200 | header matching \var{name} exists, return \code{(None, None)}; |
| 201 | otherwise both the full name and the address are (possibly empty) |
| 202 | strings. |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 203 | |
Fred Drake | d86038d | 2001-08-03 18:39:36 +0000 | [diff] [blame] | 204 | Example: If \var{m}'s first \mailheader{From} header contains the |
| 205 | string \code{'jack@cwi.nl (Jack Jansen)'}, then |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 206 | \code{m.getaddr('From')} will yield the pair |
Guido van Rossum | 470be14 | 1995-03-17 16:07:09 +0000 | [diff] [blame] | 207 | \code{('Jack Jansen', 'jack@cwi.nl')}. |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 208 | If the header contained |
Guido van Rossum | 470be14 | 1995-03-17 16:07:09 +0000 | [diff] [blame] | 209 | \code{'Jack Jansen <jack@cwi.nl>'} instead, it would yield the |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 210 | exact same result. |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 211 | \end{methoddesc} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 212 | |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 213 | \begin{methoddesc}{getaddrlist}{name} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 214 | This is similar to \code{getaddr(\var{list})}, but parses a header |
Fred Drake | d86038d | 2001-08-03 18:39:36 +0000 | [diff] [blame] | 215 | containing a list of email addresses (e.g.\ a \mailheader{To} header) and |
Fred Drake | cdea8a3 | 1998-03-14 06:17:43 +0000 | [diff] [blame] | 216 | returns a list of \code{(\var{full name}, \var{email address})} pairs |
| 217 | (even if there was only one address in the header). If there is no |
| 218 | header matching \var{name}, return an empty list. |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 219 | |
Barry Warsaw | 53610ca | 1999-01-14 21:26:54 +0000 | [diff] [blame] | 220 | If multiple headers exist that match the named header (e.g. if there |
Fred Drake | d86038d | 2001-08-03 18:39:36 +0000 | [diff] [blame] | 221 | are several \mailheader{Cc} headers), all are parsed for addresses. |
| 222 | Any continuation lines the named headers contain are also parsed. |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 223 | \end{methoddesc} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 224 | |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 225 | \begin{methoddesc}{getdate}{name} |
Fred Drake | cdea8a3 | 1998-03-14 06:17:43 +0000 | [diff] [blame] | 226 | Retrieve a header using \method{getheader()} and parse it into a 9-tuple |
Fred Drake | 38e5d27 | 2000-04-03 20:13:55 +0000 | [diff] [blame] | 227 | compatible with \function{time.mktime()}; note that fields 6, 7, and 8 |
| 228 | are not usable. If there is no header matching |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 229 | \var{name}, or it is unparsable, return \code{None}. |
| 230 | |
| 231 | Date parsing appears to be a black art, and not all mailers adhere to |
| 232 | the standard. While it has been tested and found correct on a large |
| 233 | collection of email from many sources, it is still possible that this |
| 234 | function may occasionally yield an incorrect result. |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 235 | \end{methoddesc} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 236 | |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 237 | \begin{methoddesc}{getdate_tz}{name} |
Fred Drake | cdea8a3 | 1998-03-14 06:17:43 +0000 | [diff] [blame] | 238 | Retrieve a header using \method{getheader()} and parse it into a |
| 239 | 10-tuple; the first 9 elements will make a tuple compatible with |
| 240 | \function{time.mktime()}, and the 10th is a number giving the offset |
Fred Drake | 38e5d27 | 2000-04-03 20:13:55 +0000 | [diff] [blame] | 241 | of the date's timezone from UTC. Note that fields 6, 7, and 8 |
| 242 | are not usable. Similarly to \method{getdate()}, if |
Guido van Rossum | 843e712 | 1996-12-06 21:23:53 +0000 | [diff] [blame] | 243 | there is no header matching \var{name}, or it is unparsable, return |
| 244 | \code{None}. |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 245 | \end{methoddesc} |
Guido van Rossum | 843e712 | 1996-12-06 21:23:53 +0000 | [diff] [blame] | 246 | |
Fred Drake | 7063149 | 2001-05-22 14:36:30 +0000 | [diff] [blame] | 247 | \class{Message} instances also support a limited mapping interface. |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 248 | In particular: \code{\var{m}[name]} is like |
| 249 | \code{\var{m}.getheader(name)} but raises \exception{KeyError} if |
| 250 | there is no matching header; and \code{len(\var{m})}, |
Fred Drake | 6b4593e | 2001-05-22 15:12:46 +0000 | [diff] [blame] | 251 | \code{\var{m}.get(name\optional{, deafult})}, |
Fred Drake | cdea8a3 | 1998-03-14 06:17:43 +0000 | [diff] [blame] | 252 | \code{\var{m}.has_key(name)}, \code{\var{m}.keys()}, |
Fred Drake | 6b4593e | 2001-05-22 15:12:46 +0000 | [diff] [blame] | 253 | \code{\var{m}.values()} \code{\var{m}.items()}, and |
Fred Drake | 98cfab6 | 2001-05-22 22:00:40 +0000 | [diff] [blame] | 254 | \code{\var{m}.setdefault(name\optional{, default})} act as expected, |
| 255 | with the one difference that \method{get()} and \method{setdefault()} |
| 256 | use an empty string as the default value. \class{Message} instances |
| 257 | also support the mapping writable interface \code{\var{m}[name] = |
| 258 | value} and \code{del \var{m}[name]}. \class{Message} objects do not |
| 259 | support the \method{clear()}, \method{copy()}, \method{popitem()}, or |
Fred Drake | 6b4593e | 2001-05-22 15:12:46 +0000 | [diff] [blame] | 260 | \method{update()} methods of the mapping interface. (Support for |
Fred Drake | e78661b | 2001-07-17 05:17:58 +0000 | [diff] [blame] | 261 | \method{get()} and \method{setdefault()} was only added in Python |
Fred Drake | 6b4593e | 2001-05-22 15:12:46 +0000 | [diff] [blame] | 262 | 2.2.) |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 263 | |
Fred Drake | f5072b9 | 2001-09-06 15:07:55 +0000 | [diff] [blame^] | 264 | Finally, \class{Message} instances have some public instance variables: |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 265 | |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 266 | \begin{memberdesc}{headers} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 267 | A list containing the entire set of header lines, in the order in |
Guido van Rossum | 8729483 | 1998-06-16 22:27:40 +0000 | [diff] [blame] | 268 | which they were read (except that setitem calls may disturb this |
| 269 | order). Each line contains a trailing newline. The |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 270 | blank line terminating the headers is not contained in the list. |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 271 | \end{memberdesc} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 272 | |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 273 | \begin{memberdesc}{fp} |
Fred Drake | ea00205 | 1999-04-28 18:11:09 +0000 | [diff] [blame] | 274 | The file or file-like object passed at instantiation time. This can |
| 275 | be used to read the message content. |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 276 | \end{memberdesc} |
Guido van Rossum | 8729483 | 1998-06-16 22:27:40 +0000 | [diff] [blame] | 277 | |
Fred Drake | f5072b9 | 2001-09-06 15:07:55 +0000 | [diff] [blame^] | 278 | \begin{memberdesc}{unixfrom} |
| 279 | The \UNIX{} \samp{From~} line, if the message had one, or an empty |
| 280 | string. This is needed to regenerate the message in some contexts, |
| 281 | such as an \code{mbox}-style mailbox file. |
| 282 | \end{memberdesc} |
| 283 | |
Fred Drake | ea00205 | 1999-04-28 18:11:09 +0000 | [diff] [blame] | 284 | |
| 285 | \subsection{AddressList Objects \label{addresslist-objects}} |
Guido van Rossum | 8729483 | 1998-06-16 22:27:40 +0000 | [diff] [blame] | 286 | |
| 287 | An \class{AddressList} instance has the following methods: |
| 288 | |
Fred Drake | 9c84636 | 2001-04-09 15:42:56 +0000 | [diff] [blame] | 289 | \begin{methoddesc}{__len__}{} |
Guido van Rossum | 8729483 | 1998-06-16 22:27:40 +0000 | [diff] [blame] | 290 | Return the number of addresses in the address list. |
| 291 | \end{methoddesc} |
| 292 | |
Fred Drake | 9c84636 | 2001-04-09 15:42:56 +0000 | [diff] [blame] | 293 | \begin{methoddesc}{__str__}{} |
Guido van Rossum | 8729483 | 1998-06-16 22:27:40 +0000 | [diff] [blame] | 294 | Return a canonicalized string representation of the address list. |
| 295 | Addresses are rendered in "name" <host@domain> form, comma-separated. |
| 296 | \end{methoddesc} |
| 297 | |
Fred Drake | 9c84636 | 2001-04-09 15:42:56 +0000 | [diff] [blame] | 298 | \begin{methoddesc}{__add__}{alist} |
| 299 | Return a new \class{AddressList} instance that contains all addresses |
| 300 | in both \class{AddressList} operands, with duplicates removed (set |
| 301 | union). |
Guido van Rossum | 8729483 | 1998-06-16 22:27:40 +0000 | [diff] [blame] | 302 | \end{methoddesc} |
| 303 | |
Fred Drake | 9c84636 | 2001-04-09 15:42:56 +0000 | [diff] [blame] | 304 | \begin{methoddesc}{__iadd__}{alist} |
| 305 | In-place version of \method{__add__()}; turns this \class{AddressList} |
| 306 | instance into the union of itself and the right-hand instance, |
| 307 | \var{alist}. |
| 308 | \end{methoddesc} |
| 309 | |
| 310 | \begin{methoddesc}{__sub__}{alist} |
| 311 | Return a new \class{AddressList} instance that contains every address |
| 312 | in the left-hand \class{AddressList} operand that is not present in |
| 313 | the right-hand address operand (set difference). |
| 314 | \end{methoddesc} |
| 315 | |
| 316 | \begin{methoddesc}{__isub__}{alist} |
| 317 | In-place version of \method{__sub__()}, removing addresses in this |
| 318 | list which are also in \var{alist}. |
Guido van Rossum | 8729483 | 1998-06-16 22:27:40 +0000 | [diff] [blame] | 319 | \end{methoddesc} |
| 320 | |
| 321 | |
| 322 | Finally, \class{AddressList} instances have one public instance variable: |
| 323 | |
| 324 | \begin{memberdesc}{addresslist} |
| 325 | A list of tuple string pairs, one per address. In each member, the |
Eric S. Raymond | e7213c7 | 2001-01-27 10:56:14 +0000 | [diff] [blame] | 326 | first is the canonicalized name part, the second is the |
Fred Drake | 9c84636 | 2001-04-09 15:42:56 +0000 | [diff] [blame] | 327 | actual route-address (\character{@}-separated username-host.domain |
| 328 | pair). |
Guido van Rossum | 8729483 | 1998-06-16 22:27:40 +0000 | [diff] [blame] | 329 | \end{memberdesc} |