Vega strike Python Modules doc: AddrlistClass Class Reference

All Data Structures Namespaces Files Functions Variables

Inheritance diagram for AddrlistClass:

Public Member Functions
def	__init__

def	gotonext

def	getaddrlist

def	getaddress

def	getrouteaddr

def	getaddrspec

def	getdomain

def	getdelimited

def	getquote

def	getcomment

def	getdomainliteral

def	getatom

def	getphraselist

Data Fields
	specials

	pos

	LWS

	CR

	atomends

	phraseends

	field

	commentlist

Detailed Description

Address parser class by Ben Escoto.

To understand what this class does, it helps to have a copy of
RFC 2822 in front of you.

http://www.faqs.org/rfcs/rfc2822.html

Note: this class interface is deprecated and may be removed in the future.
Use rfc822.AddressList instead.

Definition at line 505 of file rfc822.py.

Constructor & Destructor Documentation

def __init__	(	self,
		field
	)

Initialize a new instance.

`field' is an unparsed address header field, containing one or more
addresses.

Definition at line 517 of file rfc822.py.

 
     def __init__(self, field):
         """Initialize a new instance.
 
         `field' is an unparsed address header field, containing one or more
         addresses.
         """
         self.specials = '()<>@,:;.\"[]'
         self.pos = 0
         self.LWS = ' \t'
         self.CR = '\r\n'
         self.atomends = self.specials + self.LWS + self.CR
         # Note that RFC 2822 now specifies `.' as obs-phrase, meaning that it
         # is obsolete syntax.  RFC 2822 requires that we recognize obsolete
         # syntax, so allow dots in phrases.
         self.phraseends = self.atomends.replace('.', '')
         self.field = field
         self.commentlist = []

Member Function Documentation

def getaddress ( self)

Parse the next address.

Definition at line 558 of file rfc822.py.

References AddrlistClass.commentlist, AddrlistClass.field, AddrlistClass.getaddress(), AddrlistClass.getaddrspec(), AddrlistClass.getphraselist(), AddrlistClass.getrouteaddr(), AddrlistClass.gotonext(), dospath.join(), _Subfile.pos, MatchObject.pos, AddrlistClass.pos, and AddrlistClass.specials.

 
     def getaddress(self):
         """Parse the next address."""
         self.commentlist = []
         self.gotonext()
 
         oldpos = self.pos
         oldcl = self.commentlist
         plist = self.getphraselist()
 
         self.gotonext()
         returnlist = []
 
         if self.pos >= len(self.field):
             # Bad email address technically, no domain.
             if plist:
                 returnlist = [(' '.join(self.commentlist), plist[0])]
 
         elif self.field[self.pos] in '.@':
             # email address is just an addrspec
             # this isn't very efficient since we start over
             self.pos = oldpos
             self.commentlist = oldcl
             addrspec = self.getaddrspec()
             returnlist = [(' '.join(self.commentlist), addrspec)]
 
         elif self.field[self.pos] == ':':
             # address is a group
             returnlist = []
 
             fieldlen = len(self.field)
             self.pos = self.pos + 1
             while self.pos < len(self.field):
                 self.gotonext()
                 if self.pos < fieldlen and self.field[self.pos] == ';':
                     self.pos = self.pos + 1
                     break
                 returnlist = returnlist + self.getaddress()
 
         elif self.field[self.pos] == '<':
             # Address is a phrase then a route addr
             routeaddr = self.getrouteaddr()
 
             if self.commentlist:
                 returnlist = [(' '.join(plist) + ' (' + \
                          ' '.join(self.commentlist) + ')', routeaddr)]
             else: returnlist = [(' '.join(plist), routeaddr)]
 
         else:
             if plist:
                 returnlist = [(' '.join(self.commentlist), plist[0])]
             elif self.field[self.pos] in self.specials:
                 self.pos = self.pos + 1
 
         self.gotonext()
         if self.pos < len(self.field) and self.field[self.pos] == ',':
             self.pos = self.pos + 1
         return returnlist

def getaddrspec ( self)

Parse an RFC 2822 addr-spec.

Definition at line 648 of file rfc822.py.

References AddrlistClass.atomends, AddrlistClass.field, AddrlistClass.getatom(), AddrlistClass.getdomain(), AddrlistClass.getquote(), AddrlistClass.gotonext(), dospath.join(), _Subfile.pos, MatchObject.pos, and AddrlistClass.pos.

 
     def getaddrspec(self):
         """Parse an RFC 2822 addr-spec."""
         aslist = []
 
         self.gotonext()
         while self.pos < len(self.field):
             if self.field[self.pos] == '.':
                 aslist.append('.')
                 self.pos = self.pos + 1
             elif self.field[self.pos] == '"':
                 aslist.append('"%s"' % self.getquote())
             elif self.field[self.pos] in self.atomends:
                 break
             else: aslist.append(self.getatom())
             self.gotonext()
 
         if self.pos >= len(self.field) or self.field[self.pos] != '@':
             return ''.join(aslist)
 
         aslist.append('@')
         self.pos = self.pos + 1
         self.gotonext()
         return ''.join(aslist) + self.getdomain()

def getatom	(	self,
		atomends = `None`
	)

Parse an RFC 2822 atom.

Optional atomends specifies a different set of end token delimiters
(the default is to use self.atomends).  This is used e.g. in
getphraselist() since phrase endings must not include the `.' (which
is legal in phrases).

Definition at line 738 of file rfc822.py.

References AddrlistClass.atomends, AddrlistClass.field, dospath.join(), _Subfile.pos, MatchObject.pos, and AddrlistClass.pos.

 
     def getatom(self, atomends=None):
         """Parse an RFC 2822 atom.
 
         Optional atomends specifies a different set of end token delimiters
         (the default is to use self.atomends).  This is used e.g. in
         getphraselist() since phrase endings must not include the `.' (which
         is legal in phrases)."""
         atomlist = ['']
         if atomends is None:
             atomends = self.atomends
 
         while self.pos < len(self.field):
             if self.field[self.pos] in atomends:
                 break
             else: atomlist.append(self.field[self.pos])
             self.pos = self.pos + 1
 
         return ''.join(atomlist)

def 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 2822 comments are allowed
within the parsed fragment.

Definition at line 690 of file rfc822.py.

References AddrlistClass.field, AddrlistClass.getcomment(), dospath.join(), _Subfile.pos, MatchObject.pos, and AddrlistClass.pos.

 
     def 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 2822 comments are allowed
         within the parsed fragment.
         """
         if self.field[self.pos] != beginchar:
             return ''
 
         slist = ['']
         quote = 0
         self.pos = self.pos + 1
         while self.pos < len(self.field):
             if quote == 1:
                 slist.append(self.field[self.pos])
                 quote = 0
             elif self.field[self.pos] in endchars:
                 self.pos = self.pos + 1
                 break
             elif allowcomments and self.field[self.pos] == '(':
                 slist.append(self.getcomment())
             elif self.field[self.pos] == '\\':
                 quote = 1
             else:
                 slist.append(self.field[self.pos])
             self.pos = self.pos + 1
 
         return ''.join(slist)

def getdomain ( self)

Get the complete domain name from an address.

Definition at line 672 of file rfc822.py.

References AddrlistClass.atomends, AddrlistClass.field, AddrlistClass.getatom(), AddrlistClass.getcomment(), AddrlistClass.getdomainliteral(), dospath.join(), AddrlistClass.LWS, _Subfile.pos, MatchObject.pos, and AddrlistClass.pos.

 
     def getdomain(self):
         """Get the complete domain name from an address."""
         sdlist = []
         while self.pos < len(self.field):
             if self.field[self.pos] in self.LWS:
                 self.pos = self.pos + 1
             elif self.field[self.pos] == '(':
                 self.commentlist.append(self.getcomment())
             elif self.field[self.pos] == '[':
                 sdlist.append(self.getdomainliteral())
             elif self.field[self.pos] == '.':
                 self.pos = self.pos + 1
                 sdlist.append('.')
             elif self.field[self.pos] in self.atomends:
                 break
             else: sdlist.append(self.getatom())
         return ''.join(sdlist)

def getphraselist ( self)

Parse a sequence of RFC 2822 phrases.

A phrase is a sequence of words, which are in turn either RFC 2822
atoms or quoted-strings.  Phrases are canonicalized by squeezing all
runs of continuous whitespace into one space.

Definition at line 757 of file rfc822.py.

References AddrlistClass.field, AddrlistClass.getatom(), AddrlistClass.getcomment(), AddrlistClass.getquote(), AddrlistClass.LWS, AddrlistClass.phraseends, _Subfile.pos, MatchObject.pos, and AddrlistClass.pos.

 
     def getphraselist(self):
         """Parse a sequence of RFC 2822 phrases.
 
         A phrase is a sequence of words, which are in turn either RFC 2822
         atoms or quoted-strings.  Phrases are canonicalized by squeezing all
         runs of continuous whitespace into one space.
         """
         plist = []
 
         while self.pos < len(self.field):
             if self.field[self.pos] in self.LWS:
                 self.pos = self.pos + 1
             elif self.field[self.pos] == '"':
                 plist.append(self.getquote())
             elif self.field[self.pos] == '(':
                 self.commentlist.append(self.getcomment())
             elif self.field[self.pos] in self.phraseends:
                 break
             else:
                 plist.append(self.getatom(self.phraseends))
 
         return plist

def getrouteaddr ( self)

Parse a route address (Return-path value).

This method just skips all the route stuff and returns the addrspec.

Definition at line 616 of file rfc822.py.

References AddrlistClass.field, AddrlistClass.getaddrspec(), AddrlistClass.getdomain(), AddrlistClass.gotonext(), _Subfile.pos, MatchObject.pos, and AddrlistClass.pos.

 
     def getrouteaddr(self):
         """Parse a route address (Return-path value).
 
         This method just skips all the route stuff and returns the addrspec.
         """
         if self.field[self.pos] != '<':
             return
 
         expectroute = 0
         self.pos = self.pos + 1
         self.gotonext()
         adlist = ""
         while self.pos < len(self.field):
             if expectroute:
                 self.getdomain()
                 expectroute = 0
             elif self.field[self.pos] == '>':
                 self.pos = self.pos + 1
                 break
             elif self.field[self.pos] == '@':
                 self.pos = self.pos + 1
                 expectroute = 1
             elif self.field[self.pos] == ':':
                 self.pos = self.pos + 1
             else:
                 adlist = self.getaddrspec()
                 self.pos = self.pos + 1
                 break
             self.gotonext()
 
         return adlist

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation