proposed clarification for folders.sgml

[Martin Konold]

Am Dienstag 26 Juli 2005 14:31 schrieb David Faure:

Hi David,

> > user. There are exactly
> > +one default resource folder of each type which means
> > +one default calendar, one default contact folder, one default folder for
> > notes,
> > +a single default folder for tasks and last but not least one default
> > folder for a journal.</para>
>
> An unnumbered list would be easier to read than " A,B,C,D and least but not
> least E" (a phrase that doesn't really make sense here).

I agree though I don't know how to do this with docbook properly.

> s/All folder/All folders/

Done!

> > -<para>For other types of folders supported by the clients, these
> > +<para>There MUST NOT be two folders of a single type haveing the default
>
> s/haveing/having/

fixed.

> > subtype. E.g. it
> > +is forbidden to have two folders of the type calendar with the subtype
> > default within one Kolab
> > +mailbox.</para>
>
> You mean within one Kolab account, no?

Yes. Technically a Kolab account consists of a IMAP mailbox. I changed the 
wording to Kolab account now.

> > +<para>For other client specific non standardized types of folders
>
> s/client specific/client-specific/

Done!

> should be removed, if it's client-specific it's obviously supported by the
> clients ;)

Yes.

> > Clients can rely upon
> > +unaltered annotations as long as the UIDVALIDITY of the folder is not
> > changed.
>
> ?!?!?!? If you can't change the annotation, you can't change it. Ever.
> Unrelated to UIDVALIDITY.

yes!

I am attaching the new poposal. Please note my comment about folder names.

===============================



RCS file: /kolabrepository/doc/kolab-formats/folders.sgml,v
retrieving revision 1.7
diff -u -r1.7 folders.sgml
--- folders.sgml        7 Oct 2004 16:07:30 -0000       1.7
+++ folders.sgml        26 Jul 2005 13:47:43 -0000
@@ -11,11 +11,22 @@
 (i.e. folder name encoding is by RFC 3501).</para>

 <para>The INBOX is the default inbox of the user. The user can not
-change this default. The IMAP resource folders (one for events,
-one for contacts etc. ) are subfolders of the INBOX, and this location can
-not be set by the user.</para>
+change this default. The account specific personal IMAP resource folders
+are subfolders of the INBOX, and this location cannot be set by the user.
+There is exactly one default resource folder for each type which means
+
+<para>one default calendar folder</para>
+<para>one default contact folder</para>
+<para>one default notes folder</para>
+<para>one default task folder</para>
+<para>one default journal folder</para>
+
+<para>The actual names of the folder as stored on the IMAP folder don't 
matter. E.g. it does
+not matter if the default calendar is called Calendar or Kalendar as long as 
exactly one default
+calendar folder does exist as a direct subfolder of the INBOX folder.
+</paea>

-<para>We will annotate all folders with an entry /vendor/kolab/folder-type
+<para>All folders MUST be annotated with an entry /vendor/kolab/folder-type
 containing the attribute value.shared set to: <!
[CDATA[ <type>[.<subtype>] ]]>
 </para>

@@ -26,20 +37,24 @@
 or junkemail (this one holds spam mails). For the other <type>s, it
 can only be default, or not set.</para>

-<para>For other types of folders supported by the clients, these
-should be prefixed with "k-" for KMail, "h-" for Horde and "o-" for Outlook,
-and look like for example "kolab.o-voicemail".</para>
+<para>There MUST NOT be two folders of a single type having the default 
subtype. E.g. it
+is forbidden to have two folders of the type calendar with the subtype 
default within one Kolab
+account.</para>
+
+<para>For other client-specific non standardized types of folders, these
+MUST be prefixed with "k-" for KMail, "h-" for Horde, "o-" for Outlook with 
the
+Toltec Connector and "ok-" for Outlook with the KONSEC Konnektor. E.g. 
"kolab.o-voicemail".</para>

-<para>We will use "application/x-vnd.kolab.<type>" as the
-mimetype for the emails used for storage.</para>
+<para>The mimetype of the messages stored on the Kolab server is 
"application/x-vnd.kolab.<type>".</para>

-<para>The annotation must be set on creation, and can not be
-changed. For folders created with other IMAP clients, annotations must
+<para>All annotation MUST be set during the initial creation of a folder and 
cannot be altered afterwards.
+Clients are allowed to rely upon this requirement.
+</para>
+<para>For folders created with non Kolab IMAP clients, annotations must
 be preserved. If a folder has no annotation, Outlook and
-the Toltec connector will ignore it completely. This is not an option
-for Kontact and Horde, so we will by default consider them to hold
-mail.</para>
-
+the Toltec connector will ignore it completely.
+Kontact, Horde and other Kolab clients MUST assume that folders without
+a type set are email folders.</para>

==================================

Yours,
-- martin

-- 
http://www.erfrakon.com/
Erlewein, Frank, Konold & Partner - Beratende Ingenieure und Physiker