From b6541ae49c3c63997a2031bbc2e9b99caf16c295 Mon Sep 17 00:00:00 2001 From: Per Cederqvist Date: Wed, 9 May 2001 06:55:10 +0000 Subject: [PATCH] (Predefined Aux-Item Types): State that client-specific aux-items can be redefined as predefined. (Client-Specific Aux-Item Types): Likewise. (komimportmail Aux-Item Types): Node removed. Contents moved to "Aux-Item Types". (Aux-Item Types): Added mx-mime-belongs-to [10100], mx-mime-part-in [10101], mx-mime-misc [10102], mx-envelope-sender [10103] and mx-mime-file-name [10104]. --- doc/Protocol-A.texi | 112 ++++++++++++++++++++------------------------ 1 file changed, 50 insertions(+), 62 deletions(-) diff --git a/doc/Protocol-A.texi b/doc/Protocol-A.texi index 754e8073..c54958a4 100644 --- a/doc/Protocol-A.texi +++ b/doc/Protocol-A.texi @@ -1,13 +1,8 @@ \input texinfo @c -*-texinfo-*- @c -@c FIXME: Things that require a resolution in the WG: -@c FIXME: -@c FIXME: "x-kom/basic" should be "text/x-kom-basic" (6435471) -@c FIXME: get rid of "komimportmail Aux-Item Types" (6435520) @c FIXME: Explain how the garb works with nice and keep-commented -@c FIXME: @c -@c $Id: Protocol-A.texi,v 1.146 2001/05/08 21:47:35 ceder Exp $ +@c $Id: Protocol-A.texi,v 1.147 2001/05/09 06:55:10 ceder Exp $ @c %**start of header @setfilename protocol-a.info @settitle LysKOM Protocol A @@ -746,6 +741,14 @@ predefined. If a client attempts to create an item with a tag in this range, but the server has no idea what that tag means, the server will return an error (illegal-aux-item.) +Some items with tags in the range 10000-19999 are also predefined. +They are items that initially were reserved for private use for a +specific client, but where it was later discovered that the tag was +generally useful. They should ideally have been assigned a number in +the 1-9999 range from the beginning, but if they already have a +widespread use they can be redefined to be predefined. Such +redefinition will always be made in cooperation with the client +writer. @node Client-Specific Aux-Item Types @subsection Client-Specific Aux-Item Types @@ -758,7 +761,9 @@ server support than this, your item should be on the predefined list. All tags in the range 10000-19999 are reserved for clients. Blocks of 100 numbers at a time can be assigned to specific clients. A client should never create items with tags in a range assigned to another -client or in an unassigned range. Assigned ranges will never change. +client or in an unassigned range. Assigned ranges will never change, +except that specific aux-items may be redefined as predefined, as +explained in @ref{Predefined Aux-Item Types}. Currently, the following ranges are assigned to clients: @itemize @bullet @@ -769,59 +774,6 @@ Currently, the following ranges are assigned to clients: If you want a range of numbers, send e-mail to the LysKOM development group. -@menu -* komimportmail Aux-Item Types:: -@end menu - -@node komimportmail Aux-Item Types -@subsubsection komimportmail Aux-Item Types - -During the design and implementation of the @command{komimportmail} mail -importer, some new aux-items were defined to solve specific problems. -These aux-items are documented here: - -@table @samp - -@item mx-mime-belongs-to [10100] (text) - -Data is a decimal text number that this text is an attachment to. Most -likely, the current text is also a comment (or perhaps a footnote) to -the text mentioned in the aux-item. A client can use this aux-item to -alter the display format of the text (stating that this is an -attachment, not a normal comment). - - -@item mx-mime-part-in [10101] (text) - -Data is a decimal text number of a text that is an attachment to the -current one. In other words: this is the converse of mx-mime-belongs-to. -A client can use this aux-item to know which comments to mark as -attachments; the remaining comments are assumed to be normal. - -@item mx-mime-misc [10102] (text) - -Data is a string that contains all of the MIME headers for the current -text. It is set by the importer. The fields are concatenated with -"\n". - -Clients are encouraged to provide a command to display this. - -@item mx-envelope-sender [10103] (text) - -Data is the envelope sender of an imported text. The mail server is -supposed to pass this information to the importer, for inclusion here. - -@item mx-mime-file-name [10104] (text) - -Data is the file name of an attachment. Most likely, the importer gets -this information from a @code{name} parameter on a @code{Content-Type} -MIME header line. - -Clients are encouraged to use this file name as the default file name -when the user chooses to save the text. - -@end table - @node Experimental Aux-Item Types @subsection Experimental Aux-Item Types @@ -8203,8 +8155,7 @@ specific call. @chapter Aux-Item Types Some of the aux-items below (mostly the ones that begin with "mx-") are -used by mail importers. For information about supplementary aux-items -introduced by @command{komimportmail}, see @ref{komimportmail Aux-Item Types}. +used by mail importers. @table @samp @item content-type [1] (text) @@ -8575,6 +8526,43 @@ client (or to the author of a new text). This may change in the future, if experience shows that it is desirable to have the server enforce the content type. +@item mx-mime-belongs-to [10100] (text) + +Data is a decimal text number that this text is an attachment to. Most +likely, the current text is also a comment (or perhaps a footnote) to +the text mentioned in the aux-item. A client can use this aux-item to +alter the display format of the text (stating that this is an +attachment, not a normal comment). + +@item mx-mime-part-in [10101] (text) + +Data is a decimal text number of a text that is an attachment to the +current one. In other words: this is the converse of mx-mime-belongs-to. +A client can use this aux-item to know which comments to mark as +attachments; the remaining comments are assumed to be normal. + +@item mx-mime-misc [10102] (text) + +Data is a string that contains all of the MIME headers for the current +text. It is set by the importer. The fields are concatenated with +"\n". + +Clients are encouraged to provide a command to display this. + +@item mx-envelope-sender [10103] (text) + +Data is the envelope sender of an imported text. The mail server is +supposed to pass this information to the importer, for inclusion here. + +@item mx-mime-file-name [10104] (text) + +Data is the file name of an attachment. Most likely, the importer gets +this information from a @code{name} parameter on a @code{Content-Type} +MIME header line. + +Clients are encouraged to use this file name as the default file name +when the user chooses to save the text. + @end table @node Name Expansion -- GitLab