blob: 4f69b22aabdeb6506433d7b9baa808d2fc00c2e1 [file] [log] [blame]
Barry Warsaw9ec58aa2001-07-16 20:40:35 +00001"""RFC 2822 message manipulation.
Guido van Rossum01ca3361992-07-13 14:28:59 +00002
Barry Warsaw9ec58aa2001-07-16 20:40:35 +00003Note: This is only a very rough sketch of a full RFC-822 parser; in particular
4the tokenizing of addresses does not adhere to all the quoting rules.
5
6Note: RFC 2822 is a long awaited update to RFC 822. This module should
7conform to RFC 2822, and is thus mis-named (it's not worth renaming it). Some
8effort at RFC 2822 updates have been made, but a thorough audit has not been
9performed. Consider any RFC 2822 non-conformance to be a bug.
10
11 RFC 2822: http://www.faqs.org/rfcs/rfc2822.html
Barry Warsawb8a55c02001-07-16 20:41:40 +000012 RFC 822 : http://www.faqs.org/rfcs/rfc822.html (obsolete)
Guido van Rossum9ab94c11997-12-10 16:17:39 +000013
14Directions for use:
15
16To create a Message object: first open a file, e.g.:
Barry Warsaw9ec58aa2001-07-16 20:40:35 +000017
Guido van Rossum9ab94c11997-12-10 16:17:39 +000018 fp = open(file, 'r')
Barry Warsaw9ec58aa2001-07-16 20:40:35 +000019
Guido van Rossumc7bb8571998-06-10 21:31:01 +000020You can use any other legal way of getting an open file object, e.g. use
Barry Warsaw9ec58aa2001-07-16 20:40:35 +000021sys.stdin or call os.popen(). Then pass the open file object to the Message()
22constructor:
23
Guido van Rossum9ab94c11997-12-10 16:17:39 +000024 m = Message(fp)
25
Barry Warsaw9ec58aa2001-07-16 20:40:35 +000026This class can work with any input object that supports a readline method. If
27the input object has seek and tell capability, the rewindbody method will
28work; also illegal lines will be pushed back onto the input stream. If the
29input object lacks seek but has an `unread' method that can push back a line
30of input, Message will use that to push back illegal lines. Thus this class
31can be used to parse messages coming from a buffered stream.
Guido van Rossumc7bb8571998-06-10 21:31:01 +000032
Barry Warsaw9ec58aa2001-07-16 20:40:35 +000033The optional `seekable' argument is provided as a workaround for certain stdio
34libraries in which tell() discards buffered data before discovering that the
35lseek() system call doesn't work. For maximum portability, you should set the
36seekable argument to zero to prevent that initial \code{tell} when passing in
37an unseekable object such as a a file object created from a socket object. If
38it is 1 on entry -- which it is by default -- the tell() method of the open
39file object is called once; if this raises an exception, seekable is reset to
400. For other nonzero values of seekable, this test is not made.
Guido van Rossumc7bb8571998-06-10 21:31:01 +000041
Guido van Rossum9ab94c11997-12-10 16:17:39 +000042To get the text of a particular header there are several methods:
Barry Warsaw9ec58aa2001-07-16 20:40:35 +000043
Guido van Rossum9ab94c11997-12-10 16:17:39 +000044 str = m.getheader(name)
45 str = m.getrawheader(name)
Barry Warsaw9ec58aa2001-07-16 20:40:35 +000046
47where name is the name of the header, e.g. 'Subject'. The difference is that
48getheader() strips the leading and trailing whitespace, while getrawheader()
49doesn't. Both functions retain embedded whitespace (including newlines)
50exactly as they are specified in the header, and leave the case of the text
51unchanged.
Guido van Rossum9ab94c11997-12-10 16:17:39 +000052
53For addresses and address lists there are functions
Barry Warsaw9ec58aa2001-07-16 20:40:35 +000054
55 realname, mailaddress = m.getaddr(name)
Guido van Rossum9ab94c11997-12-10 16:17:39 +000056 list = m.getaddrlist(name)
Barry Warsaw9ec58aa2001-07-16 20:40:35 +000057
Guido van Rossum9ab94c11997-12-10 16:17:39 +000058where the latter returns a list of (realname, mailaddr) tuples.
59
60There is also a method
Barry Warsaw9ec58aa2001-07-16 20:40:35 +000061
Guido van Rossum9ab94c11997-12-10 16:17:39 +000062 time = m.getdate(name)
Barry Warsaw9ec58aa2001-07-16 20:40:35 +000063
Guido van Rossum9ab94c11997-12-10 16:17:39 +000064which parses a Date-like field and returns a time-compatible tuple,
65i.e. a tuple such as returned by time.localtime() or accepted by
66time.mktime().
67
68See the class definition for lower level access methods.
69
70There are also some utility functions here.
71"""
Guido van Rossum4d4ab921998-06-16 22:27:09 +000072# Cleanup and extensions by Eric S. Raymond <esr@thyrsus.com>
Guido van Rossum01ca3361992-07-13 14:28:59 +000073
Guido van Rossumb6775db1994-08-01 11:34:53 +000074import time
Guido van Rossum01ca3361992-07-13 14:28:59 +000075
Skip Montanaro0de65802001-02-15 22:15:14 +000076__all__ = ["Message","AddressList","parsedate","parsedate_tz","mktime_tz"]
Guido van Rossum01ca3361992-07-13 14:28:59 +000077
Guido van Rossum9ab94c11997-12-10 16:17:39 +000078_blanklines = ('\r\n', '\n') # Optimization for islast()
Guido van Rossum92457b91995-06-22 19:06:57 +000079
80
Guido van Rossum01ca3361992-07-13 14:28:59 +000081class Message:
Barry Warsaw9ec58aa2001-07-16 20:40:35 +000082 """Represents a single RFC 2822-compliant message."""
Tim Peters0c9886d2001-01-15 01:18:21 +000083
Guido van Rossum9ab94c11997-12-10 16:17:39 +000084 def __init__(self, fp, seekable = 1):
85 """Initialize the class instance and read the headers."""
Guido van Rossumc7bb8571998-06-10 21:31:01 +000086 if seekable == 1:
87 # Exercise tell() to make sure it works
88 # (and then assume seek() works, too)
89 try:
90 fp.tell()
unknown67bbd7a2001-07-04 07:07:33 +000091 except (AttributeError, IOError):
Guido van Rossumc7bb8571998-06-10 21:31:01 +000092 seekable = 0
93 else:
94 seekable = 1
Guido van Rossum9ab94c11997-12-10 16:17:39 +000095 self.fp = fp
96 self.seekable = seekable
97 self.startofheaders = None
98 self.startofbody = None
99 #
100 if self.seekable:
101 try:
102 self.startofheaders = self.fp.tell()
103 except IOError:
104 self.seekable = 0
105 #
106 self.readheaders()
107 #
108 if self.seekable:
109 try:
110 self.startofbody = self.fp.tell()
111 except IOError:
112 self.seekable = 0
Tim Peters0c9886d2001-01-15 01:18:21 +0000113
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000114 def rewindbody(self):
115 """Rewind the file to the start of the body (if seekable)."""
116 if not self.seekable:
117 raise IOError, "unseekable file"
118 self.fp.seek(self.startofbody)
Tim Peters0c9886d2001-01-15 01:18:21 +0000119
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000120 def readheaders(self):
121 """Read header lines.
Tim Peters0c9886d2001-01-15 01:18:21 +0000122
Barry Warsaw9ec58aa2001-07-16 20:40:35 +0000123 Read header lines up to the entirely blank line that terminates them.
124 The (normally blank) line that ends the headers is skipped, but not
125 included in the returned list. If a non-header line ends the headers,
126 (which is an error), an attempt is made to backspace over it; it is
127 never included in the returned list.
Tim Peters0c9886d2001-01-15 01:18:21 +0000128
Barry Warsaw9ec58aa2001-07-16 20:40:35 +0000129 The variable self.status is set to the empty string if all went well,
130 otherwise it is an error message. The variable self.headers is a
131 completely uninterpreted list of lines contained in the header (so
132 printing them will reproduce the header exactly as it appears in the
133 file).
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000134 """
135 self.dict = {}
136 self.unixfrom = ''
137 self.headers = list = []
138 self.status = ''
139 headerseen = ""
140 firstline = 1
Guido van Rossum052969a1998-07-21 14:24:04 +0000141 startofline = unread = tell = None
142 if hasattr(self.fp, 'unread'):
143 unread = self.fp.unread
144 elif self.seekable:
145 tell = self.fp.tell
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000146 while 1:
Guido van Rossum052969a1998-07-21 14:24:04 +0000147 if tell:
Guido van Rossuma66eed62000-11-09 18:05:24 +0000148 try:
149 startofline = tell()
150 except IOError:
151 startofline = tell = None
152 self.seekable = 0
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000153 line = self.fp.readline()
154 if not line:
155 self.status = 'EOF in headers'
156 break
157 # Skip unix From name time lines
Guido van Rossumc80f1822000-12-15 15:37:48 +0000158 if firstline and line.startswith('From '):
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000159 self.unixfrom = self.unixfrom + line
160 continue
161 firstline = 0
Guido van Rossume894fc01998-06-11 13:58:40 +0000162 if headerseen and line[0] in ' \t':
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000163 # It's a continuation line.
164 list.append(line)
Guido van Rossumc80f1822000-12-15 15:37:48 +0000165 x = (self.dict[headerseen] + "\n " + line.strip())
166 self.dict[headerseen] = x.strip()
Guido van Rossume894fc01998-06-11 13:58:40 +0000167 continue
Guido van Rossumc7bb8571998-06-10 21:31:01 +0000168 elif self.iscomment(line):
Guido van Rossume894fc01998-06-11 13:58:40 +0000169 # It's a comment. Ignore it.
170 continue
171 elif self.islast(line):
172 # Note! No pushback here! The delimiter line gets eaten.
173 break
174 headerseen = self.isheader(line)
175 if headerseen:
176 # It's a legal header line, save it.
177 list.append(line)
Guido van Rossumc80f1822000-12-15 15:37:48 +0000178 self.dict[headerseen] = line[len(headerseen)+1:].strip()
Guido van Rossume894fc01998-06-11 13:58:40 +0000179 continue
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000180 else:
Guido van Rossume894fc01998-06-11 13:58:40 +0000181 # It's not a header line; throw it back and stop here.
182 if not self.dict:
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000183 self.status = 'No headers'
184 else:
Guido van Rossume894fc01998-06-11 13:58:40 +0000185 self.status = 'Non-header line where header expected'
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000186 # Try to undo the read.
Guido van Rossum052969a1998-07-21 14:24:04 +0000187 if unread:
188 unread(line)
189 elif tell:
190 self.fp.seek(startofline)
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000191 else:
Guido van Rossumc7bb8571998-06-10 21:31:01 +0000192 self.status = self.status + '; bad seek'
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000193 break
Guido van Rossume894fc01998-06-11 13:58:40 +0000194
195 def isheader(self, line):
196 """Determine whether a given line is a legal header.
197
198 This method should return the header name, suitably canonicalized.
Barry Warsaw9ec58aa2001-07-16 20:40:35 +0000199 You may override this method in order to use Message parsing on tagged
200 data in RFC 2822-like formats with special header formats.
Guido van Rossume894fc01998-06-11 13:58:40 +0000201 """
Guido van Rossumc80f1822000-12-15 15:37:48 +0000202 i = line.find(':')
Guido van Rossume894fc01998-06-11 13:58:40 +0000203 if i > 0:
Guido van Rossumc80f1822000-12-15 15:37:48 +0000204 return line[:i].lower()
Guido van Rossume894fc01998-06-11 13:58:40 +0000205 else:
206 return None
Tim Peters0c9886d2001-01-15 01:18:21 +0000207
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000208 def islast(self, line):
Barry Warsaw9ec58aa2001-07-16 20:40:35 +0000209 """Determine whether a line is a legal end of RFC 2822 headers.
Tim Peters0c9886d2001-01-15 01:18:21 +0000210
Barry Warsaw9ec58aa2001-07-16 20:40:35 +0000211 You may override this method if your application wants to bend the
212 rules, e.g. to strip trailing whitespace, or to recognize MH template
213 separators ('--------'). For convenience (e.g. for code reading from
214 sockets) a line consisting of \r\n also matches.
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000215 """
216 return line in _blanklines
Guido van Rossumc7bb8571998-06-10 21:31:01 +0000217
218 def iscomment(self, line):
219 """Determine whether a line should be skipped entirely.
220
Barry Warsaw9ec58aa2001-07-16 20:40:35 +0000221 You may override this method in order to use Message parsing on tagged
222 data in RFC 2822-like formats that support embedded comments or
223 free-text data.
Guido van Rossumc7bb8571998-06-10 21:31:01 +0000224 """
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000225 return False
Tim Peters0c9886d2001-01-15 01:18:21 +0000226
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000227 def getallmatchingheaders(self, name):
228 """Find all header lines matching a given header name.
Tim Peters0c9886d2001-01-15 01:18:21 +0000229
Barry Warsaw9ec58aa2001-07-16 20:40:35 +0000230 Look through the list of headers and find all lines matching a given
231 header name (and their continuation lines). A list of the lines is
232 returned, without interpretation. If the header does not occur, an
233 empty list is returned. If the header occurs multiple times, all
234 occurrences are returned. Case is not important in the header name.
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000235 """
Guido van Rossumc80f1822000-12-15 15:37:48 +0000236 name = name.lower() + ':'
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000237 n = len(name)
238 list = []
239 hit = 0
240 for line in self.headers:
Guido van Rossumc80f1822000-12-15 15:37:48 +0000241 if line[:n].lower() == name:
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000242 hit = 1
Guido van Rossum352ca8c2001-01-02 20:36:32 +0000243 elif not line[:1].isspace():
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000244 hit = 0
245 if hit:
246 list.append(line)
247 return list
Tim Peters0c9886d2001-01-15 01:18:21 +0000248
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000249 def getfirstmatchingheader(self, name):
250 """Get the first header line matching name.
Tim Peters0c9886d2001-01-15 01:18:21 +0000251
Barry Warsaw9ec58aa2001-07-16 20:40:35 +0000252 This is similar to getallmatchingheaders, but it returns only the
253 first matching header (and its continuation lines).
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000254 """
Guido van Rossumc80f1822000-12-15 15:37:48 +0000255 name = name.lower() + ':'
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000256 n = len(name)
257 list = []
258 hit = 0
259 for line in self.headers:
260 if hit:
Guido van Rossum352ca8c2001-01-02 20:36:32 +0000261 if not line[:1].isspace():
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000262 break
Guido van Rossumc80f1822000-12-15 15:37:48 +0000263 elif line[:n].lower() == name:
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000264 hit = 1
265 if hit:
266 list.append(line)
267 return list
Tim Peters0c9886d2001-01-15 01:18:21 +0000268
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000269 def getrawheader(self, name):
270 """A higher-level interface to getfirstmatchingheader().
Tim Peters0c9886d2001-01-15 01:18:21 +0000271
Barry Warsaw9ec58aa2001-07-16 20:40:35 +0000272 Return a string containing the literal text of the header but with the
273 keyword stripped. All leading, trailing and embedded whitespace is
274 kept in the string, however. Return None if the header does not
275 occur.
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000276 """
Tim Peters0c9886d2001-01-15 01:18:21 +0000277
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000278 list = self.getfirstmatchingheader(name)
279 if not list:
280 return None
281 list[0] = list[0][len(name) + 1:]
Guido van Rossumc80f1822000-12-15 15:37:48 +0000282 return ''.join(list)
Tim Peters0c9886d2001-01-15 01:18:21 +0000283
Guido van Rossumc7bb8571998-06-10 21:31:01 +0000284 def getheader(self, name, default=None):
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000285 """Get the header value for a name.
Tim Peters0c9886d2001-01-15 01:18:21 +0000286
Barry Warsaw9ec58aa2001-07-16 20:40:35 +0000287 This is the normal interface: it returns a stripped version of the
288 header value for a given header name, or None if it doesn't exist.
289 This uses the dictionary version which finds the *last* such header.
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000290 """
291 try:
Guido van Rossumc80f1822000-12-15 15:37:48 +0000292 return self.dict[name.lower()]
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000293 except KeyError:
Guido van Rossumc7bb8571998-06-10 21:31:01 +0000294 return default
295 get = getheader
Fred Drakeddf22c41999-04-28 21:17:38 +0000296
297 def getheaders(self, name):
298 """Get all values for a header.
299
Barry Warsaw9ec58aa2001-07-16 20:40:35 +0000300 This returns a list of values for headers given more than once; each
301 value in the result list is stripped in the same way as the result of
302 getheader(). If the header is not given, return an empty list.
Fred Drakeddf22c41999-04-28 21:17:38 +0000303 """
304 result = []
305 current = ''
306 have_header = 0
307 for s in self.getallmatchingheaders(name):
Guido van Rossum352ca8c2001-01-02 20:36:32 +0000308 if s[0].isspace():
Fred Drakeddf22c41999-04-28 21:17:38 +0000309 if current:
Guido van Rossumc80f1822000-12-15 15:37:48 +0000310 current = "%s\n %s" % (current, s.strip())
Fred Drakeddf22c41999-04-28 21:17:38 +0000311 else:
Guido van Rossumc80f1822000-12-15 15:37:48 +0000312 current = s.strip()
Fred Drakeddf22c41999-04-28 21:17:38 +0000313 else:
314 if have_header:
315 result.append(current)
Guido van Rossumc80f1822000-12-15 15:37:48 +0000316 current = s[s.find(":") + 1:].strip()
Fred Drakeddf22c41999-04-28 21:17:38 +0000317 have_header = 1
318 if have_header:
319 result.append(current)
Fred Drakecbfa5cb1999-06-14 15:40:23 +0000320 return result
Tim Peters0c9886d2001-01-15 01:18:21 +0000321
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000322 def getaddr(self, name):
323 """Get a single address from a header, as a tuple.
Tim Peters0c9886d2001-01-15 01:18:21 +0000324
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000325 An example return value:
326 ('Guido van Rossum', 'guido@cwi.nl')
327 """
328 # New, by Ben Escoto
329 alist = self.getaddrlist(name)
330 if alist:
331 return alist[0]
332 else:
333 return (None, None)
Tim Peters0c9886d2001-01-15 01:18:21 +0000334
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000335 def getaddrlist(self, name):
336 """Get a list of addresses from a header.
Barry Warsaw8a578431999-01-14 19:59:58 +0000337
338 Retrieves a list of addresses from a header, where each address is a
339 tuple as returned by getaddr(). Scans all named headers, so it works
340 properly with multiple To: or Cc: headers for example.
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000341 """
Barry Warsaw8a578431999-01-14 19:59:58 +0000342 raw = []
343 for h in self.getallmatchingheaders(name):
Fred Drake13a2c272000-02-10 17:17:14 +0000344 if h[0] in ' \t':
345 raw.append(h)
346 else:
347 if raw:
348 raw.append(', ')
Guido van Rossumc80f1822000-12-15 15:37:48 +0000349 i = h.find(':')
Barry Warsaw8a578431999-01-14 19:59:58 +0000350 if i > 0:
351 addr = h[i+1:]
352 raw.append(addr)
Guido van Rossumc80f1822000-12-15 15:37:48 +0000353 alladdrs = ''.join(raw)
Barry Warsaw56cdf112002-04-12 20:55:31 +0000354 a = AddressList(alladdrs)
Barry Warsaw0a8d4d52002-05-21 19:46:13 +0000355 return a.addresslist
Tim Peters0c9886d2001-01-15 01:18:21 +0000356
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000357 def getdate(self, name):
358 """Retrieve a date field from a header.
Tim Peters0c9886d2001-01-15 01:18:21 +0000359
Barry Warsaw9ec58aa2001-07-16 20:40:35 +0000360 Retrieves a date field from the named header, returning a tuple
361 compatible with time.mktime().
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000362 """
363 try:
364 data = self[name]
365 except KeyError:
366 return None
367 return parsedate(data)
Tim Peters0c9886d2001-01-15 01:18:21 +0000368
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000369 def getdate_tz(self, name):
370 """Retrieve a date field from a header as a 10-tuple.
Tim Peters0c9886d2001-01-15 01:18:21 +0000371
Barry Warsaw9ec58aa2001-07-16 20:40:35 +0000372 The first 9 elements make up a tuple compatible with time.mktime(),
373 and the 10th is the offset of the poster's time zone from GMT/UTC.
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000374 """
375 try:
376 data = self[name]
377 except KeyError:
378 return None
379 return parsedate_tz(data)
Tim Peters0c9886d2001-01-15 01:18:21 +0000380
381
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000382 # Access as a dictionary (only finds *last* header of each type):
Tim Peters0c9886d2001-01-15 01:18:21 +0000383
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000384 def __len__(self):
385 """Get the number of headers in a message."""
386 return len(self.dict)
Tim Peters0c9886d2001-01-15 01:18:21 +0000387
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000388 def __getitem__(self, name):
389 """Get a specific header, as from a dictionary."""
Guido van Rossumc80f1822000-12-15 15:37:48 +0000390 return self.dict[name.lower()]
Guido van Rossume894fc01998-06-11 13:58:40 +0000391
392 def __setitem__(self, name, value):
Guido van Rossum4d4ab921998-06-16 22:27:09 +0000393 """Set the value of a header.
394
Barry Warsaw9ec58aa2001-07-16 20:40:35 +0000395 Note: This is not a perfect inversion of __getitem__, because any
396 changed headers get stuck at the end of the raw-headers list rather
397 than where the altered header was.
Guido van Rossum4d4ab921998-06-16 22:27:09 +0000398 """
Guido van Rossume894fc01998-06-11 13:58:40 +0000399 del self[name] # Won't fail if it doesn't exist
Guido van Rossumc80f1822000-12-15 15:37:48 +0000400 self.dict[name.lower()] = value
Guido van Rossume894fc01998-06-11 13:58:40 +0000401 text = name + ": " + value
Guido van Rossumc80f1822000-12-15 15:37:48 +0000402 lines = text.split("\n")
Guido van Rossume894fc01998-06-11 13:58:40 +0000403 for line in lines:
404 self.headers.append(line + "\n")
Tim Peters0c9886d2001-01-15 01:18:21 +0000405
Guido van Rossum75d92c11998-04-02 21:33:20 +0000406 def __delitem__(self, name):
407 """Delete all occurrences of a specific header, if it is present."""
Guido van Rossumc80f1822000-12-15 15:37:48 +0000408 name = name.lower()
Raymond Hettinger54f02222002-06-01 14:18:47 +0000409 if not name in self.dict:
Guido van Rossumf3c5f5c1999-09-15 22:15:23 +0000410 return
411 del self.dict[name]
412 name = name + ':'
Guido van Rossum75d92c11998-04-02 21:33:20 +0000413 n = len(name)
414 list = []
415 hit = 0
416 for i in range(len(self.headers)):
417 line = self.headers[i]
Guido van Rossumc80f1822000-12-15 15:37:48 +0000418 if line[:n].lower() == name:
Guido van Rossum75d92c11998-04-02 21:33:20 +0000419 hit = 1
Guido van Rossum352ca8c2001-01-02 20:36:32 +0000420 elif not line[:1].isspace():
Guido van Rossum75d92c11998-04-02 21:33:20 +0000421 hit = 0
422 if hit:
423 list.append(i)
424 list.reverse()
425 for i in list:
426 del self.headers[i]
427
Fred Drake233226e2001-05-22 19:36:50 +0000428 def setdefault(self, name, default=""):
Fred Drake02959292001-05-22 14:58:10 +0000429 lowername = name.lower()
Raymond Hettinger54f02222002-06-01 14:18:47 +0000430 if lowername in self.dict:
Fred Drake02959292001-05-22 14:58:10 +0000431 return self.dict[lowername]
432 else:
Fred Drake233226e2001-05-22 19:36:50 +0000433 text = name + ": " + default
Fred Drake02959292001-05-22 14:58:10 +0000434 lines = text.split("\n")
435 for line in lines:
436 self.headers.append(line + "\n")
Fred Drake233226e2001-05-22 19:36:50 +0000437 self.dict[lowername] = default
Fred Drake02959292001-05-22 14:58:10 +0000438 return default
439
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000440 def has_key(self, name):
441 """Determine whether a message contains the named header."""
Raymond Hettinger54f02222002-06-01 14:18:47 +0000442 return name.lower() in self.dict
443
444 def __contains__(self, name):
445 """Determine whether a message contains the named header."""
Tim Petersc411dba2002-07-16 21:35:23 +0000446 return name.lower() in self.dict
Tim Peters0c9886d2001-01-15 01:18:21 +0000447
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000448 def keys(self):
449 """Get all of a message's header field names."""
450 return self.dict.keys()
Tim Peters0c9886d2001-01-15 01:18:21 +0000451
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000452 def values(self):
453 """Get all of a message's header field values."""
454 return self.dict.values()
Tim Peters0c9886d2001-01-15 01:18:21 +0000455
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000456 def items(self):
457 """Get all of a message's headers.
Tim Peters0c9886d2001-01-15 01:18:21 +0000458
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000459 Returns a list of name, value tuples.
460 """
461 return self.dict.items()
Guido van Rossum01ca3361992-07-13 14:28:59 +0000462
Guido van Rossumc7bb8571998-06-10 21:31:01 +0000463 def __str__(self):
464 str = ''
465 for hdr in self.headers:
466 str = str + hdr
467 return str
Guido van Rossum01ca3361992-07-13 14:28:59 +0000468
469
470# Utility functions
471# -----------------
472
Guido van Rossumbe7c45e1997-11-22 21:49:19 +0000473# XXX Should fix unquote() and quote() to be really conformant.
Guido van Rossumb6775db1994-08-01 11:34:53 +0000474# XXX The inverses of the parse functions may also be useful.
475
Guido van Rossum01ca3361992-07-13 14:28:59 +0000476
Guido van Rossum01ca3361992-07-13 14:28:59 +0000477def unquote(str):
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000478 """Remove quotes from a string."""
479 if len(str) > 1:
Barry Warsaw4e09d5c2002-09-11 02:32:14 +0000480 if str.startswith('"') and str.endswith('"'):
481 return str[1:-1].replace('\\\\', '\\').replace('\\"', '"')
482 if str.startswith('<') and str.endswith('>'):
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000483 return str[1:-1]
484 return str
Guido van Rossumb6775db1994-08-01 11:34:53 +0000485
486
Guido van Rossum7883e1d1997-09-15 14:12:54 +0000487def quote(str):
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000488 """Add quotes around a string."""
Guido van Rossumc80f1822000-12-15 15:37:48 +0000489 return str.replace('\\', '\\\\').replace('"', '\\"')
Guido van Rossumb6775db1994-08-01 11:34:53 +0000490
Guido van Rossumbe7c45e1997-11-22 21:49:19 +0000491
Guido van Rossumb6775db1994-08-01 11:34:53 +0000492def parseaddr(address):
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000493 """Parse an address into a (realname, mailaddr) tuple."""
Barry Warsaw56cdf112002-04-12 20:55:31 +0000494 a = AddressList(address)
Barry Warsawf6553282002-05-23 03:21:01 +0000495 list = a.addresslist
Guido van Rossumbe7c45e1997-11-22 21:49:19 +0000496 if not list:
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000497 return (None, None)
Guido van Rossumbe7c45e1997-11-22 21:49:19 +0000498 else:
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000499 return list[0]
Guido van Rossumbe7c45e1997-11-22 21:49:19 +0000500
501
Guido van Rossumbe7c45e1997-11-22 21:49:19 +0000502class AddrlistClass:
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000503 """Address parser class by Ben Escoto.
Tim Peters0c9886d2001-01-15 01:18:21 +0000504
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000505 To understand what this class does, it helps to have a copy of
Barry Warsaw9ec58aa2001-07-16 20:40:35 +0000506 RFC 2822 in front of you.
507
508 http://www.faqs.org/rfcs/rfc2822.html
Guido van Rossum4d4ab921998-06-16 22:27:09 +0000509
510 Note: this class interface is deprecated and may be removed in the future.
511 Use rfc822.AddressList instead.
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000512 """
Tim Peters0c9886d2001-01-15 01:18:21 +0000513
Guido van Rossumbe7c45e1997-11-22 21:49:19 +0000514 def __init__(self, field):
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000515 """Initialize a new instance.
Tim Peters0c9886d2001-01-15 01:18:21 +0000516
Barry Warsaw9ec58aa2001-07-16 20:40:35 +0000517 `field' is an unparsed address header field, containing one or more
518 addresses.
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000519 """
520 self.specials = '()<>@,:;.\"[]'
521 self.pos = 0
522 self.LWS = ' \t'
Barry Warsaw8a578431999-01-14 19:59:58 +0000523 self.CR = '\r\n'
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000524 self.atomends = self.specials + self.LWS + self.CR
Barry Warsaw9ec58aa2001-07-16 20:40:35 +0000525 # Note that RFC 2822 now specifies `.' as obs-phrase, meaning that it
526 # is obsolete syntax. RFC 2822 requires that we recognize obsolete
527 # syntax, so allow dots in phrases.
528 self.phraseends = self.atomends.replace('.', '')
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000529 self.field = field
530 self.commentlist = []
Tim Peters0c9886d2001-01-15 01:18:21 +0000531
Guido van Rossumbe7c45e1997-11-22 21:49:19 +0000532 def gotonext(self):
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000533 """Parse up to the start of the next address."""
534 while self.pos < len(self.field):
535 if self.field[self.pos] in self.LWS + '\n\r':
536 self.pos = self.pos + 1
537 elif self.field[self.pos] == '(':
538 self.commentlist.append(self.getcomment())
539 else: break
Tim Peters0c9886d2001-01-15 01:18:21 +0000540
Guido van Rossumbe7c45e1997-11-22 21:49:19 +0000541 def getaddrlist(self):
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000542 """Parse all addresses.
Tim Peters0c9886d2001-01-15 01:18:21 +0000543
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000544 Returns a list containing all of the addresses.
545 """
Barry Warsawf1fd2822001-11-13 21:30:37 +0000546 result = []
547 while 1:
548 ad = self.getaddress()
549 if ad:
550 result += ad
551 else:
552 break
553 return result
Tim Peters0c9886d2001-01-15 01:18:21 +0000554
Guido van Rossumbe7c45e1997-11-22 21:49:19 +0000555 def getaddress(self):
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000556 """Parse the next address."""
557 self.commentlist = []
558 self.gotonext()
Tim Peters0c9886d2001-01-15 01:18:21 +0000559
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000560 oldpos = self.pos
561 oldcl = self.commentlist
562 plist = self.getphraselist()
Tim Peters0c9886d2001-01-15 01:18:21 +0000563
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000564 self.gotonext()
565 returnlist = []
Tim Peters0c9886d2001-01-15 01:18:21 +0000566
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000567 if self.pos >= len(self.field):
568 # Bad email address technically, no domain.
569 if plist:
Guido van Rossumc80f1822000-12-15 15:37:48 +0000570 returnlist = [(' '.join(self.commentlist), plist[0])]
Tim Peters0c9886d2001-01-15 01:18:21 +0000571
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000572 elif self.field[self.pos] in '.@':
573 # email address is just an addrspec
574 # this isn't very efficient since we start over
575 self.pos = oldpos
576 self.commentlist = oldcl
577 addrspec = self.getaddrspec()
Guido van Rossumc80f1822000-12-15 15:37:48 +0000578 returnlist = [(' '.join(self.commentlist), addrspec)]
Tim Peters0c9886d2001-01-15 01:18:21 +0000579
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000580 elif self.field[self.pos] == ':':
581 # address is a group
582 returnlist = []
Tim Peters0c9886d2001-01-15 01:18:21 +0000583
Barry Warsaw96e9bf41999-07-12 18:37:02 +0000584 fieldlen = len(self.field)
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000585 self.pos = self.pos + 1
586 while self.pos < len(self.field):
587 self.gotonext()
Barry Warsaw96e9bf41999-07-12 18:37:02 +0000588 if self.pos < fieldlen and self.field[self.pos] == ';':
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000589 self.pos = self.pos + 1
590 break
591 returnlist = returnlist + self.getaddress()
Tim Peters0c9886d2001-01-15 01:18:21 +0000592
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000593 elif self.field[self.pos] == '<':
594 # Address is a phrase then a route addr
595 routeaddr = self.getrouteaddr()
Tim Peters0c9886d2001-01-15 01:18:21 +0000596
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000597 if self.commentlist:
Guido van Rossumc80f1822000-12-15 15:37:48 +0000598 returnlist = [(' '.join(plist) + ' (' + \
599 ' '.join(self.commentlist) + ')', routeaddr)]
600 else: returnlist = [(' '.join(plist), routeaddr)]
Tim Peters0c9886d2001-01-15 01:18:21 +0000601
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000602 else:
603 if plist:
Guido van Rossumc80f1822000-12-15 15:37:48 +0000604 returnlist = [(' '.join(self.commentlist), plist[0])]
Barry Warsaw8a578431999-01-14 19:59:58 +0000605 elif self.field[self.pos] in self.specials:
606 self.pos = self.pos + 1
Tim Peters0c9886d2001-01-15 01:18:21 +0000607
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000608 self.gotonext()
609 if self.pos < len(self.field) and self.field[self.pos] == ',':
610 self.pos = self.pos + 1
611 return returnlist
Tim Peters0c9886d2001-01-15 01:18:21 +0000612
Guido van Rossumbe7c45e1997-11-22 21:49:19 +0000613 def getrouteaddr(self):
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000614 """Parse a route address (Return-path value).
Tim Peters0c9886d2001-01-15 01:18:21 +0000615
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000616 This method just skips all the route stuff and returns the addrspec.
617 """
618 if self.field[self.pos] != '<':
619 return
Tim Peters0c9886d2001-01-15 01:18:21 +0000620
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000621 expectroute = 0
622 self.pos = self.pos + 1
623 self.gotonext()
Guido van Rossumf830a522001-12-20 15:54:48 +0000624 adlist = ""
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000625 while self.pos < len(self.field):
626 if expectroute:
627 self.getdomain()
628 expectroute = 0
629 elif self.field[self.pos] == '>':
630 self.pos = self.pos + 1
631 break
632 elif self.field[self.pos] == '@':
633 self.pos = self.pos + 1
634 expectroute = 1
635 elif self.field[self.pos] == ':':
636 self.pos = self.pos + 1
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000637 else:
638 adlist = self.getaddrspec()
639 self.pos = self.pos + 1
640 break
641 self.gotonext()
Tim Peters0c9886d2001-01-15 01:18:21 +0000642
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000643 return adlist
Tim Peters0c9886d2001-01-15 01:18:21 +0000644
Guido van Rossumbe7c45e1997-11-22 21:49:19 +0000645 def getaddrspec(self):
Barry Warsaw9ec58aa2001-07-16 20:40:35 +0000646 """Parse an RFC 2822 addr-spec."""
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000647 aslist = []
Tim Peters0c9886d2001-01-15 01:18:21 +0000648
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000649 self.gotonext()
650 while self.pos < len(self.field):
651 if self.field[self.pos] == '.':
652 aslist.append('.')
653 self.pos = self.pos + 1
654 elif self.field[self.pos] == '"':
Guido van Rossumb1844871999-06-15 18:06:20 +0000655 aslist.append('"%s"' % self.getquote())
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000656 elif self.field[self.pos] in self.atomends:
657 break
658 else: aslist.append(self.getatom())
659 self.gotonext()
Tim Peters0c9886d2001-01-15 01:18:21 +0000660
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000661 if self.pos >= len(self.field) or self.field[self.pos] != '@':
Guido van Rossumc80f1822000-12-15 15:37:48 +0000662 return ''.join(aslist)
Tim Peters0c9886d2001-01-15 01:18:21 +0000663
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000664 aslist.append('@')
665 self.pos = self.pos + 1
666 self.gotonext()
Guido van Rossumc80f1822000-12-15 15:37:48 +0000667 return ''.join(aslist) + self.getdomain()
Tim Peters0c9886d2001-01-15 01:18:21 +0000668
Guido van Rossumbe7c45e1997-11-22 21:49:19 +0000669 def getdomain(self):
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000670 """Get the complete domain name from an address."""
671 sdlist = []
672 while self.pos < len(self.field):
673 if self.field[self.pos] in self.LWS:
674 self.pos = self.pos + 1
675 elif self.field[self.pos] == '(':
676 self.commentlist.append(self.getcomment())
677 elif self.field[self.pos] == '[':
678 sdlist.append(self.getdomainliteral())
679 elif self.field[self.pos] == '.':
680 self.pos = self.pos + 1
681 sdlist.append('.')
682 elif self.field[self.pos] in self.atomends:
683 break
684 else: sdlist.append(self.getatom())
Guido van Rossumc80f1822000-12-15 15:37:48 +0000685 return ''.join(sdlist)
Tim Peters0c9886d2001-01-15 01:18:21 +0000686
Guido van Rossumbe7c45e1997-11-22 21:49:19 +0000687 def getdelimited(self, beginchar, endchars, allowcomments = 1):
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000688 """Parse a header fragment delimited by special characters.
Tim Peters0c9886d2001-01-15 01:18:21 +0000689
Barry Warsaw9ec58aa2001-07-16 20:40:35 +0000690 `beginchar' is the start character for the fragment. If self is not
691 looking at an instance of `beginchar' then getdelimited returns the
692 empty string.
Tim Peters0c9886d2001-01-15 01:18:21 +0000693
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000694 `endchars' is a sequence of allowable end-delimiting characters.
695 Parsing stops when one of these is encountered.
Tim Peters0c9886d2001-01-15 01:18:21 +0000696
Barry Warsaw9ec58aa2001-07-16 20:40:35 +0000697 If `allowcomments' is non-zero, embedded RFC 2822 comments are allowed
698 within the parsed fragment.
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000699 """
700 if self.field[self.pos] != beginchar:
701 return ''
Tim Peters0c9886d2001-01-15 01:18:21 +0000702
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000703 slist = ['']
704 quote = 0
705 self.pos = self.pos + 1
706 while self.pos < len(self.field):
707 if quote == 1:
708 slist.append(self.field[self.pos])
709 quote = 0
710 elif self.field[self.pos] in endchars:
711 self.pos = self.pos + 1
712 break
713 elif allowcomments and self.field[self.pos] == '(':
714 slist.append(self.getcomment())
715 elif self.field[self.pos] == '\\':
716 quote = 1
717 else:
718 slist.append(self.field[self.pos])
719 self.pos = self.pos + 1
Tim Peters0c9886d2001-01-15 01:18:21 +0000720
Guido van Rossumc80f1822000-12-15 15:37:48 +0000721 return ''.join(slist)
Tim Peters0c9886d2001-01-15 01:18:21 +0000722
Guido van Rossumbe7c45e1997-11-22 21:49:19 +0000723 def getquote(self):
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000724 """Get a quote-delimited fragment from self's field."""
725 return self.getdelimited('"', '"\r', 0)
Tim Peters0c9886d2001-01-15 01:18:21 +0000726
Guido van Rossumbe7c45e1997-11-22 21:49:19 +0000727 def getcomment(self):
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000728 """Get a parenthesis-delimited fragment from self's field."""
729 return self.getdelimited('(', ')\r', 1)
Tim Peters0c9886d2001-01-15 01:18:21 +0000730
Guido van Rossumbe7c45e1997-11-22 21:49:19 +0000731 def getdomainliteral(self):
Barry Warsaw9ec58aa2001-07-16 20:40:35 +0000732 """Parse an RFC 2822 domain-literal."""
Barry Warsaw2ea2b112000-09-25 15:08:27 +0000733 return '[%s]' % self.getdelimited('[', ']\r', 0)
Tim Peters0c9886d2001-01-15 01:18:21 +0000734
Barry Warsaw9ec58aa2001-07-16 20:40:35 +0000735 def getatom(self, atomends=None):
736 """Parse an RFC 2822 atom.
737
738 Optional atomends specifies a different set of end token delimiters
739 (the default is to use self.atomends). This is used e.g. in
740 getphraselist() since phrase endings must not include the `.' (which
741 is legal in phrases)."""
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000742 atomlist = ['']
Barry Warsaw9ec58aa2001-07-16 20:40:35 +0000743 if atomends is None:
744 atomends = self.atomends
Tim Peters0c9886d2001-01-15 01:18:21 +0000745
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000746 while self.pos < len(self.field):
Barry Warsaw9ec58aa2001-07-16 20:40:35 +0000747 if self.field[self.pos] in atomends:
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000748 break
749 else: atomlist.append(self.field[self.pos])
750 self.pos = self.pos + 1
Tim Peters0c9886d2001-01-15 01:18:21 +0000751
Guido van Rossumc80f1822000-12-15 15:37:48 +0000752 return ''.join(atomlist)
Tim Peters0c9886d2001-01-15 01:18:21 +0000753
Guido van Rossumbe7c45e1997-11-22 21:49:19 +0000754 def getphraselist(self):
Barry Warsaw9ec58aa2001-07-16 20:40:35 +0000755 """Parse a sequence of RFC 2822 phrases.
Tim Peters0c9886d2001-01-15 01:18:21 +0000756
Barry Warsaw9ec58aa2001-07-16 20:40:35 +0000757 A phrase is a sequence of words, which are in turn either RFC 2822
758 atoms or quoted-strings. Phrases are canonicalized by squeezing all
759 runs of continuous whitespace into one space.
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000760 """
761 plist = []
Tim Peters0c9886d2001-01-15 01:18:21 +0000762
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000763 while self.pos < len(self.field):
764 if self.field[self.pos] in self.LWS:
765 self.pos = self.pos + 1
766 elif self.field[self.pos] == '"':
767 plist.append(self.getquote())
768 elif self.field[self.pos] == '(':
769 self.commentlist.append(self.getcomment())
Barry Warsaw9ec58aa2001-07-16 20:40:35 +0000770 elif self.field[self.pos] in self.phraseends:
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000771 break
Barry Warsaw9ec58aa2001-07-16 20:40:35 +0000772 else:
773 plist.append(self.getatom(self.phraseends))
Tim Peters0c9886d2001-01-15 01:18:21 +0000774
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000775 return plist
Guido van Rossumb6775db1994-08-01 11:34:53 +0000776
Guido van Rossum4d4ab921998-06-16 22:27:09 +0000777class AddressList(AddrlistClass):
Barry Warsaw9ec58aa2001-07-16 20:40:35 +0000778 """An AddressList encapsulates a list of parsed RFC 2822 addresses."""
Guido van Rossum4d4ab921998-06-16 22:27:09 +0000779 def __init__(self, field):
780 AddrlistClass.__init__(self, field)
781 if field:
782 self.addresslist = self.getaddrlist()
783 else:
784 self.addresslist = []
785
786 def __len__(self):
787 return len(self.addresslist)
788
789 def __str__(self):
Guido van Rossumc80f1822000-12-15 15:37:48 +0000790 return ", ".join(map(dump_address_pair, self.addresslist))
Guido van Rossum4d4ab921998-06-16 22:27:09 +0000791
792 def __add__(self, other):
793 # Set union
794 newaddr = AddressList(None)
795 newaddr.addresslist = self.addresslist[:]
796 for x in other.addresslist:
797 if not x in self.addresslist:
798 newaddr.addresslist.append(x)
799 return newaddr
800
Thomas Wouters104a7bc2000-08-24 20:14:10 +0000801 def __iadd__(self, other):
802 # Set union, in-place
803 for x in other.addresslist:
804 if not x in self.addresslist:
805 self.addresslist.append(x)
806 return self
807
Guido van Rossum4d4ab921998-06-16 22:27:09 +0000808 def __sub__(self, other):
809 # Set difference
810 newaddr = AddressList(None)
811 for x in self.addresslist:
812 if not x in other.addresslist:
813 newaddr.addresslist.append(x)
814 return newaddr
815
Thomas Wouters104a7bc2000-08-24 20:14:10 +0000816 def __isub__(self, other):
817 # Set difference, in-place
818 for x in other.addresslist:
819 if x in self.addresslist:
820 self.addresslist.remove(x)
821 return self
822
Guido van Rossum81d10b41998-06-16 22:29:03 +0000823 def __getitem__(self, index):
824 # Make indexing, slices, and 'in' work
Guido van Rossuma07934e1999-09-03 13:23:49 +0000825 return self.addresslist[index]
Guido van Rossum81d10b41998-06-16 22:29:03 +0000826
Guido van Rossum4d4ab921998-06-16 22:27:09 +0000827def dump_address_pair(pair):
828 """Dump a (name, address) pair in a canonicalized form."""
829 if pair[0]:
830 return '"' + pair[0] + '" <' + pair[1] + '>'
831 else:
832 return pair[1]
Guido van Rossumb6775db1994-08-01 11:34:53 +0000833
834# Parse a date field
835
Guido van Rossumdb01ee01998-12-23 22:22:10 +0000836_monthnames = ['jan', 'feb', 'mar', 'apr', 'may', 'jun', 'jul',
837 'aug', 'sep', 'oct', 'nov', 'dec',
Fred Drake13a2c272000-02-10 17:17:14 +0000838 'january', 'february', 'march', 'april', 'may', 'june', 'july',
Guido van Rossumdb01ee01998-12-23 22:22:10 +0000839 'august', 'september', 'october', 'november', 'december']
840_daynames = ['mon', 'tue', 'wed', 'thu', 'fri', 'sat', 'sun']
Guido van Rossumb6775db1994-08-01 11:34:53 +0000841
Guido van Rossum27cb8a41996-11-20 22:12:26 +0000842# The timezone table does not include the military time zones defined
843# in RFC822, other than Z. According to RFC1123, the description in
844# RFC822 gets the signs wrong, so we can't rely on any such time
845# zones. RFC1123 recommends that numeric timezone indicators be used
846# instead of timezone names.
847
Tim Peters0c9886d2001-01-15 01:18:21 +0000848_timezones = {'UT':0, 'UTC':0, 'GMT':0, 'Z':0,
Guido van Rossum67133e21998-05-18 16:09:10 +0000849 'AST': -400, 'ADT': -300, # Atlantic (used in Canada)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000850 'EST': -500, 'EDT': -400, # Eastern
Guido van Rossum67133e21998-05-18 16:09:10 +0000851 'CST': -600, 'CDT': -500, # Central
852 'MST': -700, 'MDT': -600, # Mountain
853 'PST': -800, 'PDT': -700 # Pacific
Tim Peters0c9886d2001-01-15 01:18:21 +0000854 }
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000855
Guido van Rossum27cb8a41996-11-20 22:12:26 +0000856
857def parsedate_tz(data):
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000858 """Convert a date string to a time tuple.
Tim Peters0c9886d2001-01-15 01:18:21 +0000859
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000860 Accounts for military timezones.
861 """
Barry Warsaw4a106ee2001-11-13 18:00:40 +0000862 if not data:
863 return None
Guido van Rossumc80f1822000-12-15 15:37:48 +0000864 data = data.split()
865 if data[0][-1] in (',', '.') or data[0].lower() in _daynames:
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000866 # There's a dayname here. Skip it
867 del data[0]
868 if len(data) == 3: # RFC 850 date, deprecated
Guido van Rossumc80f1822000-12-15 15:37:48 +0000869 stuff = data[0].split('-')
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000870 if len(stuff) == 3:
871 data = stuff + data[1:]
872 if len(data) == 4:
873 s = data[3]
Guido van Rossumc80f1822000-12-15 15:37:48 +0000874 i = s.find('+')
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000875 if i > 0:
876 data[3:] = [s[:i], s[i+1:]]
877 else:
878 data.append('') # Dummy tz
879 if len(data) < 5:
880 return None
881 data = data[:5]
882 [dd, mm, yy, tm, tz] = data
Guido van Rossumc80f1822000-12-15 15:37:48 +0000883 mm = mm.lower()
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000884 if not mm in _monthnames:
Guido van Rossumc80f1822000-12-15 15:37:48 +0000885 dd, mm = mm, dd.lower()
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000886 if not mm in _monthnames:
887 return None
888 mm = _monthnames.index(mm)+1
Guido van Rossumb08f51b1999-04-29 12:50:36 +0000889 if mm > 12: mm = mm - 12
Guido van Rossumdb01ee01998-12-23 22:22:10 +0000890 if dd[-1] == ',':
Fred Drake13a2c272000-02-10 17:17:14 +0000891 dd = dd[:-1]
Guido van Rossumc80f1822000-12-15 15:37:48 +0000892 i = yy.find(':')
Guido van Rossumdb01ee01998-12-23 22:22:10 +0000893 if i > 0:
Fred Drake13a2c272000-02-10 17:17:14 +0000894 yy, tm = tm, yy
Guido van Rossumdb01ee01998-12-23 22:22:10 +0000895 if yy[-1] == ',':
Fred Drake13a2c272000-02-10 17:17:14 +0000896 yy = yy[:-1]
Guido van Rossum352ca8c2001-01-02 20:36:32 +0000897 if not yy[0].isdigit():
Fred Drake13a2c272000-02-10 17:17:14 +0000898 yy, tz = tz, yy
Guido van Rossumdb01ee01998-12-23 22:22:10 +0000899 if tm[-1] == ',':
Fred Drake13a2c272000-02-10 17:17:14 +0000900 tm = tm[:-1]
Guido van Rossumc80f1822000-12-15 15:37:48 +0000901 tm = tm.split(':')
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000902 if len(tm) == 2:
903 [thh, tmm] = tm
904 tss = '0'
Guido van Rossum99e11311998-12-23 21:58:38 +0000905 elif len(tm) == 3:
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000906 [thh, tmm, tss] = tm
Guido van Rossum99e11311998-12-23 21:58:38 +0000907 else:
908 return None
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000909 try:
Guido van Rossumc80f1822000-12-15 15:37:48 +0000910 yy = int(yy)
911 dd = int(dd)
912 thh = int(thh)
913 tmm = int(tmm)
914 tss = int(tss)
915 except ValueError:
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000916 return None
Guido van Rossumc80f1822000-12-15 15:37:48 +0000917 tzoffset = None
918 tz = tz.upper()
Raymond Hettinger54f02222002-06-01 14:18:47 +0000919 if tz in _timezones:
Guido van Rossumc80f1822000-12-15 15:37:48 +0000920 tzoffset = _timezones[tz]
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000921 else:
Tim Peters0c9886d2001-01-15 01:18:21 +0000922 try:
Guido van Rossumc80f1822000-12-15 15:37:48 +0000923 tzoffset = int(tz)
Tim Peters0c9886d2001-01-15 01:18:21 +0000924 except ValueError:
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000925 pass
926 # Convert a timezone offset into seconds ; -0500 -> -18000
Guido van Rossuma73033f1998-02-19 00:28:58 +0000927 if tzoffset:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000928 if tzoffset < 0:
929 tzsign = -1
930 tzoffset = -tzoffset
931 else:
932 tzsign = 1
Guido van Rossum54e54c62001-09-04 19:14:14 +0000933 tzoffset = tzsign * ( (tzoffset//100)*3600 + (tzoffset % 100)*60)
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000934 tuple = (yy, mm, dd, thh, tmm, tss, 0, 0, 0, tzoffset)
935 return tuple
936
Guido van Rossumb6775db1994-08-01 11:34:53 +0000937
Guido van Rossum27cb8a41996-11-20 22:12:26 +0000938def parsedate(data):
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000939 """Convert a time string to a time tuple."""
Guido van Rossumc80f1822000-12-15 15:37:48 +0000940 t = parsedate_tz(data)
941 if type(t) == type( () ):
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000942 return t[:9]
Tim Peters0c9886d2001-01-15 01:18:21 +0000943 else: return t
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000944
Guido van Rossum27cb8a41996-11-20 22:12:26 +0000945
Guido van Rossum6cdd7a01996-12-12 18:39:54 +0000946def mktime_tz(data):
Guido van Rossum67133e21998-05-18 16:09:10 +0000947 """Turn a 10-tuple as returned by parsedate_tz() into a UTC timestamp."""
Guido van Rossuma73033f1998-02-19 00:28:58 +0000948 if data[9] is None:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000949 # No zone info, so localtime is better assumption than GMT
950 return time.mktime(data[:8] + (-1,))
Guido van Rossuma73033f1998-02-19 00:28:58 +0000951 else:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000952 t = time.mktime(data[:8] + (0,))
953 return t - data[9] - time.timezone
Guido van Rossum6cdd7a01996-12-12 18:39:54 +0000954
Guido van Rossum247a78a1999-04-19 18:04:38 +0000955def formatdate(timeval=None):
956 """Returns time format preferred for Internet standards.
957
958 Sun, 06 Nov 1994 08:49:37 GMT ; RFC 822, updated by RFC 1123
Jeremy Hylton6d8c1aa2001-08-27 20:16:53 +0000959
960 According to RFC 1123, day and month names must always be in
961 English. If not for that, this code could use strftime(). It
962 can't because strftime() honors the locale and could generated
963 non-English names.
Guido van Rossum247a78a1999-04-19 18:04:38 +0000964 """
965 if timeval is None:
966 timeval = time.time()
Jeremy Hylton6d8c1aa2001-08-27 20:16:53 +0000967 timeval = time.gmtime(timeval)
968 return "%s, %02d %s %04d %02d:%02d:%02d GMT" % (
969 ["Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"][timeval[6]],
970 timeval[2],
971 ["Jan", "Feb", "Mar", "Apr", "May", "Jun",
972 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"][timeval[1]-1],
Tim Peters83e7ccc2001-09-04 06:37:28 +0000973 timeval[0], timeval[3], timeval[4], timeval[5])
Guido van Rossum247a78a1999-04-19 18:04:38 +0000974
Guido van Rossumb6775db1994-08-01 11:34:53 +0000975
976# When used as script, run a small test program.
977# The first command line argument must be a filename containing one
978# message in RFC-822 format.
979
980if __name__ == '__main__':
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000981 import sys, os
982 file = os.path.join(os.environ['HOME'], 'Mail/inbox/1')
983 if sys.argv[1:]: file = sys.argv[1]
984 f = open(file, 'r')
985 m = Message(f)
986 print 'From:', m.getaddr('from')
987 print 'To:', m.getaddrlist('to')
988 print 'Subject:', m.getheader('subject')
989 print 'Date:', m.getheader('date')
990 date = m.getdate_tz('date')
Guido van Rossum1d2b23e2000-01-17 14:11:04 +0000991 tz = date[-1]
992 date = time.localtime(mktime_tz(date))
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000993 if date:
Guido van Rossum1d2b23e2000-01-17 14:11:04 +0000994 print 'ParsedDate:', time.asctime(date),
995 hhmmss = tz
Guido van Rossum9ab94c11997-12-10 16:17:39 +0000996 hhmm, ss = divmod(hhmmss, 60)
997 hh, mm = divmod(hhmm, 60)
998 print "%+03d%02d" % (hh, mm),
999 if ss: print ".%02d" % ss,
1000 print
1001 else:
1002 print 'ParsedDate:', None
1003 m.rewindbody()
1004 n = 0
1005 while f.readline():
1006 n = n + 1
1007 print 'Lines:', n
1008 print '-'*70
1009 print 'len =', len(m)
Raymond Hettinger54f02222002-06-01 14:18:47 +00001010 if 'Date' in m: print 'Date =', m['Date']
1011 if 'X-Nonsense' in m: pass
Guido van Rossum9ab94c11997-12-10 16:17:39 +00001012 print 'keys =', m.keys()
1013 print 'values =', m.values()
1014 print 'items =', m.items()