rfc822.Message

Module rfc822 :: Class Message

[show private | hide private]

Class Message

Known Subclasses:: Message

Represents a single RFC 2822-compliant message.

Method Summary
	`__init__(self, fp, seekable)` Initialize the class instance and read the headers.
	`__contains__(self, name)` Determine whether a message contains the named header.
	`__delitem__(self, name)` Delete all occurrences of a specific header, if it is present.
	`__getitem__(self, name)` Get a specific header, as from a dictionary.
	`__iter__(self)`
	`__len__(self)` Get the number of headers in a message.
	`__setitem__(self, name, value)` Set the value of a header.
	`__str__(self)`
	`get(self, name, default)` Get the header value for a name.
	`getaddr(self, name)` Get a single address from a header, as a tuple.
	`getaddrlist(self, name)` Get a list of addresses from a header.
	`getallmatchingheaders(self, name)` Find all header lines matching a given header name.
	`getdate(self, name)` Retrieve a date field from a header.
	`getdate_tz(self, name)` Retrieve a date field from a header as a 10-tuple.
	`getfirstmatchingheader(self, name)` Get the first header line matching name.
	`getheader(self, name, default)` Get the header value for a name.
	`getheaders(self, name)` Get all values for a header.
	`getrawheader(self, name)` A higher-level interface to getfirstmatchingheader().
	`has_key(self, name)` Determine whether a message contains the named header.
	`iscomment(self, line)` Determine whether a line should be skipped entirely.
	`isheader(self, line)` Determine whether a given line is a legal header.
	`islast(self, line)` Determine whether a line is a legal end of RFC 2822 headers.
	`items(self)` Get all of a message's headers.
	`keys(self)` Get all of a message's header field names.
	`readheaders(self)` Read header lines.
	`rewindbody(self)` Rewind the file to the start of the body (if seekable).
	`setdefault(self, name, default)`
	`values(self)` Get all of a message's header field values.

Method Details

init(self, fp, seekable=1)
(Constructor)

Initialize the class instance and read the headers.

contains(self, name)
(In operator)

Determine whether a message contains the named header.

delitem(self, name)
(Index deletion operator)

Delete all occurrences of a specific header, if it is present.

getitem(self, name)
(Indexing operator)

Get a specific header, as from a dictionary.

len(self)
(Length operator)

Get the number of headers in a message.

setitem(self, name, value)
(Index assignment operator)

Set the value of a header.

Note: This is not a perfect inversion of __getitem__, because any changed headers get stuck at the end of the raw-headers list rather than where the altered header was.

get(self, name, default=None)

Get the header value for a name.

This is the normal interface: it returns a stripped version of the header value for a given header name, or None if it doesn't exist. This uses the dictionary version which finds the *last* such header.

getaddr(self, name)

Get a single address from a header, as a tuple.

An example return value: ('Guido van Rossum', 'guido@cwi.nl')

getaddrlist(self, name)

Get a list of addresses from a header.

Retrieves a list of addresses from a header, where each address is a tuple as returned by getaddr(). Scans all named headers, so it works properly with multiple To: or Cc: headers for example.

getallmatchingheaders(self, name)

Find all header lines matching a given header name.

Look through the list of headers and find all lines matching a given header name (and their continuation lines). A list of the lines is returned, without interpretation. If the header does not occur, an empty list is returned. If the header occurs multiple times, all occurrences are returned. Case is not important in the header name.

getdate(self, name)

Retrieve a date field from a header.

Retrieves a date field from the named header, returning a tuple compatible with time.mktime().

getdate_tz(self, name)

Retrieve a date field from a header as a 10-tuple.

The first 9 elements make up a tuple compatible with time.mktime(), and the 10th is the offset of the poster's time zone from GMT/UTC.

getfirstmatchingheader(self, name)

Get the first header line matching name.

This is similar to getallmatchingheaders, but it returns only the first matching header (and its continuation lines).

getheader(self, name, default=None)

Get the header value for a name.

getheaders(self, name)

Get all values for a header.

This returns a list of values for headers given more than once; each value in the result list is stripped in the same way as the result of getheader(). If the header is not given, return an empty list.

getrawheader(self, name)

A higher-level interface to getfirstmatchingheader().

Return a string containing the literal text of the header but with the keyword stripped. All leading, trailing and embedded whitespace is kept in the string, however. Return None if the header does not occur.

has_key(self, name)

Determine whether a message contains the named header.

iscomment(self, line)

Determine whether a line should be skipped entirely.

You may override this method in order to use Message parsing on tagged data in RFC 2822-like formats that support embedded comments or free-text data.

isheader(self, line)

Determine whether a given line is a legal header.

This method should return the header name, suitably canonicalized. You may override this method in order to use Message parsing on tagged data in RFC 2822-like formats with special header formats.

islast(self, line)

Determine whether a line is a legal end of RFC 2822 headers.

       You may override this method if your application wants to bend the
       rules, e.g. to strip trailing whitespace, or to recognize MH template
       separators ('--------').  For convenience (e.g. for code reading from
       sockets) a line consisting of 

also matches.

items(self)

Get all of a message's headers.

Returns a list of name, value tuples.

keys(self)

Get all of a message's header field names.

readheaders(self)

Read header lines.

Read header lines up to the entirely blank line that terminates them. The (normally blank) line that ends the headers is skipped, but not included in the returned list. If a non-header line ends the headers, (which is an error), an attempt is made to backspace over it; it is never included in the returned list.

The variable self.status is set to the empty string if all went well, otherwise it is an error message. The variable self.headers is a completely uninterpreted list of lines contained in the header (so printing them will reproduce the header exactly as it appears in the file).

rewindbody(self)

Rewind the file to the start of the body (if seekable).

values(self)

Get all of a message's header field values.

Generated by Epydoc 2.1 on Fri Jul 27 17:40:03 2007

http://epydoc.sf.net