Vega strike Python Modules doc: Message Class Reference

All Data Structures Namespaces Files Functions Variables

Inheritance diagram for Message:

Public Member Functions
def	__init__

def	__repr__

def	getheadertext

def	getbodytext

def	getbodyparts

def	getbody

Public Member Functions inherited from Message
def	__init__

def	parsetype

def	parseplist

def	getplist

def	getparam

def	getparamnames

def	getencoding

def	gettype

def	getmaintype

def	getsubtype

Public Member Functions inherited from Message
def	__init__

def	rewindbody

def	readheaders

def	isheader

def	islast

def	iscomment

def	getallmatchingheaders

def	getfirstmatchingheader

def	getrawheader

def	getheader

def	getheaders

def	getaddr

def	getaddrlist

def	getdate

def	getdate_tz

def	__len__

def	__getitem__

def	__setitem__

def	__delitem__

def	get

def	setdefault

def	has_key

def	keys

def	values

def	items

def	__str__

Data Fields
	folder

	number

Data Fields inherited from Message
	encodingheader

	typeheader

	plisttext

	type

	maintype

	subtype

	plist

Data Fields inherited from Message
	fp

	seekable

	startofheaders

	startofbody

	dict

	unixfrom

	headers

	status

Additional Inherited Members
Static Public Attributes inherited from Message
	get = getheader

Detailed Description

Definition at line 662 of file mhlib.py.

Constructor & Destructor Documentation

def __init__	(	self,
		f,
		n,
		fp = `None`
	)

Constructor.

Definition at line 664 of file mhlib.py.

 
     def __init__(self, f, n, fp = None):
         """Constructor."""
         self.folder = f
         self.number = n
         if not fp:
             path = f.getmessagefilename(n)
             fp = open(path, 'r')
         mimetools.Message.__init__(self, fp)

Member Function Documentation

def __repr__ ( self)

String representation.

Definition at line 673 of file mhlib.py.

References Message.folder, Breakpoint.number, and Message.number.

 
     def __repr__(self):
         """String representation."""
         return 'Message(%s, %s)' % (repr(self.folder), self.number)

def getbody ( self)

Return body, either a string or a list of messages.

Definition at line 728 of file mhlib.py.

References Message.getbodyparts(), Message.getbodytext(), and Message.getmaintype().

 
     def getbody(self):
         """Return body, either a string or a list of messages."""
         if self.getmaintype() == 'multipart':
             return self.getbodyparts()
         else:
             return self.getbodytext()
 

def getbodyparts ( self)

Only for multipart messages: return the message's body as a
list of SubMessage objects.  Each submessage object behaves
(almost) as a Message object.

Definition at line 708 of file mhlib.py.

References Message.folder, _Mailbox.fp, _Subfile.fp, MultiFile.fp, Message.fp, HTTPResponse.fp, FieldStorage.fp, Message.getmaintype(), Message.getparam(), Breakpoint.number, Message.number, Message.startofbody, and locale.str().

 
     def getbodyparts(self):
         """Only for multipart messages: return the message's body as a
         list of SubMessage objects.  Each submessage object behaves
         (almost) as a Message object."""
         if self.getmaintype() != 'multipart':
             raise Error, 'Content-Type is not multipart/*'
         bdry = self.getparam('boundary')
         if not bdry:
             raise Error, 'multipart/* without boundary param'
         self.fp.seek(self.startofbody)
         mf = multifile.MultiFile(self.fp)
         mf.push(bdry)
         parts = []
         while mf.next():
             n = str(self.number) + '.' + `1 + len(parts)`
             part = SubMessage(self.folder, n, mf)
             parts.append(part)
         mf.pop()
         return parts

def getbodytext	(	self,
		decode = `1`
	)

Return the message's body text as string.  This undoes a
Content-Transfer-Encoding, but does not interpret other MIME
features (e.g. multipart messages).  To suppress decoding,
pass 0 as an argument.

Definition at line 694 of file mhlib.py.

References mimetools.decode(), _Mailbox.fp, _Subfile.fp, MultiFile.fp, Message.fp, HTTPResponse.fp, FieldStorage.fp, Message.getencoding(), and Message.startofbody.

 
     def getbodytext(self, decode = 1):
         """Return the message's body text as string.  This undoes a
         Content-Transfer-Encoding, but does not interpret other MIME
         features (e.g. multipart messages).  To suppress decoding,
         pass 0 as an argument."""
         self.fp.seek(self.startofbody)
         encoding = self.getencoding()
         if not decode or encoding in ('', '7bit', '8bit', 'binary'):
             return self.fp.read()
         from StringIO import StringIO
         output = StringIO()
         mimetools.decode(self.fp, output, encoding)
         return output.getvalue()

def getheadertext	(	self,
		pred = `None`
	)

Return the message's header text as a string.  If an
argument is specified, it is used as a filter predicate to
decide which headers to return (its argument is the header
name converted to lower case).

Definition at line 677 of file mhlib.py.

References Message.headers, BaseHTTPRequestHandler.headers, MiniFieldStorage.headers, FieldStorage.headers, HTTP.headers, dospath.join(), and string.lower().

 
     def getheadertext(self, pred = None):
         """Return the message's header text as a string.  If an
         argument is specified, it is used as a filter predicate to
         decide which headers to return (its argument is the header
         name converted to lower case)."""
         if not pred:
             return ''.join(self.headers)
         headers = []
         hit = 0
         for line in self.headers:
             if not line[0].isspace():
                 i = line.find(':')
                 if i > 0:
                     hit = pred(line[:i].lower())
             if hit: headers.append(line)
         return ''.join(headers)

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation