#!/usr/bin/env python2.3 '''The getmail Message class. ''' __all__ = [ 'Message', ] import sys import os import time import cStringIO import re import email import email.Errors import email.Utils import email.Parser from email.Generator import Generator try: from email.header import Header except ImportError, o: try: from email.Header import Header except ImportError, o: # Python < 2.5 from email import Header from getmailcore.exceptions import * from getmailcore.utilities import mbox_from_escape, format_header, \ address_no_brackets import getmailcore.logging if sys.hexversion < 0x02040000: # email module in Python 2.3 uses more recursion to parse messages or # similar; a user reported recursion errors with a message with ~300 # MIME parts. # Hack around it by increasing the recursion limit. sys.setrecursionlimit(2000) message_attributes = ( 'sender', 'received_by', 'received_from', 'received_with', 'recipient' ) RE_FROMLINE = re.compile(r'^(>*From )', re.MULTILINE) ####################################### def corrupt_message(why, fromlines=None, fromstring=None): log = getmailcore.logging.Logger() log.error('failed to parse retrieved message; constructing container for ' 'contents\n') if fromlines == fromstring == None: raise SystemExit('corrupt_message() called with wrong arguments') msg = email.message_from_string('') msg['From'] = '"unknown sender" <>' msg['Subject'] = 'Corrupt message received' msg['Date'] = email.Utils.formatdate(localtime=True) body = [ 'A badly-corrupt message was retrieved and could not be parsed', 'for the following reason:', '', ' %s' % why, '', 'Below the following line is the original message contents.', '', '--------------------------------------------------------------', ] if fromlines: body.extend([line.rstrip() for line in fromlines]) elif fromstring: body.extend([line.rstrip() for line in fromstring.splitlines()]) msg.set_payload(os.linesep.join(body)) for attr in message_attributes: setattr(msg, attr, '') return msg ####################################### class Message(object): '''Message class for getmail. Does sanity-checking on attribute accesses and provides some convenient interfaces to an underlying email.Message() object. ''' __slots__ = ( '__msg', '__raw', #'log', 'sender', 'received_by', 'received_from', 'received_with', 'recipient', ) def __init__(self, fromlines=None, fromstring=None, fromfile=None): #self.log = Logger() self.recipient = None self.received_by = None self.received_from = None self.received_with = None self.__raw = None parser = email.Parser.Parser() # Message is instantiated with fromlines for POP3, fromstring for # IMAP (both of which can be badly-corrupted or invalid, i.e. spam, # MS worms, etc). It's instantiated with fromfile for the output # of filters, etc, which should be saner. if fromlines: try: self.__msg = parser.parsestr(os.linesep.join(fromlines)) except email.Errors.MessageError, o: self.__msg = corrupt_message(o, fromlines=fromlines) self.__raw = os.linesep.join(fromlines) elif fromstring: try: self.__msg = parser.parsestr(fromstring) except email.Errors.MessageError, o: self.__msg = corrupt_message(o, fromstring=fromstring) self.__raw = fromstring elif fromfile: try: self.__msg = parser.parse(fromfile) except email.Errors.MessageError, o: # Shouldn't happen self.__msg = corrupt_message(o, fromstring=fromfile.read()) # fromfile is only used by getmail_maildir, getmail_mbox, and # from reading the output of a filter. Ignore __raw here. else: # Can't happen? raise SystemExit('Message() called with wrong arguments') self.sender = address_no_brackets(self.__msg['return-path'] or 'unknown') def content(self): return self.__msg def copyattrs(self, othermsg): for attr in message_attributes: setattr(self, attr, getattr(othermsg, attr)) def flatten(self, delivered_to, received, mangle_from=False, include_from=False): '''Return a string with native EOL convention. The email module apparently doesn't always use native EOL, so we force it by writing out what we need, letting the generator write out the message, splitting it into lines, and joining them with the platform EOL. Note on mangle_from: the Python email.Generator class apparently only quotes "From ", not ">From " (i.e. it uses mboxo format instead of mboxrd). So we don't use its mangling, and do it by hand instead. ''' if include_from: # Mbox-style From line, not rfc822 From: header field. fromline = 'From %s %s' % (mbox_from_escape(self.sender), time.asctime()) + os.linesep else: fromline = '' # Write the Return-Path: header rpline = format_header('Return-Path', '<%s>' % self.sender) # Remove previous Return-Path: header fields. del self.__msg['Return-Path'] if delivered_to: dtline = format_header('Delivered-To', self.recipient or 'unknown') else: dtline = '' if received: content = 'from %s by %s with %s' % ( self.received_from, self.received_by, self.received_with ) if self.recipient is not None: content += ' for <%s>' % self.recipient content += '; ' + time.strftime('%d %b %Y %H:%M:%S -0000', time.gmtime()) receivedline = format_header('Received', content) else: receivedline = '' # From_ handled above, always tell the generator not to include it try: tmpf = cStringIO.StringIO() gen = Generator(tmpf, False, 0) gen.flatten(self.__msg, False) strmsg = tmpf.getvalue() if mangle_from: # do mboxrd-style "From " line quoting strmsg = RE_FROMLINE.sub(r'>\1', strmsg) return (fromline + rpline + dtline + receivedline + os.linesep.join(strmsg.splitlines() + [''])) except TypeError, o: # email module chokes on some badly-misformatted messages, even # late during flatten(). Hope this is fixed in Python 2.4. if self.__raw is None: # Argh -- a filter took a correctly-formatted message # and returned a badly-misformatted one? raise getmailDeliveryError('failed to parse retrieved message ' 'and could not recover (%s)' % o) self.__msg = corrupt_message(o, fromstring=self.__raw) return self.flatten(delivered_to, received, mangle_from, include_from) def add_header(self, name, content): self.__msg[name] = Header(content.rstrip(), 'utf-8') def remove_header(self, name): del self.__msg[name] def headers(self): return self.__msg._headers def get_all(self, name, failobj=None): return self.__msg.get_all(name, failobj)