david: doc/kolab-formats overview.sgml,1.13,1.14

cvs at intevation.de cvs at intevation.de
Wed Jul 21 00:42:42 CEST 2004


Author: david

Update of /kolabrepository/doc/kolab-formats
In directory doto:/tmp/cvs-serv2348

Modified Files:
	overview.sgml 
Log Message:
Added section about mail structure, including mail headers (Subject and X-Kolab-Type)


Index: overview.sgml
===================================================================
RCS file: /kolabrepository/doc/kolab-formats/overview.sgml,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -d -r1.13 -r1.14
--- overview.sgml	15 Jul 2004 07:56:25 -0000	1.13
+++ overview.sgml	20 Jul 2004 22:42:40 -0000	1.14
@@ -6,10 +6,34 @@
 <para>The Kolab storage format is designed to provide a unified
 storage format for several Kolab client implementations.</para>
 
-<para>The storage format specifies an XML format to be saved in IMAP
-folders.</para>
+<sect1><title>Mail structure</title>
+
+<para>Each Kolab object (note, event, contact etc.) is stored in its own email,
+in the appropriate folder for this type of object.</para>
+
+<para>The email uses a multipart/mixed structure, with the following parts:</para>
+
+<itemizedlist>
+<listitem><para>A text body part with a fixed text telling about Kolab. Content-Type: text/plain</para></listitem>
+<listitem><para>The XML describing the object. Content-Type: application/x-vnd.kolab.*</para></listitem>
+<listitem><para>Other attachments, like a contact's picture or the attachments associated with e.g. a note or event.</para></listitem>
+</itemizedlist>
+
+<para>The following requirements apply to the mail headers:</para>
+<itemizedlist>
+<listitem><para>The subject of the mail must be set to the UID of the object. (*)</para></listitem>
+<listitem><para>An additional header named X-Kolab-Type, must be set to the mimetype of the object, application/x-vnd.kolab.*</para></listitem>
+</itemizedlist>
+
+<para>(*) This can be used by some clients for searching but it is not recommended
+to implement clients that way; searching on the IMAP ID is much faster when it's possible.</para>
+
+</sect1>
 
 <sect1><title>XML format description</title>
+
+<para>The storage format specifies the format of the XML to be saved as an
+attachment in the mail.</para>
 
 <para>The fields in the XML file are written like this:</para>
 





More information about the commits mailing list