Martin Konold: Added kolabFolderType and improved some documentation. kolabFolderType is currently mainly used for shared folders

1 files changed, 47 insertions, 16 deletions

diff --git a/kolab2.schema b/kolab2.schema
index cde438e..d87a876 100644
--- a/kolab2.schema
+++ b/kolab2.schema
@@ -1,6 +1,6 @@
 # $Id$
 # (c) 2003, 2004 Tassilo Erlewein <tassilo.erlewein@erfrakon.de>
-# (c) 2003-2005  Martin Konold <martin.konold@erfrakon.de>
+# (c) 2003-2006  Martin Konold <martin.konold@erfrakon.de>
 # (c) 2003 Achim Frank <achim.frank@erfrakon.de>
 #
 # Redistribution and use in source and binary forms, with or without 
@@ -32,10 +32,11 @@
 # as provided by 3rd parties like OpenLDAP.
 #
 # slapd.conf then looks like
-#  include /kolab/etc/openldap/schema/core.schema
-#  include /kolab/etc/openldap/schema/cosine.schema
-#  include /kolab/local/etc/openldap/schema/inetorgperson.schema
-#  include /kolab/local/etc/openldap/schema/kolab2.schema
+# include /kolab/etc/openldap/schema/core.schema
+# include /kolab/etc/openldap/schema/cosine.schema
+# include /kolab/etc/openldap/schema/inetorgperson.schema
+# include /kolab/etc/openldap/schema/rfc2739.schema
+# include /kolab/etc/openldap/schema/kolab2.schema
 
 #
 ####################
@@ -87,7 +88,7 @@ attributetype ( 1.3.6.1.4.1.19414.2.1.5
   SUBSTR caseIgnoreIA5SubstringsMatch
   SYNTAX 1.3.6.1.4.1.1466.115.121.1.26{256} )
 
-# fqdn of all hosts in a multi-location setup
+# fqdn of all hosts in a multi-location or cluster setup
 attributetype ( 1.3.6.1.4.1.19414.2.1.6
   NAME 'kolabHost'
   DESC 'Multivalued -- list of hostnames in a Kolab setup'
@@ -95,7 +96,7 @@ attributetype ( 1.3.6.1.4.1.19414.2.1.6
   SUBSTR caseIgnoreIA5SubstringsMatch
   SYNTAX 1.3.6.1.4.1.1466.115.121.1.26{256} )
 
-# fqdn of the server containg the actual user data
+# fqdn of the server containg the actual user mailbox
 attributetype ( 1.3.6.1.4.1.19419.1.1.1.1
   NAME 'kolabHomeServer'
   DESC 'server which keeps the users mailbox'
@@ -135,7 +136,7 @@ attributetype ( 1.3.6.1.4.1.19419.1.1.1.3
 # user@domain.tld: ACT_ALWAYS_ACCEPT
 attributetype ( 1.3.6.1.4.1.19419.1.1.1.4
   NAME ( 'kolabInvitationPolicy' 'kolabResourceAction' )
-  DESC 'Used by user, group and resource accounts to determine how to respond to invitations'
+  DESC 'defines how to respond to invitations'
   EQUALITY caseIgnoreIA5Match
   SUBSTR caseIgnoreIA5SubstringsMatch
   SYNTAX 1.3.6.1.4.1.1466.115.121.1.26{256} )
@@ -293,6 +294,29 @@ attributetype ( 1.3.6.1.4.1.19419.1.1.1.17
   SUBSTR caseIgnoreSubstringsMatch
   SYNTAX 1.3.6.1.4.1.1466.115.121.1.15{1024} )
 
+# kolabFolderType describes the kind of Kolab folder
+# as defined in the kolab format specification. 
+# We will annotate all folders with an entry 
+# /vendor/kolab/folder-type containing the attribute 
+# value.shared set to: <type>[.<subtype>]. 
+# The <type> can be: mail, event, journal, task, note, 
+# or contact. The <subtype> for a mail folder can be 
+# inbox, drafts, sentitems, or junkemail (this one holds 
+# spam mails). For the other <type>s, it can only be 
+# default, or not set.  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". Other third-party
+# clients shall use the "x-" prefix.
+# We then use the ANNOTATEMORE IMAP extension to 
+# associate the folder type with a folder.
+attributetype ( 1.3.6.1.4.1.19414.2.1.7
+  NAME 'kolabFolderType'
+  DESC 'type of a kolab folder'
+  EQUALITY caseIgnoreIA5Match
+  SUBSTR caseIgnoreIA5SubstringsMatch
+  SYNTAX 1.3.6.1.4.1.1466.115.121.1.26{256} )
+
 ######################
 # postfix attributes #
 ######################
@@ -529,7 +553,8 @@ objectclass ( 1.3.6.1.4.1.19414.2.2.1
         userPassword ) )
 
 # shared folders are typically visible to everyone subscribed to 
-# the server without the need for an extra login
+# the server without the need for an extra login. Subfolders are
+# defined using the hiarchy seperator '/' e.g. "sf/sub1".
 objectclass ( 1.3.6.1.4.1.19414.2.2.9 
   NAME 'kolabSharedFolder'
   DESC 'Kolab public shared folder'
@@ -539,11 +564,14 @@ objectclass ( 1.3.6.1.4.1.19414.2.2.9
         alias $
         cyrus-userquota $
         kolabHomeServer $
+        kolabFolderType $
         kolabDeleteflag ) )
 
-# used as a plain node for the LDAP tree. In contrast to unix filesystem directories
-# LDAP nodes can and often do also have contents/attributes. We use kolabNamedObject
-# in order to put more structure in the directory tree.
+# kolabNamedObject is used as a plain node for the LDAP tree. 
+# In contrast to unix filesystem directories LDAP nodes can 
+# and often do also have contents/attributes. We use the 
+# kolabNamedObject in order to put some structure in the 
+# LDAP directory tree.
 objectclass ( 1.3.6.1.4.1.5322.13.1.1 
   NAME 'kolabNamedObject'
   SUP top STRUCTURAL
@@ -602,10 +630,13 @@ objectclass ( 1.3.6.1.4.1.19414.3.2.4
         kolabDeleteflag $
         alias ) )
 
-# kolab groupOfNames with extra kolabDeleteflag and the required attribute mail.    
-# The mail attribute for kolab objects of the type kolabGroupOfNames is not arbitrary but    
-# MUST be a single attribute of the form cn@kolabdomain (e.g. employees@mydomain.com). The    
-# mail attribute MUST be worldwide unique.    
+# kolab groupOfNames with extra kolabDeleteflag and the required 
+# attribute mail.    
+# The mail attribute for kolab objects of the type kolabGroupOfNames 
+# is not arbitrary but MUST be a single attribute of the form 
+# of an valid SMTP address with the CN as the local part.
+# E.g cn@kolabdomain (e.g. employees@mydomain.com). The    
+# mail attribute MUST be globally unique.    
 objectclass ( 1.3.6.1.4.1.19414.3.2.5    
   NAME 'kolabGroupOfNames'    
   DESC 'Kolab group of names (DNs) derived from RFC2256'