| 1 |
<pre>Network Working Group G. Neufeld |
| 2 |
Request for Comments: 2369 Nisto |
| 3 |
Category: Standards Track J. Baer |
| 4 |
SkyWeyr Technologies |
| 5 |
July 1998 |
| 6 |
|
| 7 |
|
| 8 |
<span class="h1">The Use of URLs as Meta-Syntax for Core Mail List Commands</span> |
| 9 |
<span class="h1">and their Transport through Message Header Fields</span> |
| 10 |
|
| 11 |
Status of this Memo |
| 12 |
|
| 13 |
This document specifies an Internet standards track protocol for the |
| 14 |
Internet community, and requests discussion and suggestions for |
| 15 |
improvements. Please refer to the current edition of the "Internet |
| 16 |
Official Protocol Standards" (STD 1) for the standardization state |
| 17 |
and status of this protocol. Distribution of this memo is unlimited. |
| 18 |
|
| 19 |
Copyright Notice |
| 20 |
|
| 21 |
Copyright (C) The Internet Society (1998). All Rights Reserved. |
| 22 |
|
| 23 |
Abstract |
| 24 |
|
| 25 |
The mailing list command specification header fields are a set of |
| 26 |
structured fields to be added to email messages sent by email |
| 27 |
distribution lists. Each field typically contains a URL (usually |
| 28 |
mailto [<a href="./rfc2368" title=""The mailto URL scheme"">RFC2368</a>]) locating the relevant information or performing the |
| 29 |
command directly. The three core header fields described in this |
| 30 |
document are List-Help, List-Subscribe, and List-Unsubscribe. |
| 31 |
|
| 32 |
There are three other header fields described here which, although |
| 33 |
not as widely applicable, will have utility for a sufficient number |
| 34 |
of mailing lists to justify their formalization here. These are |
| 35 |
List-Post, List-Owner and List-Archive. |
| 36 |
|
| 37 |
By including these header fields, list servers can make it possible |
| 38 |
for mail clients to provide automated tools for users to perform list |
| 39 |
functions. This could take the form of a menu item, push button, or |
| 40 |
other user interface element. The intent is to simplify the user |
| 41 |
experience, providing a common interface to the often cryptic and |
| 42 |
varied mailing list manager commands. |
| 43 |
|
| 44 |
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", |
| 45 |
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this |
| 46 |
document are to be interpreted as described in <a href="./rfc2119">RFC 2119</a>. |
| 47 |
|
| 48 |
|
| 49 |
|
| 50 |
|
| 51 |
|
| 52 |
<span class="grey">Neufeld & Baer Standards Track [Page 1]</span></pre> |
| 53 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span> |
| 54 |
<span class="grey"><a href="./rfc2369">RFC 2369</a> URLs as Meta-Syntax July 1998</span> |
| 55 |
|
| 56 |
|
| 57 |
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span> |
| 58 |
|
| 59 |
This is a proposal for additional header fields to be added to email |
| 60 |
messages sent by email distribution lists. The content of each new |
| 61 |
field is typically a URL - usually mailto [<a href="./rfc2368" title=""The mailto URL scheme"">RFC2368</a>] - which locates |
| 62 |
the relevant information or performs the command directly. MTAs |
| 63 |
generating the header fields SHOULD usually include a mailto based |
| 64 |
command, in addition to any other protocols used, in order to support |
| 65 |
users who do not have access to non-mail-based protocols. |
| 66 |
|
| 67 |
Implementing these fields will be optional. Significant functionality |
| 68 |
and convenience can be gained by including them, however. Many list |
| 69 |
managers, especially as the proposal first gains acceptance, MAY |
| 70 |
choose to implement only one or two of the fields. The List-Help |
| 71 |
field is the most useful individual field since it provides an access |
| 72 |
point to detailed user support information, and accommodates almost |
| 73 |
all existing list managers command sets. The List-Subscribe and |
| 74 |
List-Unsubscribe fields are also very useful, but cannot describe |
| 75 |
some list manager syntaxes at this time (those which require variable |
| 76 |
substitution). See <a href="#appendix-A.5">appendix A.5</a> for an explanation. |
| 77 |
|
| 78 |
The description of command syntax provided by the fields can be used |
| 79 |
by mail client applications to provide simplified and consistent user |
| 80 |
access to email distribution list functions. This could take the form |
| 81 |
of menu items, push buttons, or other user interface elements. The |
| 82 |
intent is to simplify the user experience, providing a common |
| 83 |
interface to the often cryptic and varied mailing list manager |
| 84 |
commands. |
| 85 |
|
| 86 |
Consideration has been given to avoiding the creation of too many |
| 87 |
fields, while at the same time avoiding the overloading of individual |
| 88 |
fields and keeping the syntax clear and simple. |
| 89 |
|
| 90 |
The use of these fields does not remove the requirement to support |
| 91 |
the -Request command address for mailing lists [<a href="./rfc2142" title=""Mailbox Names for Common Services, Roles and Functions"">RFC2142</a>]. |
| 92 |
|
| 93 |
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. The Command Syntax</span> |
| 94 |
|
| 95 |
The list header fields are subject to the encoding and character |
| 96 |
restrictions for mail headers as described in [<a href="./rfc822" title=""Standard for the Format of ARPA Internet Text Messages"">RFC822</a>]. Additionally, |
| 97 |
the URL content is further restricted to the set of URL safe |
| 98 |
characters [<a href="./rfc1738" title=""Uniform Resource Locators (URL)"">RFC1738</a>]. |
| 99 |
|
| 100 |
The contents of the list header fields mostly consist of angle- |
| 101 |
bracket ('<', '>') enclosed URLs, with internal whitespace being |
| 102 |
ignored. MTAs MUST NOT insert whitespace within the brackets, but |
| 103 |
client applications should treat any whitespace, that might be |
| 104 |
inserted by poorly behaved MTAs, as characters to ignore. |
| 105 |
|
| 106 |
|
| 107 |
|
| 108 |
<span class="grey">Neufeld & Baer Standards Track [Page 2]</span></pre> |
| 109 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span> |
| 110 |
<span class="grey"><a href="./rfc2369">RFC 2369</a> URLs as Meta-Syntax July 1998</span> |
| 111 |
|
| 112 |
|
| 113 |
A list of multiple, alternate, URLs MAY be specified by a comma- |
| 114 |
separated list of angle-bracket enclosed URLs. The URLs have order of |
| 115 |
preference from left to right. The client application should use the |
| 116 |
left most protocol that it supports, or knows how to access by a |
| 117 |
separate application. By this mechanism, protocols like http may be |
| 118 |
specified while still providing the basic mailto support for those |
| 119 |
clients who do not have access to non-mail protocols. The client |
| 120 |
should only use one of the available URLs for a command, using |
| 121 |
another only if the first one used failed. |
| 122 |
|
| 123 |
The use of URLs allows for the use of the syntax with existing URL |
| 124 |
supporting applications. As the standard for URLs is extended, the |
| 125 |
list header fields will gain the benefit of those extensions. |
| 126 |
Additionally, the use of URLs provides access to multiple transport |
| 127 |
protocols (such as ftp and http) although it is expected that the |
| 128 |
"mailto" protocol [<a href="./rfc2368" title=""The mailto URL scheme"">RFC2368</a>] will be the focus of most use of the list |
| 129 |
header fields. Use of non-mailto protocols should be considered in |
| 130 |
light of those users who do not have access to the specified |
| 131 |
mechanism (those who only have email - with no web access). |
| 132 |
|
| 133 |
Command syntaxes requiring variable fields to be set by the client |
| 134 |
(such as including the user's email address within a command) are not |
| 135 |
supported by this implementation. However, systems using such |
| 136 |
syntaxes SHOULD still take advantage of the List-Help field to |
| 137 |
provide the user with detailed instructions as needed or - perhaps |
| 138 |
more usefully - provide access to some form of structured command |
| 139 |
interface such as an HTML-based form. |
| 140 |
|
| 141 |
The additional complications of supporting variable fields within the |
| 142 |
command syntax was determined to be too difficult to support by this |
| 143 |
protocol and would compromise the likelihood of implementation by |
| 144 |
software authors. |
| 145 |
|
| 146 |
To allow for future extension, client applications MUST follow the |
| 147 |
following guidelines for handling the contents of the header fields |
| 148 |
described in this document: |
| 149 |
|
| 150 |
1) Except where noted for specific fields, if the content of the |
| 151 |
field (following any leading whitespace, including comments) |
| 152 |
begins with any character other than the opening angle bracket |
| 153 |
'<', the field SHOULD be ignored. |
| 154 |
|
| 155 |
2) Any characters following an angle bracket enclosed URL SHOULD be |
| 156 |
ignored, unless a comma is the first non-whitespace/comment |
| 157 |
character after the closing angle bracket. |
| 158 |
|
| 159 |
|
| 160 |
|
| 161 |
|
| 162 |
|
| 163 |
|
| 164 |
<span class="grey">Neufeld & Baer Standards Track [Page 3]</span></pre> |
| 165 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span> |
| 166 |
<span class="grey"><a href="./rfc2369">RFC 2369</a> URLs as Meta-Syntax July 1998</span> |
| 167 |
|
| 168 |
|
| 169 |
3) If a sub-item (comma-separated item) within the field is not an |
| 170 |
angle-bracket enclosed URL, the remainder of the field (the |
| 171 |
current, and all subsequent, sub-items) SHOULD be ignored. |
| 172 |
|
| 173 |
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. The List Header Fields</span> |
| 174 |
|
| 175 |
This document presents header fields which will provide the |
| 176 |
command syntax description for the 'core' and key secondary |
| 177 |
functions of most email distribution lists. The fields implemented |
| 178 |
on a given list SHOULD be included on all messages distributed by |
| 179 |
the list (including command responses to individual users), and on |
| 180 |
other messages where the message clearly applies to one distinct |
| 181 |
list. There MUST be no more than one of each field present in any |
| 182 |
given message. |
| 183 |
|
| 184 |
These fields MUST only be generated by mailing lists, not end |
| 185 |
users. |
| 186 |
|
| 187 |
<span class="h3"><a class="selflink" id="section-3.1" href="#section-3.1">3.1</a>. List-Help</span> |
| 188 |
|
| 189 |
The List-Help field is the most important of the header fields |
| 190 |
described in this document. It would be acceptable for a list |
| 191 |
manager to include only this field, since by definition it SHOULD |
| 192 |
direct the user to complete instructions for all other commands. |
| 193 |
Typically, the URL specified would request the help file, perhaps |
| 194 |
incorporating an HTML form for list commands, for the list, and |
| 195 |
alternatively provide access to an instructive website. |
| 196 |
|
| 197 |
Examples: |
| 198 |
|
| 199 |
List-Help: <mailto:[email protected]?subject=help> (List Instructions) |
| 200 |
List-Help: <mailto:[email protected]?body=info> |
| 201 |
List-Help: <mailto:[email protected]> (Info about the list) |
| 202 |
List-Help: <<a href="http://www.host.com/list/">http://www.host.com/list/</a>>, <mailto:[email protected]> |
| 203 |
List-Help: <<a href="ftp://ftp.host.com/list.txt">ftp://ftp.host.com/list.txt</a>> (FTP), |
| 204 |
<mailto:[email protected]?subject=help> |
| 205 |
|
| 206 |
<span class="h3"><a class="selflink" id="section-3.2" href="#section-3.2">3.2</a>. List-Unsubscribe</span> |
| 207 |
|
| 208 |
The List-Unsubscribe field describes the command (preferably using |
| 209 |
mail) to directly unsubscribe the user (removing them from the list). |
| 210 |
|
| 211 |
Examples: |
| 212 |
|
| 213 |
List-Unsubscribe: <mailto:[email protected]?subject=unsubscribe> |
| 214 |
List-Unsubscribe: (Use this command to get off the list) |
| 215 |
<mailto:[email protected]?body=unsubscribe%20list> |
| 216 |
List-Unsubscribe: <mailto:[email protected]> |
| 217 |
|
| 218 |
|
| 219 |
|
| 220 |
<span class="grey">Neufeld & Baer Standards Track [Page 4]</span></pre> |
| 221 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span> |
| 222 |
<span class="grey"><a href="./rfc2369">RFC 2369</a> URLs as Meta-Syntax July 1998</span> |
| 223 |
|
| 224 |
|
| 225 |
List-Unsubscribe: <<a href="http://www.host.com/list">http://www.host.com/list</a>.cgi?cmd=unsub&lst=list>, |
| 226 |
<mailto:[email protected]?subject=unsubscribe> |
| 227 |
|
| 228 |
<span class="h3"><a class="selflink" id="section-3.3" href="#section-3.3">3.3</a>. List-Subscribe</span> |
| 229 |
|
| 230 |
The List-Subscribe field describes the command (preferably using |
| 231 |
mail) to directly subscribe the user (request addition to the list). |
| 232 |
|
| 233 |
Examples: |
| 234 |
|
| 235 |
List-Subscribe: <mailto:[email protected]?subject=subscribe> |
| 236 |
List-Subscribe: <mailto:[email protected]?subject=subscribe> |
| 237 |
List-Subscribe: (Use this command to join the list) |
| 238 |
<mailto:[email protected]?body=subscribe%20list> |
| 239 |
List-Subscribe: <mailto:[email protected]> |
| 240 |
List-Subscribe: <<a href="http://www.host.com/list">http://www.host.com/list</a>.cgi?cmd=sub&lst=list>, |
| 241 |
<mailto:[email protected]?body=subscribe%20list> |
| 242 |
|
| 243 |
<span class="h3"><a class="selflink" id="section-3.4" href="#section-3.4">3.4</a>. List-Post</span> |
| 244 |
|
| 245 |
The List-Post field describes the method for posting to the list. |
| 246 |
This is typically the address of the list, but MAY be a moderator, or |
| 247 |
potentially some other form of submission. For the special case of a |
| 248 |
list that does not allow posting (e.g., an announcements list), the |
| 249 |
List-Post field may contain the special value "NO". |
| 250 |
|
| 251 |
Examples: |
| 252 |
|
| 253 |
List-Post: <mailto:[email protected]> |
| 254 |
List-Post: <mailto:[email protected]> (Postings are Moderated) |
| 255 |
List-Post: <mailto:[email protected]?subject=list%20posting> |
| 256 |
List-Post: NO (posting not allowed on this list) |
| 257 |
|
| 258 |
<span class="h3"><a class="selflink" id="section-3.5" href="#section-3.5">3.5</a>. List-Owner</span> |
| 259 |
|
| 260 |
The List-Owner field identifies the path to contact a human |
| 261 |
administrator for the list. The URL MAY contain the address of a |
| 262 |
administrator for the list, the mail system administrator, or any |
| 263 |
other person who can handle user contact for the list. There is no |
| 264 |
need to specify List-Owner if it is the same person as the mail |
| 265 |
system administrator (postmaster). |
| 266 |
|
| 267 |
Examples: |
| 268 |
|
| 269 |
List-Owner: <mailto:[email protected]> (Contact Person for Help) |
| 270 |
List-Owner: <mailto:[email protected]> (Grant Neufeld) |
| 271 |
List-Owner: <mailto:[email protected]?Subject=list> |
| 272 |
|
| 273 |
|
| 274 |
|
| 275 |
|
| 276 |
<span class="grey">Neufeld & Baer Standards Track [Page 5]</span></pre> |
| 277 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span> |
| 278 |
<span class="grey"><a href="./rfc2369">RFC 2369</a> URLs as Meta-Syntax July 1998</span> |
| 279 |
|
| 280 |
|
| 281 |
<span class="h3"><a class="selflink" id="section-3.6" href="#section-3.6">3.6</a>. List-Archive</span> |
| 282 |
|
| 283 |
The List-Archive field describes how to access archives for the list. |
| 284 |
|
| 285 |
Examples: |
| 286 |
|
| 287 |
List-Archive: <mailto:[email protected]?subject=index%20list> |
| 288 |
List-Archive: <<a href="ftp://ftp.host.com/pub/list/archive/">ftp://ftp.host.com/pub/list/archive/</a>> |
| 289 |
List-Archive: <<a href="http://www.host.com/list/archive/">http://www.host.com/list/archive/</a>> (Web Archive) |
| 290 |
|
| 291 |
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Supporting Nested Lists</span> |
| 292 |
|
| 293 |
A list that is a sublist for another list in a nested mailing list |
| 294 |
hierarchy will need to modify some of the List- header fields, while |
| 295 |
leaving others as the parent list set them. |
| 296 |
|
| 297 |
Sublists SHOULD remove the parent list's List-Help, List-Subscribe, |
| 298 |
List-Unsubscribe and List-Owner fields, and SHOULD insert their own |
| 299 |
versions of those fields. |
| 300 |
|
| 301 |
If the sublist provides its own archive, it SHOULD replace the List- |
| 302 |
Archive with its own. Otherwise, it MUST leave the List-Archive field |
| 303 |
untouched. |
| 304 |
|
| 305 |
Dependant on how postings to the list are handled, the sublist MAY |
| 306 |
replace the List-Post field. The appropriateness of whether to |
| 307 |
replace List-Post is left to the determination of the individual list |
| 308 |
managers. If the intention is that postings should be distributed to |
| 309 |
all members of the primary list, List-Post should not be changed by a |
| 310 |
sublist in such a way that postings will be distributed only to |
| 311 |
members of the sublist. |
| 312 |
|
| 313 |
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Security Considerations</span> |
| 314 |
|
| 315 |
There are very few new security concerns generated with this |
| 316 |
proposal. Message headers are an existing standard, designed to |
| 317 |
easily accommodate new types. There may be concern with multiple |
| 318 |
fields being inserted or headers being forged, but these are problems |
| 319 |
inherent in Internet email, not specific to the protocol described in |
| 320 |
this document. Further, the implications are relatively harmless. |
| 321 |
|
| 322 |
Mail list processors should not allow any user-originated list header |
| 323 |
fields to pass through to their lists, lest they confuse the user and |
| 324 |
have the potential to create security problems. |
| 325 |
|
| 326 |
On the client side, there may be some concern with posts or commands |
| 327 |
being sent in error. It is required that the user have a chance to |
| 328 |
confirm any action before it is executed. In the case of mailto, it |
| 329 |
|
| 330 |
|
| 331 |
|
| 332 |
<span class="grey">Neufeld & Baer Standards Track [Page 6]</span></pre> |
| 333 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span> |
| 334 |
<span class="grey"><a href="./rfc2369">RFC 2369</a> URLs as Meta-Syntax July 1998</span> |
| 335 |
|
| 336 |
|
| 337 |
may be appropriate to create the correctly formatted message without |
| 338 |
sending it, allowing the user to see exactly what is happening and |
| 339 |
giving the user the opportunity to approve or discard the message |
| 340 |
before it is sent. |
| 341 |
|
| 342 |
All security considerations for the use of URLs [<a href="./rfc1738" title=""Uniform Resource Locators (URL)"">RFC1738</a>] apply |
| 343 |
equally to this protocol. Mail client applications should not support |
| 344 |
list header field URLs which could compromise the security of the |
| 345 |
user's system. This includes the "file://" URL type which could |
| 346 |
potentially be used to trigger the execution of a local application |
| 347 |
on some user systems. |
| 348 |
|
| 349 |
<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. Acknowledgements</span> |
| 350 |
|
| 351 |
The numerous participants of the List-Header [<a href="#ref-5" title=""List-Header"">5</a>], ListMom-Talk [<a href="#ref-6" title=""ListMom-Talk"">6</a>], |
| 352 |
List-Managers and MIDA-Mail mailing lists contributed much to the |
| 353 |
formation and structure of this document. |
| 354 |
|
| 355 |
Keith Moore <[email protected]> and Christopher Allen |
| 356 |
<[email protected]> provided guidance on the standards |
| 357 |
process. |
| 358 |
|
| 359 |
|
| 360 |
|
| 361 |
|
| 362 |
|
| 363 |
|
| 364 |
|
| 365 |
|
| 366 |
|
| 367 |
|
| 368 |
|
| 369 |
|
| 370 |
|
| 371 |
|
| 372 |
|
| 373 |
|
| 374 |
|
| 375 |
|
| 376 |
|
| 377 |
|
| 378 |
|
| 379 |
|
| 380 |
|
| 381 |
|
| 382 |
|
| 383 |
|
| 384 |
|
| 385 |
|
| 386 |
|
| 387 |
|
| 388 |
<span class="grey">Neufeld & Baer Standards Track [Page 7]</span></pre> |
| 389 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span> |
| 390 |
<span class="grey"><a href="./rfc2369">RFC 2369</a> URLs as Meta-Syntax July 1998</span> |
| 391 |
|
| 392 |
|
| 393 |
<span class="h2"><a class="selflink" id="appendix-A" href="#appendix-A">A</a>. Background Discussion</span> |
| 394 |
|
| 395 |
This proposal arose from discussions started on the ListMom-Talk |
| 396 |
Discussion List [<a href="#ref-6" title=""ListMom-Talk"">6</a>]. When the discussion reached a sufficient level, |
| 397 |
a separate list was formed for discussing this proposal, the List |
| 398 |
Headers Mail List [<a href="#ref-5" title=""List-Header"">5</a>] for deeper discussion. We have included |
| 399 |
summaries of key issues raised, in order to show some of the |
| 400 |
alternatives examined and reasons for our decisions. |
| 401 |
|
| 402 |
<span class="h3"><a class="selflink" id="appendix-A.1" href="#appendix-A.1">A.1</a>. Multiple header fields vs. a single header field</span> |
| 403 |
|
| 404 |
Use of a single header field for transporting command meta-syntax was |
| 405 |
rejected for a number of reasons. |
| 406 |
|
| 407 |
Such a field would require the creation of a new meta-syntax in order |
| 408 |
to describe the list commands (as opposed to the use of the widely |
| 409 |
deployed URL syntax which was chosen for this implementation). Every |
| 410 |
additional layer of complexity and newness reduces the likelihood of |
| 411 |
actual implementation because it will require additional work to |
| 412 |
support. Also, by using the existing URL syntax, we can profit from |
| 413 |
the end users' knowledge of that syntax and ability to use it even if |
| 414 |
their client applications do not support the list header fields. |
| 415 |
|
| 416 |
Restricting the transport of meta-syntax to the use of a single |
| 417 |
header field also introduces complications with header field size |
| 418 |
limitations. Most individual commands can easily be described in a |
| 419 |
single line, but describing a multitude of commands can take up many |
| 420 |
lines in the field and runs a greater risk of being modified by an |
| 421 |
existing server on route. |
| 422 |
|
| 423 |
The client implementation is also easier with multiple fields, since |
| 424 |
each command can be supported and implemented individually, |
| 425 |
completely independent of the others. Thus, some list managers or |
| 426 |
mail clients can choose to implement a subset of the fields based on |
| 427 |
the specific needs of their individual lists. |
| 428 |
|
| 429 |
Finally, the format described in this document is simple and well |
| 430 |
recognized, which reduces the chances of errors in implementation and |
| 431 |
parsing. |
| 432 |
|
| 433 |
<span class="h3"><a class="selflink" id="appendix-A.2" href="#appendix-A.2">A.2</a>. URLs vs. parameter lists</span> |
| 434 |
|
| 435 |
URLs are already an established syntax which is flexible, well- |
| 436 |
defined, and in wide spread use. As its definition matures and |
| 437 |
expands, the abilities of the list fields will grow as well, without |
| 438 |
requiring modification of this proposal. URLs are well prepared to |
| 439 |
handle future protocols and developments, and can easily describe the |
| 440 |
different existing access protocols such as mailto, http and ftp. |
| 441 |
|
| 442 |
|
| 443 |
|
| 444 |
<span class="grey">Neufeld & Baer Standards Track [Page 8]</span></pre> |
| 445 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span> |
| 446 |
<span class="grey"><a href="./rfc2369">RFC 2369</a> URLs as Meta-Syntax July 1998</span> |
| 447 |
|
| 448 |
|
| 449 |
Many clients already have functionality for recognizing, parsing, and |
| 450 |
evaluating URLs, either internally or by passing the request to a |
| 451 |
helper application. This makes implementation easier and more |
| 452 |
realistic. As an example, this existing support for URL parsing |
| 453 |
allowed us to add prototype list header functionality to existing |
| 454 |
mail clients (Eudora and Emailer for the Macintosh) without modifying |
| 455 |
their source code. |
| 456 |
|
| 457 |
<span class="h3"><a class="selflink" id="appendix-A.3" href="#appendix-A.3">A.3</a>. Why not just create a standard command language?</span> |
| 458 |
|
| 459 |
A standard command language, supported by all email list services, |
| 460 |
would go a long way to reducing the problems of list access that |
| 461 |
currently plague existing services. It would reduce the amount of |
| 462 |
learning required by end users and allow for a number of common |
| 463 |
support tools to be developed. |
| 464 |
|
| 465 |
However, such standardization does pose problems in the areas of |
| 466 |
multi-lingual support and the custom needs of individual mailing |
| 467 |
lists. The development of such a standard is also expected to be met |
| 468 |
with a slow adoption rate by software developers and list service |
| 469 |
providers. |
| 470 |
|
| 471 |
These points do not preclude the development of such a standard (in |
| 472 |
fact, it would suggest that we should start sooner rather than |
| 473 |
later), but we do need a solution that can be widely supported by the |
| 474 |
current list services. |
| 475 |
|
| 476 |
We can support most existing list manager command syntaxes without a |
| 477 |
standard command language. By using URLs, we allow alternate access |
| 478 |
methods a standard command language probably wouldn't enable, such as |
| 479 |
web based control. |
| 480 |
|
| 481 |
Finally, client support for a standard command language is not at all |
| 482 |
clear or necessarily simple to implement. The variety and large |
| 483 |
number of commands existing today would require complicated user |
| 484 |
interfaces which could be confusing and difficult to implement. By |
| 485 |
restricting this proposal to the core functions, the client |
| 486 |
|
| 487 |
implementation is much simpler, which significantly increases the |
| 488 |
likelihood of implementation (as evidenced by the support already |
| 489 |
announced by a number of client and server application authors). |
| 490 |
|
| 491 |
<span class="h3"><a class="selflink" id="appendix-A.4" href="#appendix-A.4">A.4</a>. Internationalization</span> |
| 492 |
|
| 493 |
Multilingual support is up to the URL standard. If URLs support it, |
| 494 |
then the List- header fields support it. This is another advantage of |
| 495 |
using URLs as the building blocks for the list header fields. |
| 496 |
|
| 497 |
|
| 498 |
|
| 499 |
|
| 500 |
<span class="grey">Neufeld & Baer Standards Track [Page 9]</span></pre> |
| 501 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span> |
| 502 |
<span class="grey"><a href="./rfc2369">RFC 2369</a> URLs as Meta-Syntax July 1998</span> |
| 503 |
|
| 504 |
|
| 505 |
<span class="h3"><a class="selflink" id="appendix-A.5" href="#appendix-A.5">A.5</a>. Variable Substitution</span> |
| 506 |
|
| 507 |
Variables would allow the List- header fields to accommodate nearly |
| 508 |
every existing list manager. However, it would immeasurably increase |
| 509 |
the complexity of the entire proposal, and possibly involve |
| 510 |
redefining the URL standard, or force us to use something more |
| 511 |
complicated (and hence more difficult to implement) than URLs to |
| 512 |
describe the command syntax. |
| 513 |
|
| 514 |
Parameters would either have to be mandatory (i.e. the user agent |
| 515 |
doesn't submit the message if it doesn't know what text to |
| 516 |
substitute) or you need a way to say "if you know this parameter, add |
| 517 |
its text here; otherwise, do this" where "this" is either: (a) |
| 518 |
substitute a constant string, or (b) fail. |
| 519 |
|
| 520 |
The reason you would want a facility like this is because some list |
| 521 |
server applications insist on having certain parameters like users' |
| 522 |
names, which the user agent might or might not know. e.g. listserv |
| 523 |
insists on having a first name and a last name if you supply either |
| 524 |
one. |
| 525 |
|
| 526 |
Which could lead to something like the UNIX shell syntax, where |
| 527 |
${foo-bar} means substitute the value of parameter "foo" if "foo" is |
| 528 |
defined, else substitute the string "bar". Perhaps $foo would mean |
| 529 |
"substitute the value of parameter foo if it is defined, else |
| 530 |
substitute the empty string" |
| 531 |
|
| 532 |
This all seems far too complicated for the gains involved, especially |
| 533 |
since the use of variables can often be avoided. |
| 534 |
|
| 535 |
The use of variables in the command syntaxes of list services appears |
| 536 |
to be lessening and does not, in any case, apply to all commands. |
| 537 |
While the unsubscribe and subscribe command header fields may not be |
| 538 |
usable by those systems which require the use of variables, the help |
| 539 |
field will still provide end users with a consistent point of access |
| 540 |
through which they can get support for their use of the list. |
| 541 |
|
| 542 |
<span class="h3"><a class="selflink" id="appendix-A.6" href="#appendix-A.6">A.6</a>. Why not use a specialized MIME part instead of header fields?</span> |
| 543 |
|
| 544 |
MIME parts were considered, but because most mail clients currently |
| 545 |
either don't support MIME or are not equipped to handle such |
| 546 |
specialized parts - such an implementation would result in problems |
| 547 |
for end users. It is also not as easy for many list servers to |
| 548 |
implement MIME as it is to implement new header fields. |
| 549 |
|
| 550 |
However, we are looking at the design of a MIME part to more fully |
| 551 |
describe list command syntax, as well as trying to find ways to get |
| 552 |
it supported by the applicable software. |
| 553 |
|
| 554 |
|
| 555 |
|
| 556 |
<span class="grey">Neufeld & Baer Standards Track [Page 10]</span></pre> |
| 557 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span> |
| 558 |
<span class="grey"><a href="./rfc2369">RFC 2369</a> URLs as Meta-Syntax July 1998</span> |
| 559 |
|
| 560 |
|
| 561 |
<span class="h3"><a class="selflink" id="appendix-A.7" href="#appendix-A.7">A.7</a>. Why include a Subscribe command?</span> |
| 562 |
|
| 563 |
Subscribe and Unsubscribe are the key commands needed by almost every |
| 564 |
list. Other commands, such as digest mode, are not as widely |
| 565 |
supported. |
| 566 |
|
| 567 |
Additionally, users who have unsubscribed (before going on vacation, |
| 568 |
or for whatever other reason) may want to resubscribe to a list. Or, |
| 569 |
a message may be forwarded/bounced from a subscriber to a non- |
| 570 |
subscriber. Or, the user may change addresses and want to subscribe |
| 571 |
from their new address. Having the List-Subscribe field available |
| 572 |
could certainly help in all these cases. |
| 573 |
|
| 574 |
<span class="h3"><a class="selflink" id="appendix-A.8" href="#appendix-A.8">A.8</a>. The Dangers of Header Bloat</span> |
| 575 |
|
| 576 |
At what point are there just too many header fields? It really |
| 577 |
varies on a list by list basis. On some lists, the majority of users |
| 578 |
will never be aware of a field unless the client software provides |
| 579 |
some alternative user interface to it (akin to the Reply-To field). |
| 580 |
On others, the users will often see the header fields of messages and |
| 581 |
would be able to recognize the function of the URLs contained within. |
| 582 |
|
| 583 |
The flexibility afforded by the protocol described in this document |
| 584 |
(in that the header fields may be individually implemented as deemed |
| 585 |
appropriate) provides list administrators with sufficient 'room to |
| 586 |
maneuver' to meet their individual needs. |
| 587 |
|
| 588 |
|
| 589 |
|
| 590 |
|
| 591 |
|
| 592 |
|
| 593 |
|
| 594 |
|
| 595 |
|
| 596 |
|
| 597 |
|
| 598 |
|
| 599 |
|
| 600 |
|
| 601 |
|
| 602 |
|
| 603 |
|
| 604 |
|
| 605 |
|
| 606 |
|
| 607 |
|
| 608 |
|
| 609 |
|
| 610 |
|
| 611 |
|
| 612 |
<span class="grey">Neufeld & Baer Standards Track [Page 11]</span></pre> |
| 613 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span> |
| 614 |
<span class="grey"><a href="./rfc2369">RFC 2369</a> URLs as Meta-Syntax July 1998</span> |
| 615 |
|
| 616 |
|
| 617 |
<span class="h2"><a class="selflink" id="appendix-B" href="#appendix-B">B</a>. Client Implementation</span> |
| 618 |
|
| 619 |
<span class="h3"><a class="selflink" id="appendix-B.1" href="#appendix-B.1">B.1</a>. Guidelines</span> |
| 620 |
|
| 621 |
For 'mailto' URL based commands, mail client applications may choose |
| 622 |
to provide specialized feedback (such as presenting a dialog or |
| 623 |
alert), instead of the actual command email message, asking for |
| 624 |
command confirmation from the user. The feedback should identify the |
| 625 |
message destination and command within a more descriptive |
| 626 |
explanation. For example: |
| 627 |
|
| 628 |
"Do you want to send the unsubscription command 'unsubscribe |
| 629 |
somelist' to '[email protected]'? Sending the command |
| 630 |
will result in your removal from the associated list." |
| 631 |
|
| 632 |
If the user has multiple email addresses supported by the mail |
| 633 |
client, the client application should prompt the user for which |
| 634 |
address to use when subscribing or performing some other action where |
| 635 |
the address to use cannot be specifically determined. When |
| 636 |
unsubscribing or such, the address that is subscribed should be used, |
| 637 |
unless that is not known by the application and cannot be determined |
| 638 |
from the message headers. |
| 639 |
|
| 640 |
<span class="h3"><a class="selflink" id="appendix-B.2" href="#appendix-B.2">B.2</a>. Implementation Options</span> |
| 641 |
|
| 642 |
The following implementation possibilities are suggested here to give |
| 643 |
some idea as to why these new header fields will be useful, and how |
| 644 |
they could be supported. |
| 645 |
|
| 646 |
In most cases, it may be helpful to disable the interface for the |
| 647 |
commands when not applicable to the currently selected message. |
| 648 |
|
| 649 |
<span class="h4"><a class="selflink" id="appendix-B.2.1" href="#appendix-B.2.1">B.2.1</a>. Key combinations and command lines</span> |
| 650 |
|
| 651 |
On text based systems which utilize command lines or key |
| 652 |
combinations, each field could be implemented as a separate command. |
| 653 |
Thus one combination would subscribe the user, another would |
| 654 |
unsubscribe, a third request help, etc. The commands would only be |
| 655 |
available on messages containing the list header fields. |
| 656 |
|
| 657 |
<span class="h4"><a class="selflink" id="appendix-B.2.2" href="#appendix-B.2.2">B.2.2</a>. Menu items</span> |
| 658 |
|
| 659 |
On graphical systems which have menus, these commands could take the |
| 660 |
form of a menu or sub-menu of items. For example, a "Lists" menu |
| 661 |
might appear when viewing messages containing the header fields, with |
| 662 |
items named "Subscribe", "Unsubscribe", "Get Help", "Post Message to |
| 663 |
|
| 664 |
|
| 665 |
|
| 666 |
|
| 667 |
|
| 668 |
<span class="grey">Neufeld & Baer Standards Track [Page 12]</span></pre> |
| 669 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span> |
| 670 |
<span class="grey"><a href="./rfc2369">RFC 2369</a> URLs as Meta-Syntax July 1998</span> |
| 671 |
|
| 672 |
|
| 673 |
List", "Contact List Owner" and "Access List Archive". This menu |
| 674 |
could be disabled when not applicable to the current message or |
| 675 |
disappear entirely. |
| 676 |
|
| 677 |
<span class="h4"><a class="selflink" id="appendix-B.2.3" href="#appendix-B.2.3">B.2.3</a>. Push Buttons and Pallettes</span> |
| 678 |
|
| 679 |
On graphical window systems, buttons could be placed in the window of |
| 680 |
the message, a toolbar, or in a floating pallette of their own. Each |
| 681 |
button could correspond to a command, with names "Subscribe", |
| 682 |
"Unsubscribe", "Get Help", "Post to List", "List Owner" and |
| 683 |
"Archive". These buttons or pallettes could be disabled when not |
| 684 |
applicable to the current message or disappear entirely. |
| 685 |
|
| 686 |
<span class="h4"><a class="selflink" id="appendix-B.2.4" href="#appendix-B.2.4">B.2.4</a> Feedback to the User</span> |
| 687 |
|
| 688 |
If using a dialog interface (or other feedback element) the client |
| 689 |
application MUST include an option for the user to review (and |
| 690 |
possibly modify) the message before it is sent. The application may |
| 691 |
also find it useful to provide a link to more detailed context- |
| 692 |
sensitive assistance about mail list access in general. |
| 693 |
|
| 694 |
References |
| 695 |
|
| 696 |
[<a id="ref-RFC822">RFC822</a>] Crocker, D., "Standard for the Format of ARPA |
| 697 |
Internet Text Messages", STD 11, <a href="./rfc822">RFC 822</a>, August 1982. |
| 698 |
|
| 699 |
[<a id="ref-RFC1738">RFC1738</a>] Berners-Lee, T., Masinter, L., and M. McCahill, |
| 700 |
"Uniform Resource Locators (URL)" <a href="./rfc1738">RFC 1738</a>, December 1994. |
| 701 |
|
| 702 |
[<a id="ref-RFC2142">RFC2142</a>] Crocker, D., "Mailbox Names for Common Services, Roles and |
| 703 |
Functions", <a href="./rfc2142">RFC 2142</a>, May 1997. |
| 704 |
|
| 705 |
[<a id="ref-RFC2368">RFC2368</a>] Hoffman, P., Masinter, L., and J. Zawinski, "The mailto URL |
| 706 |
scheme", <a href="./rfc2368">RFC 2368</a>, July 1998. |
| 707 |
|
| 708 |
[<a id="ref-5">5</a>] "List-Header" Mail list. [email protected] |
| 709 |
<URL:http://www.nisto.com/listspec/mail/> |
| 710 |
<URL:http://www.nisto.com/listspec/> |
| 711 |
|
| 712 |
[<a id="ref-6">6</a>] "ListMom-Talk" Mail list. [email protected] |
| 713 |
<URL:http://cgi.skyweyr.com/ListMom.Home> |
| 714 |
|
| 715 |
|
| 716 |
|
| 717 |
|
| 718 |
|
| 719 |
|
| 720 |
|
| 721 |
|
| 722 |
|
| 723 |
|
| 724 |
<span class="grey">Neufeld & Baer Standards Track [Page 13]</span></pre> |
| 725 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span> |
| 726 |
<span class="grey"><a href="./rfc2369">RFC 2369</a> URLs as Meta-Syntax July 1998</span> |
| 727 |
|
| 728 |
|
| 729 |
Editors' Addresses |
| 730 |
|
| 731 |
Joshua D. Baer |
| 732 |
Box 273 |
| 733 |
4902 Forbes Avenue |
| 734 |
Pittsburgh, PA 15213-3799 |
| 735 |
USA |
| 736 |
|
| 737 |
EMail: [email protected] |
| 738 |
|
| 739 |
|
| 740 |
Grant Neufeld |
| 741 |
Calgary, Alberta |
| 742 |
Canada |
| 743 |
|
| 744 |
EMail: [email protected] |
| 745 |
Web: <a href="http://www.nisto.com/">http://www.nisto.com/</a> |
| 746 |
|
| 747 |
|
| 748 |
|
| 749 |
|
| 750 |
|
| 751 |
|
| 752 |
|
| 753 |
|
| 754 |
|
| 755 |
|
| 756 |
|
| 757 |
|
| 758 |
|
| 759 |
|
| 760 |
|
| 761 |
|
| 762 |
|
| 763 |
|
| 764 |
|
| 765 |
|
| 766 |
|
| 767 |
|
| 768 |
|
| 769 |
|
| 770 |
|
| 771 |
|
| 772 |
|
| 773 |
|
| 774 |
|
| 775 |
|
| 776 |
|
| 777 |
|
| 778 |
|
| 779 |
|
| 780 |
<span class="grey">Neufeld & Baer Standards Track [Page 14]</span></pre> |
| 781 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span> |
| 782 |
<span class="grey"><a href="./rfc2369">RFC 2369</a> URLs as Meta-Syntax July 1998</span> |
| 783 |
|
| 784 |
|
| 785 |
Full Copyright Statement |
| 786 |
|
| 787 |
Copyright (C) The Internet Society (1998). All Rights Reserved. |
| 788 |
|
| 789 |
This document and translations of it may be copied and furnished to |
| 790 |
others, and derivative works that comment on or otherwise explain it |
| 791 |
or assist in its implementation may be prepared, copied, published |
| 792 |
and distributed, in whole or in part, without restriction of any |
| 793 |
kind, provided that the above copyright notice and this paragraph are |
| 794 |
included on all such copies and derivative works. However, this |
| 795 |
document itself may not be modified in any way, such as by removing |
| 796 |
the copyright notice or references to the Internet Society or other |
| 797 |
Internet organizations, except as needed for the purpose of |
| 798 |
developing Internet standards in which case the procedures for |
| 799 |
copyrights defined in the Internet Standards process must be |
| 800 |
followed, or as required to translate it into languages other than |
| 801 |
English. |
| 802 |
|
| 803 |
The limited permissions granted above are perpetual and will not be |
| 804 |
revoked by the Internet Society or its successors or assigns. |
| 805 |
|
| 806 |
This document and the information contained herein is provided on an |
| 807 |
"AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING |
| 808 |
TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING |
| 809 |
BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION |
| 810 |
HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF |
| 811 |
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. |
| 812 |
|
| 813 |
|
| 814 |
|
| 815 |
|
| 816 |
|
| 817 |
|
| 818 |
|
| 819 |
|
| 820 |
|
| 821 |
|
| 822 |
|
| 823 |
|
| 824 |
|
| 825 |
|
| 826 |
|
| 827 |
|
| 828 |
|
| 829 |
|
| 830 |
|
| 831 |
|
| 832 |
|
| 833 |
|
| 834 |
|
| 835 |
|
| 836 |
Neufeld & Baer Standards Track [Page 15] |
| 837 |
</pre> |