Fred Drake | 3a0351c | 1998-04-04 07:23:21 +0000 | [diff] [blame] | 1 | \section{Standard Module \module{rfc822}} |
Fred Drake | b91e934 | 1998-07-23 17:59:49 +0000 | [diff] [blame] | 2 | \declaremodule{standard}{rfc822} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 3 | |
Fred Drake | b91e934 | 1998-07-23 17:59:49 +0000 | [diff] [blame] | 4 | \modulesynopsis{Parse \rfc{822} style mail headers.} |
| 5 | |
Fred Drake | cdea8a3 | 1998-03-14 06:17:43 +0000 | [diff] [blame] | 6 | This module defines a class, \class{Message}, which represents a |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 7 | collection of ``email headers'' as defined by the Internet standard |
Fred Drake | c589124 | 1998-02-09 19:16:20 +0000 | [diff] [blame] | 8 | \rfc{822}. It is used in various contexts, usually to read such |
Guido van Rossum | 8729483 | 1998-06-16 22:27:40 +0000 | [diff] [blame] | 9 | headers from a file. This module also defines a helper class |
| 10 | \class{AddressList} for parsing RFC822 addresses. |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 11 | |
Fred Drake | 5ca9033 | 1997-12-16 15:19:47 +0000 | [diff] [blame] | 12 | Note that there's a separate module to read \UNIX{}, MH, and MMDF |
Fred Drake | cdea8a3 | 1998-03-14 06:17:43 +0000 | [diff] [blame] | 13 | style mailbox files: \module{mailbox}\refstmodindex{mailbox}. |
Guido van Rossum | 067a2ac | 1997-06-02 17:30:03 +0000 | [diff] [blame] | 14 | |
Fred Drake | cdea8a3 | 1998-03-14 06:17:43 +0000 | [diff] [blame] | 15 | \begin{classdesc}{Message}{file\optional{, seekable}} |
Guido van Rossum | 1299100 | 1998-06-10 21:34:27 +0000 | [diff] [blame] | 16 | A \class{Message} instance is instantiated with an input object as |
| 17 | parameter. Message relies only on the input object having a |
Fred Drake | 23329d4 | 1998-08-10 17:46:22 +0000 | [diff] [blame^] | 18 | \method{readline()} method; in particular, ordinary file objects |
| 19 | qualify. Instantiation reads headers from the input object up to a |
| 20 | delimiter line (normally a blank line) and stores them in the |
| 21 | instance. |
Guido van Rossum | 1299100 | 1998-06-10 21:34:27 +0000 | [diff] [blame] | 22 | |
Fred Drake | 23329d4 | 1998-08-10 17:46:22 +0000 | [diff] [blame^] | 23 | This class can work with any input object that supports a |
| 24 | \method{readline()} method. If the input object has seek and tell |
| 25 | capability, the \method{rewindbody()} method will work; also, illegal |
| 26 | lines will be pushed back onto the input stream. If the input object |
| 27 | lacks seek but has an \method{unread()} method that can push back a |
| 28 | line of input, \class{Message} will use that to push back illegal |
| 29 | lines. Thus this class can be used to parse messages coming from a |
| 30 | buffered stream. |
Guido van Rossum | 1299100 | 1998-06-10 21:34:27 +0000 | [diff] [blame] | 31 | |
Fred Drake | 23329d4 | 1998-08-10 17:46:22 +0000 | [diff] [blame^] | 32 | The optional \var{seekable} argument is provided as a workaround for |
| 33 | certain stdio libraries in which \cfunction{tell()} discards buffered |
| 34 | data before discovering that the \cfunction{lseek()} system call |
| 35 | doesn't work. For maximum portability, you should set the seekable |
| 36 | argument to zero to prevent that initial \method{tell()} when passing |
| 37 | in an unseekable object such as a a file object created from a socket |
| 38 | object. |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 39 | |
| 40 | Input lines as read from the file may either be terminated by CR-LF or |
| 41 | by a single linefeed; a terminating CR-LF is replaced by a single |
| 42 | linefeed before the line is stored. |
| 43 | |
| 44 | All header matching is done independent of upper or lower case; |
Fred Drake | 23329d4 | 1998-08-10 17:46:22 +0000 | [diff] [blame^] | 45 | e.g.\ \code{\var{m}['From']}, \code{\var{m}['from']} and |
Fred Drake | cdea8a3 | 1998-03-14 06:17:43 +0000 | [diff] [blame] | 46 | \code{\var{m}['FROM']} all yield the same result. |
| 47 | \end{classdesc} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 48 | |
Guido van Rossum | 8729483 | 1998-06-16 22:27:40 +0000 | [diff] [blame] | 49 | \begin{classdesc}{AddressList}{field} |
| 50 | You may instantiate the AddresssList helper class using a single |
Fred Drake | 23329d4 | 1998-08-10 17:46:22 +0000 | [diff] [blame^] | 51 | string parameter, a comma-separated list of \rfc{822} addresses to be |
| 52 | parsed. (The parameter \code{None} yields an empty list.) |
Guido van Rossum | 8729483 | 1998-06-16 22:27:40 +0000 | [diff] [blame] | 53 | \end{classdesc} |
| 54 | |
Guido van Rossum | 843e712 | 1996-12-06 21:23:53 +0000 | [diff] [blame] | 55 | \begin{funcdesc}{parsedate}{date} |
Fred Drake | cdea8a3 | 1998-03-14 06:17:43 +0000 | [diff] [blame] | 56 | Attempts to parse a date according to the rules in \rfc{822}. |
| 57 | however, some mailers don't follow that format as specified, so |
| 58 | \function{parsedate()} tries to guess correctly in such cases. |
Fred Drake | c589124 | 1998-02-09 19:16:20 +0000 | [diff] [blame] | 59 | \var{date} is a string containing an \rfc{822} date, such as |
Fred Drake | cdea8a3 | 1998-03-14 06:17:43 +0000 | [diff] [blame] | 60 | \code{'Mon, 20 Nov 1995 19:12:08 -0500'}. If it succeeds in parsing |
| 61 | the date, \function{parsedate()} returns a 9-tuple that can be passed |
| 62 | directly to \function{time.mktime()}; otherwise \code{None} will be |
Guido van Rossum | 843e712 | 1996-12-06 21:23:53 +0000 | [diff] [blame] | 63 | returned. |
| 64 | \end{funcdesc} |
| 65 | |
| 66 | \begin{funcdesc}{parsedate_tz}{date} |
Fred Drake | cdea8a3 | 1998-03-14 06:17:43 +0000 | [diff] [blame] | 67 | Performs the same function as \function{parsedate()}, but returns |
| 68 | either \code{None} or a 10-tuple; the first 9 elements make up a tuple |
| 69 | that can be passed directly to \function{time.mktime()}, and the tenth |
| 70 | is the offset of the date's timezone from UTC (which is the official |
| 71 | term for Greenwich Mean Time). (Note that the sign of the timezone |
| 72 | offset is the opposite of the sign of the \code{time.timezone} |
| 73 | variable for the same timezone; the latter variable follows the |
| 74 | \POSIX{} standard while this module follows \rfc{822}.) If the input |
| 75 | string has no timezone, the last element of the tuple returned is |
| 76 | \code{None}. |
Guido van Rossum | 843e712 | 1996-12-06 21:23:53 +0000 | [diff] [blame] | 77 | \end{funcdesc} |
| 78 | |
Guido van Rossum | 8cf94e6 | 1998-02-18 05:09:14 +0000 | [diff] [blame] | 79 | \begin{funcdesc}{mktime_tz}{tuple} |
Fred Drake | cdea8a3 | 1998-03-14 06:17:43 +0000 | [diff] [blame] | 80 | Turn a 10-tuple as returned by \function{parsedate_tz()} into a UTC |
| 81 | timestamp. It the timezone item in the tuple is \code{None}, assume |
| 82 | local time. Minor deficiency: this first interprets the first 8 |
| 83 | elements as a local time and then compensates for the timezone |
| 84 | difference; this may yield a slight error around daylight savings time |
Guido van Rossum | 8cf94e6 | 1998-02-18 05:09:14 +0000 | [diff] [blame] | 85 | switch dates. Not enough to worry about for common use. |
| 86 | \end{funcdesc} |
| 87 | |
Guido van Rossum | ecde781 | 1995-03-28 13:35:14 +0000 | [diff] [blame] | 88 | \subsection{Message Objects} |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 89 | \label{message-objects} |
Guido van Rossum | ecde781 | 1995-03-28 13:35:14 +0000 | [diff] [blame] | 90 | |
Fred Drake | cdea8a3 | 1998-03-14 06:17:43 +0000 | [diff] [blame] | 91 | A \class{Message} instance has the following methods: |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 92 | |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 93 | \begin{methoddesc}{rewindbody}{} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 94 | Seek to the start of the message body. This only works if the file |
| 95 | object is seekable. |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 96 | \end{methoddesc} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 97 | |
Guido van Rossum | 444d0f8 | 1998-06-11 13:50:02 +0000 | [diff] [blame] | 98 | \begin{methoddesc}{isheader}{line} |
| 99 | Returns a line's canonicalized fieldname (the dictionary key that will |
| 100 | be used to index it) if the line is a legal RFC822 header; otherwise |
| 101 | returns None (implying that parsing should stop here and the line be |
| 102 | pushed back on the input stream). It is sometimes useful to override |
| 103 | this method in a subclass. |
| 104 | \end{methoddesc} |
| 105 | |
Guido van Rossum | 1299100 | 1998-06-10 21:34:27 +0000 | [diff] [blame] | 106 | \begin{methoddesc}{islast}{line} |
| 107 | Return true if the given line is a delimiter on which Message should |
Guido van Rossum | 444d0f8 | 1998-06-11 13:50:02 +0000 | [diff] [blame] | 108 | stop. The delimiter line is consumed, and the file object's read |
| 109 | location positioned immediately after it. By default this method just |
| 110 | checks that the line is blank, but you can override it in a subclass. |
Guido van Rossum | 1299100 | 1998-06-10 21:34:27 +0000 | [diff] [blame] | 111 | \end{methoddesc} |
| 112 | |
| 113 | \begin{methoddesc}{iscomment}{line} |
| 114 | Return true if the given line should be ignored entirely, just skipped. |
| 115 | By default this is a stub that always returns false, but you can |
| 116 | override it in a subclass. |
| 117 | \end{methoddesc} |
| 118 | |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 119 | \begin{methoddesc}{getallmatchingheaders}{name} |
Guido van Rossum | 6c4f003 | 1995-03-07 10:14:09 +0000 | [diff] [blame] | 120 | Return a list of lines consisting of all headers matching |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 121 | \var{name}, if any. Each physical line, whether it is a continuation |
| 122 | line or not, is a separate list item. Return the empty list if no |
| 123 | header matches \var{name}. |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 124 | \end{methoddesc} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 125 | |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 126 | \begin{methoddesc}{getfirstmatchingheader}{name} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 127 | Return a list of lines comprising the first header matching |
| 128 | \var{name}, and its continuation line(s), if any. Return \code{None} |
| 129 | if there is no header matching \var{name}. |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 130 | \end{methoddesc} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 131 | |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 132 | \begin{methoddesc}{getrawheader}{name} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 133 | Return a single string consisting of the text after the colon in the |
| 134 | first header matching \var{name}. This includes leading whitespace, |
| 135 | the trailing linefeed, and internal linefeeds and whitespace if there |
| 136 | any continuation line(s) were present. Return \code{None} if there is |
| 137 | no header matching \var{name}. |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 138 | \end{methoddesc} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 139 | |
Guido van Rossum | 1299100 | 1998-06-10 21:34:27 +0000 | [diff] [blame] | 140 | \begin{methoddesc}{getheader}{name\optional{, default}} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 141 | Like \code{getrawheader(\var{name})}, but strip leading and trailing |
Guido van Rossum | 1299100 | 1998-06-10 21:34:27 +0000 | [diff] [blame] | 142 | whitespace. Internal whitespace is not stripped. The optional |
| 143 | \var{default} argument can be used to specify a different default to |
| 144 | be returned when there is no header matching \var{name}. |
| 145 | \end{methoddesc} |
| 146 | |
| 147 | \begin{methoddesc}{get}{name\optional{, default}} |
Fred Drake | 23329d4 | 1998-08-10 17:46:22 +0000 | [diff] [blame^] | 148 | An alias for \method{getheader()}, to make the interface more compatible |
Guido van Rossum | 1299100 | 1998-06-10 21:34:27 +0000 | [diff] [blame] | 149 | with regular dictionaries. |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 150 | \end{methoddesc} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 151 | |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 152 | \begin{methoddesc}{getaddr}{name} |
Fred Drake | cdea8a3 | 1998-03-14 06:17:43 +0000 | [diff] [blame] | 153 | Return a pair \code{(\var{full name}, \var{email address})} parsed |
| 154 | from the string returned by \code{getheader(\var{name})}. If no |
| 155 | header matching \var{name} exists, return \code{(None, None)}; |
| 156 | otherwise both the full name and the address are (possibly empty) |
| 157 | strings. |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 158 | |
Fred Drake | cdea8a3 | 1998-03-14 06:17:43 +0000 | [diff] [blame] | 159 | Example: If \var{m}'s first \code{From} header contains the string |
Guido van Rossum | 470be14 | 1995-03-17 16:07:09 +0000 | [diff] [blame] | 160 | \code{'jack@cwi.nl (Jack Jansen)'}, then |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 161 | \code{m.getaddr('From')} will yield the pair |
Guido van Rossum | 470be14 | 1995-03-17 16:07:09 +0000 | [diff] [blame] | 162 | \code{('Jack Jansen', 'jack@cwi.nl')}. |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 163 | If the header contained |
Guido van Rossum | 470be14 | 1995-03-17 16:07:09 +0000 | [diff] [blame] | 164 | \code{'Jack Jansen <jack@cwi.nl>'} instead, it would yield the |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 165 | exact same result. |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 166 | \end{methoddesc} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 167 | |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 168 | \begin{methoddesc}{getaddrlist}{name} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 169 | This is similar to \code{getaddr(\var{list})}, but parses a header |
Fred Drake | 23329d4 | 1998-08-10 17:46:22 +0000 | [diff] [blame^] | 170 | containing a list of email addresses (e.g.\ a \code{To} header) and |
Fred Drake | cdea8a3 | 1998-03-14 06:17:43 +0000 | [diff] [blame] | 171 | returns a list of \code{(\var{full name}, \var{email address})} pairs |
| 172 | (even if there was only one address in the header). If there is no |
| 173 | header matching \var{name}, return an empty list. |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 174 | |
| 175 | XXX The current version of this function is not really correct. It |
| 176 | yields bogus results if a full name contains a comma. |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 177 | \end{methoddesc} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 178 | |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 179 | \begin{methoddesc}{getdate}{name} |
Fred Drake | cdea8a3 | 1998-03-14 06:17:43 +0000 | [diff] [blame] | 180 | Retrieve a header using \method{getheader()} and parse it into a 9-tuple |
| 181 | compatible with \function{time.mktime()}. If there is no header matching |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 182 | \var{name}, or it is unparsable, return \code{None}. |
| 183 | |
| 184 | Date parsing appears to be a black art, and not all mailers adhere to |
| 185 | the standard. While it has been tested and found correct on a large |
| 186 | collection of email from many sources, it is still possible that this |
| 187 | function may occasionally yield an incorrect result. |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 188 | \end{methoddesc} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 189 | |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 190 | \begin{methoddesc}{getdate_tz}{name} |
Fred Drake | cdea8a3 | 1998-03-14 06:17:43 +0000 | [diff] [blame] | 191 | Retrieve a header using \method{getheader()} and parse it into a |
| 192 | 10-tuple; the first 9 elements will make a tuple compatible with |
| 193 | \function{time.mktime()}, and the 10th is a number giving the offset |
| 194 | of the date's timezone from UTC. Similarly to \method{getdate()}, if |
Guido van Rossum | 843e712 | 1996-12-06 21:23:53 +0000 | [diff] [blame] | 195 | there is no header matching \var{name}, or it is unparsable, return |
| 196 | \code{None}. |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 197 | \end{methoddesc} |
Guido van Rossum | 843e712 | 1996-12-06 21:23:53 +0000 | [diff] [blame] | 198 | |
Fred Drake | cdea8a3 | 1998-03-14 06:17:43 +0000 | [diff] [blame] | 199 | \class{Message} instances also support a read-only mapping interface. |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 200 | In particular: \code{\var{m}[name]} is like |
| 201 | \code{\var{m}.getheader(name)} but raises \exception{KeyError} if |
| 202 | there is no matching header; and \code{len(\var{m})}, |
Fred Drake | cdea8a3 | 1998-03-14 06:17:43 +0000 | [diff] [blame] | 203 | \code{\var{m}.has_key(name)}, \code{\var{m}.keys()}, |
| 204 | \code{\var{m}.values()} and \code{\var{m}.items()} act as expected |
| 205 | (and consistently). |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 206 | |
Fred Drake | cdea8a3 | 1998-03-14 06:17:43 +0000 | [diff] [blame] | 207 | Finally, \class{Message} instances have two public instance variables: |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 208 | |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 209 | \begin{memberdesc}{headers} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 210 | A list containing the entire set of header lines, in the order in |
Guido van Rossum | 8729483 | 1998-06-16 22:27:40 +0000 | [diff] [blame] | 211 | which they were read (except that setitem calls may disturb this |
| 212 | order). Each line contains a trailing newline. The |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 213 | blank line terminating the headers is not contained in the list. |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 214 | \end{memberdesc} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 215 | |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 216 | \begin{memberdesc}{fp} |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 217 | The file object passed at instantiation time. |
Fred Drake | e14dde2 | 1998-04-04 06:19:30 +0000 | [diff] [blame] | 218 | \end{memberdesc} |
Guido van Rossum | 8729483 | 1998-06-16 22:27:40 +0000 | [diff] [blame] | 219 | |
| 220 | \subsection{AddressList Objects} |
| 221 | \label{addresslist-objects} |
| 222 | |
| 223 | An \class{AddressList} instance has the following methods: |
| 224 | |
| 225 | \begin{methoddesc}{__len__}{name} |
| 226 | Return the number of addresses in the address list. |
| 227 | \end{methoddesc} |
| 228 | |
| 229 | \begin{methoddesc}{__str__}{name} |
| 230 | Return a canonicalized string representation of the address list. |
| 231 | Addresses are rendered in "name" <host@domain> form, comma-separated. |
| 232 | \end{methoddesc} |
| 233 | |
| 234 | \begin{methoddesc}{__add__}{name} |
| 235 | Return an AddressList instance that contains all addresses in both |
| 236 | AddressList operands, with duplicates removed (set union). |
| 237 | \end{methoddesc} |
| 238 | |
| 239 | \begin{methoddesc}{__sub__}{name} |
| 240 | Return an AddressList instance that contains every address in the |
| 241 | left-hand AddressList operand that is not present in the right-hand |
| 242 | address operand (set difference). |
| 243 | \end{methoddesc} |
| 244 | |
| 245 | |
| 246 | Finally, \class{AddressList} instances have one public instance variable: |
| 247 | |
| 248 | \begin{memberdesc}{addresslist} |
| 249 | A list of tuple string pairs, one per address. In each member, the |
| 250 | first is the canonicalized name part of the address, the second is the |
| 251 | route-address (@-separated host-domain pair). |
| 252 | \end{memberdesc} |