Guido van Rossum | f06ee5f | 1996-11-27 19:52:01 +0000 | [diff] [blame] | 1 | #! /usr/bin/env python |
Guido van Rossum | 6244867 | 1996-09-17 21:33:15 +0000 | [diff] [blame] | 2 | |
| 3 | """Classes to handle Unix style, MMDF style, and MH style mailboxes.""" |
| 4 | |
| 5 | |
Guido van Rossum | c7b6882 | 1994-04-28 09:53:33 +0000 | [diff] [blame] | 6 | import rfc822 |
Jack Jansen | 9715779 | 1995-10-23 13:59:53 +0000 | [diff] [blame] | 7 | import os |
Guido van Rossum | c7b6882 | 1994-04-28 09:53:33 +0000 | [diff] [blame] | 8 | |
Skip Montanaro | 17ab123 | 2001-01-24 06:27:27 +0000 | [diff] [blame^] | 9 | __all__ = ["UnixMailbox","MmdfMailbox","MHMailbox","Maildir","BabylMailbox"] |
| 10 | |
Guido van Rossum | c7b6882 | 1994-04-28 09:53:33 +0000 | [diff] [blame] | 11 | class _Mailbox: |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 12 | def __init__(self, fp): |
| 13 | self.fp = fp |
| 14 | self.seekp = 0 |
Guido van Rossum | 8ca8420 | 1998-03-26 20:56:10 +0000 | [diff] [blame] | 15 | |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 16 | def seek(self, pos, whence=0): |
| 17 | if whence==1: # Relative to current position |
| 18 | self.pos = self.pos + pos |
| 19 | if whence==2: # Relative to file's end |
| 20 | self.pos = self.stop + pos |
| 21 | else: # Default - absolute position |
| 22 | self.pos = self.start + pos |
Guido van Rossum | c7b6882 | 1994-04-28 09:53:33 +0000 | [diff] [blame] | 23 | |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 24 | def next(self): |
| 25 | while 1: |
| 26 | self.fp.seek(self.seekp) |
| 27 | try: |
| 28 | self._search_start() |
| 29 | except EOFError: |
| 30 | self.seekp = self.fp.tell() |
| 31 | return None |
| 32 | start = self.fp.tell() |
| 33 | self._search_end() |
| 34 | self.seekp = stop = self.fp.tell() |
Fred Drake | 8152d32 | 2000-12-12 23:20:45 +0000 | [diff] [blame] | 35 | if start != stop: |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 36 | break |
| 37 | return rfc822.Message(_Subfile(self.fp, start, stop)) |
Guido van Rossum | c7b6882 | 1994-04-28 09:53:33 +0000 | [diff] [blame] | 38 | |
Guido van Rossum | c7b6882 | 1994-04-28 09:53:33 +0000 | [diff] [blame] | 39 | |
| 40 | class _Subfile: |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 41 | def __init__(self, fp, start, stop): |
| 42 | self.fp = fp |
| 43 | self.start = start |
| 44 | self.stop = stop |
| 45 | self.pos = self.start |
Guido van Rossum | 8ca8420 | 1998-03-26 20:56:10 +0000 | [diff] [blame] | 46 | |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 47 | def read(self, length = None): |
| 48 | if self.pos >= self.stop: |
| 49 | return '' |
| 50 | remaining = self.stop - self.pos |
| 51 | if length is None or length < 0: |
| 52 | length = remaining |
| 53 | elif length > remaining: |
| 54 | length = remaining |
| 55 | self.fp.seek(self.pos) |
| 56 | data = self.fp.read(length) |
| 57 | self.pos = self.fp.tell() |
| 58 | return data |
Guido van Rossum | c7b6882 | 1994-04-28 09:53:33 +0000 | [diff] [blame] | 59 | |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 60 | def readline(self, length = None): |
| 61 | if self.pos >= self.stop: |
| 62 | return '' |
| 63 | if length is None: |
| 64 | length = self.stop - self.pos |
| 65 | self.fp.seek(self.pos) |
| 66 | data = self.fp.readline(length) |
| 67 | self.pos = self.fp.tell() |
| 68 | return data |
Guido van Rossum | c7b6882 | 1994-04-28 09:53:33 +0000 | [diff] [blame] | 69 | |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 70 | def readlines(self, sizehint = -1): |
| 71 | lines = [] |
| 72 | while 1: |
| 73 | line = self.readline() |
| 74 | if not line: |
| 75 | break |
| 76 | lines.append(line) |
| 77 | if sizehint >= 0: |
| 78 | sizehint = sizehint - len(line) |
| 79 | if sizehint <= 0: |
| 80 | break |
| 81 | return lines |
Guido van Rossum | c7b6882 | 1994-04-28 09:53:33 +0000 | [diff] [blame] | 82 | |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 83 | def tell(self): |
| 84 | return self.pos - self.start |
Guido van Rossum | e256a0f | 1999-03-24 16:20:45 +0000 | [diff] [blame] | 85 | |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 86 | def seek(self, pos, whence=0): |
| 87 | if whence == 0: |
| 88 | self.pos = self.start + pos |
| 89 | elif whence == 1: |
| 90 | self.pos = self.pos + pos |
| 91 | elif whence == 2: |
| 92 | self.pos = self.stop + pos |
Guido van Rossum | c7b6882 | 1994-04-28 09:53:33 +0000 | [diff] [blame] | 93 | |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 94 | def close(self): |
| 95 | del self.fp |
Guido van Rossum | c7b6882 | 1994-04-28 09:53:33 +0000 | [diff] [blame] | 96 | |
Guido van Rossum | c7b6882 | 1994-04-28 09:53:33 +0000 | [diff] [blame] | 97 | |
| 98 | class UnixMailbox(_Mailbox): |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 99 | def _search_start(self): |
| 100 | while 1: |
| 101 | pos = self.fp.tell() |
| 102 | line = self.fp.readline() |
| 103 | if not line: |
| 104 | raise EOFError |
| 105 | if line[:5] == 'From ' and self._isrealfromline(line): |
| 106 | self.fp.seek(pos) |
| 107 | return |
Guido van Rossum | 8ca8420 | 1998-03-26 20:56:10 +0000 | [diff] [blame] | 108 | |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 109 | def _search_end(self): |
| 110 | self.fp.readline() # Throw away header line |
| 111 | while 1: |
| 112 | pos = self.fp.tell() |
| 113 | line = self.fp.readline() |
| 114 | if not line: |
| 115 | return |
| 116 | if line[:5] == 'From ' and self._isrealfromline(line): |
| 117 | self.fp.seek(pos) |
| 118 | return |
Guido van Rossum | c7b6882 | 1994-04-28 09:53:33 +0000 | [diff] [blame] | 119 | |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 120 | # An overridable mechanism to test for From-line-ness. |
| 121 | # You can either specify a different regular expression |
| 122 | # or define a whole new _isrealfromline() method. |
| 123 | # Note that this only gets called for lines starting with |
| 124 | # the 5 characters "From ". |
Guido van Rossum | c7b6882 | 1994-04-28 09:53:33 +0000 | [diff] [blame] | 125 | |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 126 | _fromlinepattern = r"From \s*[^\s]+\s+\w\w\w\s+\w\w\w\s+\d?\d\s+" \ |
| 127 | r"\d?\d:\d\d(:\d\d)?(\s+[^\s]+)?\s+\d\d\d\d\s*$" |
| 128 | _regexp = None |
Guido van Rossum | fbe63de | 1998-04-03 16:04:05 +0000 | [diff] [blame] | 129 | |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 130 | def _isrealfromline(self, line): |
| 131 | if not self._regexp: |
| 132 | import re |
| 133 | self._regexp = re.compile(self._fromlinepattern) |
| 134 | return self._regexp.match(line) |
Guido van Rossum | fbe63de | 1998-04-03 16:04:05 +0000 | [diff] [blame] | 135 | |
Guido van Rossum | fbe63de | 1998-04-03 16:04:05 +0000 | [diff] [blame] | 136 | |
Guido van Rossum | c7b6882 | 1994-04-28 09:53:33 +0000 | [diff] [blame] | 137 | class MmdfMailbox(_Mailbox): |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 138 | def _search_start(self): |
| 139 | while 1: |
| 140 | line = self.fp.readline() |
| 141 | if not line: |
| 142 | raise EOFError |
| 143 | if line[:5] == '\001\001\001\001\n': |
| 144 | return |
Guido van Rossum | 8ca8420 | 1998-03-26 20:56:10 +0000 | [diff] [blame] | 145 | |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 146 | def _search_end(self): |
| 147 | while 1: |
| 148 | pos = self.fp.tell() |
| 149 | line = self.fp.readline() |
| 150 | if not line: |
| 151 | return |
| 152 | if line == '\001\001\001\001\n': |
| 153 | self.fp.seek(pos) |
| 154 | return |
Guido van Rossum | c7b6882 | 1994-04-28 09:53:33 +0000 | [diff] [blame] | 155 | |
Guido van Rossum | c7b6882 | 1994-04-28 09:53:33 +0000 | [diff] [blame] | 156 | |
Jack Jansen | 9715779 | 1995-10-23 13:59:53 +0000 | [diff] [blame] | 157 | class MHMailbox: |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 158 | def __init__(self, dirname): |
| 159 | import re |
Guido van Rossum | 0707fea | 2000-08-10 03:05:26 +0000 | [diff] [blame] | 160 | pat = re.compile('^[1-9][0-9]*$') |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 161 | self.dirname = dirname |
Sjoerd Mullender | d2653a9 | 2000-08-11 07:48:36 +0000 | [diff] [blame] | 162 | # the three following lines could be combined into: |
| 163 | # list = map(long, filter(pat.match, os.listdir(self.dirname))) |
| 164 | list = os.listdir(self.dirname) |
| 165 | list = filter(pat.match, list) |
Guido van Rossum | 0707fea | 2000-08-10 03:05:26 +0000 | [diff] [blame] | 166 | list = map(long, list) |
| 167 | list.sort() |
| 168 | # This only works in Python 1.6 or later; |
| 169 | # before that str() added 'L': |
| 170 | self.boxes = map(str, list) |
Jack Jansen | 9715779 | 1995-10-23 13:59:53 +0000 | [diff] [blame] | 171 | |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 172 | def next(self): |
| 173 | if not self.boxes: |
| 174 | return None |
| 175 | fn = self.boxes[0] |
| 176 | del self.boxes[0] |
| 177 | fp = open(os.path.join(self.dirname, fn)) |
| 178 | return rfc822.Message(fp) |
Guido van Rossum | 8ca8420 | 1998-03-26 20:56:10 +0000 | [diff] [blame] | 179 | |
Guido van Rossum | 9a4d637 | 1998-12-23 22:05:42 +0000 | [diff] [blame] | 180 | |
| 181 | class Maildir: |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 182 | # Qmail directory mailbox |
Guido van Rossum | 9a4d637 | 1998-12-23 22:05:42 +0000 | [diff] [blame] | 183 | |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 184 | def __init__(self, dirname): |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 185 | self.dirname = dirname |
Guido van Rossum | 9a4d637 | 1998-12-23 22:05:42 +0000 | [diff] [blame] | 186 | |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 187 | # check for new mail |
| 188 | newdir = os.path.join(self.dirname, 'new') |
Fred Drake | d9a8dec | 2000-09-22 18:41:50 +0000 | [diff] [blame] | 189 | boxes = [os.path.join(newdir, f) |
| 190 | for f in os.listdir(newdir) if f[0] != '.'] |
Guido van Rossum | 9a4d637 | 1998-12-23 22:05:42 +0000 | [diff] [blame] | 191 | |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 192 | # Now check for current mail in this maildir |
| 193 | curdir = os.path.join(self.dirname, 'cur') |
Fred Drake | d9a8dec | 2000-09-22 18:41:50 +0000 | [diff] [blame] | 194 | boxes += [os.path.join(curdir, f) |
| 195 | for f in os.listdir(curdir) if f[0] != '.'] |
Guido van Rossum | 9a4d637 | 1998-12-23 22:05:42 +0000 | [diff] [blame] | 196 | |
Fred Drake | de3518e | 2000-10-23 13:37:01 +0000 | [diff] [blame] | 197 | self.boxes = boxes |
| 198 | |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 199 | def next(self): |
| 200 | if not self.boxes: |
| 201 | return None |
| 202 | fn = self.boxes[0] |
| 203 | del self.boxes[0] |
Fred Drake | e108a02 | 2000-09-14 14:44:43 +0000 | [diff] [blame] | 204 | fp = open(fn) |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 205 | return rfc822.Message(fp) |
Guido van Rossum | 9a4d637 | 1998-12-23 22:05:42 +0000 | [diff] [blame] | 206 | |
Guido van Rossum | 9a4d637 | 1998-12-23 22:05:42 +0000 | [diff] [blame] | 207 | |
Guido van Rossum | fdf58fe | 1997-05-15 14:33:09 +0000 | [diff] [blame] | 208 | class BabylMailbox(_Mailbox): |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 209 | def _search_start(self): |
| 210 | while 1: |
| 211 | line = self.fp.readline() |
| 212 | if not line: |
| 213 | raise EOFError |
| 214 | if line == '*** EOOH ***\n': |
| 215 | return |
Guido van Rossum | fdf58fe | 1997-05-15 14:33:09 +0000 | [diff] [blame] | 216 | |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 217 | def _search_end(self): |
| 218 | while 1: |
| 219 | pos = self.fp.tell() |
| 220 | line = self.fp.readline() |
| 221 | if not line: |
| 222 | return |
| 223 | if line == '\037\014\n': |
| 224 | self.fp.seek(pos) |
| 225 | return |
Guido van Rossum | fdf58fe | 1997-05-15 14:33:09 +0000 | [diff] [blame] | 226 | |
| 227 | |
Guido van Rossum | 6244867 | 1996-09-17 21:33:15 +0000 | [diff] [blame] | 228 | def _test(): |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 229 | import time |
| 230 | import sys |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 231 | import os |
Jack Jansen | 9715779 | 1995-10-23 13:59:53 +0000 | [diff] [blame] | 232 | |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 233 | args = sys.argv[1:] |
| 234 | if not args: |
| 235 | for key in 'MAILDIR', 'MAIL', 'LOGNAME', 'USER': |
| 236 | if os.environ.has_key(key): |
| 237 | mbox = os.environ[key] |
| 238 | break |
Fred Drake | 13a2c27 | 2000-02-10 17:17:14 +0000 | [diff] [blame] | 239 | else: |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 240 | print "$MAIL, $LOGNAME nor $USER set -- who are you?" |
| 241 | return |
| 242 | else: |
| 243 | mbox = args[0] |
| 244 | if mbox[:1] == '+': |
| 245 | mbox = os.environ['HOME'] + '/Mail/' + mbox[1:] |
| 246 | elif not '/' in mbox: |
| 247 | mbox = '/usr/mail/' + mbox |
| 248 | if os.path.isdir(mbox): |
| 249 | if os.path.isdir(os.path.join(mbox, 'cur')): |
| 250 | mb = Maildir(mbox) |
Fred Drake | 13a2c27 | 2000-02-10 17:17:14 +0000 | [diff] [blame] | 251 | else: |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 252 | mb = MHMailbox(mbox) |
| 253 | else: |
| 254 | fp = open(mbox, 'r') |
| 255 | mb = UnixMailbox(fp) |
| 256 | |
| 257 | msgs = [] |
| 258 | while 1: |
| 259 | msg = mb.next() |
| 260 | if msg is None: |
| 261 | break |
| 262 | msgs.append(msg) |
| 263 | if len(args) <= 1: |
| 264 | msg.fp = None |
| 265 | if len(args) > 1: |
Fred Drake | de3518e | 2000-10-23 13:37:01 +0000 | [diff] [blame] | 266 | num = int(args[1]) |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 267 | print 'Message %d body:'%num |
| 268 | msg = msgs[num-1] |
| 269 | msg.rewindbody() |
| 270 | sys.stdout.write(msg.fp.read()) |
| 271 | else: |
| 272 | print 'Mailbox',mbox,'has',len(msgs),'messages:' |
| 273 | for msg in msgs: |
| 274 | f = msg.getheader('from') or "" |
| 275 | s = msg.getheader('subject') or "" |
| 276 | d = msg.getheader('date') or "" |
Fred Drake | cc4adf2 | 2000-09-30 23:59:04 +0000 | [diff] [blame] | 277 | print '-%20.20s %20.20s %-30.30s'%(f, d[5:], s) |
Guido van Rossum | 6244867 | 1996-09-17 21:33:15 +0000 | [diff] [blame] | 278 | |
| 279 | |
| 280 | if __name__ == '__main__': |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 281 | _test() |