| | |
- AddrlistClass
-
- AddressList
- Message
class AddrlistClass |
| |
Address parser class by Ben Escoto.
To understand what this class does, it helps to have a copy of
RFC-822 in front of you.
Note: this class interface is deprecated and may be removed in the future.
Use rfc822.AddressList instead.
|
| | |
- __init__(self, field)
- Initialize a new instance.
- `field' is an unparsed address header field, containing
- one or more addresses.
- getaddress(self)
- Parse the next address.
- getaddrlist(self)
- Parse all addresses.
- Returns a list containing all of the addresses.
- getaddrspec(self)
- Parse an RFC-822 addr-spec.
- getatom(self)
- Parse an RFC-822 atom.
- getcomment(self)
- Get a parenthesis-delimited fragment from self's field.
- getdelimited(self, beginchar, endchars, allowcomments=1)
- Parse a header fragment delimited by special characters.
- `beginchar' is the start character for the fragment.
- If self is not looking at an instance of `beginchar' then
- getdelimited returns the empty string.
- `endchars' is a sequence of allowable end-delimiting characters.
- Parsing stops when one of these is encountered.
- If `allowcomments' is non-zero, embedded RFC-822 comments
- are allowed within the parsed fragment.
- getdomain(self)
- Get the complete domain name from an address.
- getdomainliteral(self)
- Parse an RFC-822 domain-literal.
- getphraselist(self)
- Parse a sequence of RFC-822 phrases.
- A phrase is a sequence of words, which are in turn either
- RFC-822 atoms or quoted-strings. Phrases are canonicalized
- by squeezing all runs of continuous whitespace into one space.
- getquote(self)
- Get a quote-delimited fragment from self's field.
- getrouteaddr(self)
- Parse a route address (Return-path value).
- This method just skips all the route stuff and returns the addrspec.
- gotonext(self)
- Parse up to the start of the next address.
|
class Message |
| |
Represents a single RFC-822-compliant message.
|
| | |
- __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.
- __init__(self, fp, seekable=1)
- Initialize the class instance and read the headers.
- __len__(self)
- Get the number of headers in a message.
- __setitem__(self, name, value)
- 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.
- __str__(self)
- no doc string
- getheader(self, name, default=None)
- Get the header value for a name.
- This is the normal interface: it return 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.
- This is the normal interface: it return 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.
- 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 RFC822-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 RFC822-like formats with special header formats.
- islast(self, line)
- Determine whether a line is a legal end of RFC-822 headers.
-
- You may override this method if your application wants
- to bend the rules, e.g. to strip trailing whitespace,
- or to recognise 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.
| |