cyrus capability and permanent flags
[squirrelmail.git] / doc / presets.txt
index 730bb631aba54aa2424e409a9d42a91227fdfba5..997126553b4db56a64409ff07a15b2b3b529b335 100644 (file)
@@ -1,25 +1,27 @@
 $Date$
 
-This file lists squirrelmail options set by D option in conf.pl
+This file lists SquirrelMail options set by D option in conf.pl
 
 It can be used if user can't run conf.pl and changes options manually.
 Settings can be different if IMAP server uses shared folders.
 
 Possible server values are:
+ bincimap    = Binc IMAP server
+ courier     = Courier IMAP server
  cyrus       = Cyrus IMAP server
uw          = University of Washington's IMAP server
dovecot     = Dovecot Secure IMAP server
  exchange    = Microsoft Exchange IMAP server
- courier     = Courier IMAP server
- macosx      = Mac OS X Mailserver
  hmailserver = hMailServer
+ macosx      = Mac OS X Mailserver
  mercury32   = Mercury/32
+ uw          = University of Washington's IMAP server
 
 -----------------
 default settings:
 -----------------
 
               imap_server_type = other
-         default_folder_prefix =
+         default_folder_prefix = <none> (is set to empty string)
                   trash_folder = INBOX.Trash
                    sent_folder = INBOX.Sent
                   draft_folder = INBOX.Drafts
@@ -33,8 +35,19 @@ show_contain_subfolders_option = false
 -----------------
 'cyrus' settings:
 -----------------
+Server supports server side sorting since 2.0.4 version. euc-jp, euc-kr, 
+tis-620, cp1251, cp1255 character sets are not supported by sorting functions 
+(v.2.2.12).
+
+CAPABILITY IMAP4 IMAP4rev1 ACL QUOTA LITERAL+ MAILBOX-REFERRALS NAMESPACE
+ UIDPLUS ID NO_ATOMIC_RENAME UNSELECT CHILDREN MULTIAPPEND BINARY SORT
+ THREAD=ORDEREDSUBJECT THREAD=REFERENCES ANNOTATEMORE IDLE LISTEXT
+ LIST-SUBSCRIBED X-NETSCAPE
+
+PERMANENTFLAGS (\Answered \Flagged \Draft \Deleted \Seen $MDNSent \*)
+
               imap_server_type = cyrus
-         default_folder_prefix = <none> (is not set)
+         default_folder_prefix = <none> (is set to empty string)
                   trash_folder = INBOX.Trash
                    sent_folder = INBOX.Sent
                   draft_folder = INBOX.Drafts
@@ -48,6 +61,13 @@ show_contain_subfolders_option = false
 --------------
 'uw' settings:
 --------------
+Server supports server side sorting. Plain text logins are disabled by default.
+
+CAPABILITY IMAP4REV1 IDLE NAMESPACE MAILBOX-REFERRALS BINARY UNSELECT SCAN SORT
+ THREAD=REFERENCES THREAD=ORDEREDSUBJECT MULTIAPPEND LOGIN-REFERRALS STARTTLS
+ AUTH=LOGIN
+PERMANENTFLAGS (Seen \* \Answered \Flagged \Deleted \Draft \Seen)
+
               imap_server_type = uw
          default_folder_prefix = mail/
                   trash_folder = Trash
@@ -63,8 +83,9 @@ show_contain_subfolders_option = true
 --------------------
 'exchange' settings:
 --------------------
+Server does not support server side sorting.
               imap_server_type = exchange
-         default_folder_prefix = <none>  (is not set)
+         default_folder_prefix = <none> (is set to empty string)
                   trash_folder = INBOX/Deleted Items
                    sent_folder = INBOX/Sent Items
                   draft_folder = Drafts
@@ -78,6 +99,23 @@ show_contain_subfolders_option = false
 -------------------
 'courier' settings:
 -------------------
+Fast, scalable, enterprise IMAP server that uses Maildirs
+
+CAPABILITY IMAP4rev1 UIDPLUS CHILDREN NAMESPACE THREAD=ORDEREDSUBJECT
+ THREAD=REFERENCES SORT QUOTA IDLE ACL ACL2=UNION
+
+PERMANENTFLAGS (\* \Draft \Answered \Flagged \Deleted \Seen)
+
+Recent (3.0.0+) versions support most of character sets used by SquirrelMail, 
+if courier-imap is compiled with --enable-unicode option. Only koi8-u 
+is not supported. Server can be compiled with custom number of supported
+character sets. Sorting can be disabled in imapd configuration. Capability
+string can be set in configuration. Supports CRAM-MD5, CRAM-SHA1 and 
+CRAM-SHA256, if userdb or other backend stores passwords in plain text. Does 
+not handle traditional mailbox files.
+
+Site URL: http://www.courier-mta.org/
+
               imap_server_type = courier
          default_folder_prefix = INBOX.
                   trash_folder = Trash
@@ -105,23 +143,138 @@ show_contain_subfolders_option = false
                  delete_folder = true
       force_username_lowercase = false
 
-------------------
+-----------------------
 'hmailserver' settings:
-------------------
-              imap_server_type = hmailserver   (used in imap_search.php)
+-----------------------
+Preset is used with hMailServer IMAP server. Available since SquirrelMail 1.5.1 
+and 1.4.4. Open source email server for WinNT and later.
 
--------------------
-'mercury' settings:
--------------------
-              imap_server_type = mercury32
-         default_folder_prefix = INBOX/
+Tested 4.1.1 (Build 140).
+CAPABILITY IMAP4 IMAP4rev1 QUOTA 
+PERMANENTFLAGS (\Deleted \Seen \Draft \Answered \Flagged)
+
+Site URL: http://www.hmailserver.com/
+
+              imap_server_type = hmailserver   (used in imap_search.php)
+         default_folder_prefix = <none> (is set to empty string)
                   trash_folder = INBOX.Trash
                    sent_folder = INBOX.Sent
                   draft_folder = INBOX.Drafts
             show_prefix_option = false
           default_sub_of_inbox = true
+show_contain_subfolders_option = false
+            optional_delimiter = detect
+                 delete_folder = false
+      force_username_lowercase = false
+
+---------------------
+'mercury32' settings:
+---------------------
+Preset is used for Mercury Mail Transport System. Available since 1.5.0 and 1.4.6.
+Free email server for Win32 and Netware.
+Tested Win32 v.4.01b
+CAPABILITY IMAP4rev1 X-MERCURY
+PERMANENTFLAGS (\Deleted \Draft \Seen \Answered)
+
+Comments:
+* Server side sorting and threading are not supported.
+* Message flags are not supported.
+* IMAP folders can store messages _or_ other folders.
+* Supports STARTTLS, if configured.
+* May have issues with 8bit IMAP folder names.
+
+$imap_server_type variable is used to handle imap folder subscription
+differences.
+
+Site URL: http://www.pmail.com
+
+              imap_server_type = mercury32
+         default_folder_prefix = <none> (is set to empty string)
+                  trash_folder = Trash
+                   sent_folder = Sent
+                  draft_folder = Drafts
+            show_prefix_option = false
+          default_sub_of_inbox = true
 show_contain_subfolders_option = true
             optional_delimiter = detect
                  delete_folder = true
       force_username_lowercase = true
 
+-------------------
+'dovecot' settings:
+-------------------
+Preset used for Dovecot Secure IMAP server. Available since 1.5.1 and 1.4.6.
+
+There is no code specific to Dovecot IMAP server. Preset provides only a quick
+way to set correct folder settings.
+
+Tested v.0.99.14
+
+CAPABILITY IMAP4rev1 SORT THREAD=REFERENCES MULTIAPPEND UNSELECT LITERAL+ IDLE 
+  CHILDREN LISTEXT LIST-SUBSCRIBED NAMESPACE
+
+PERMANENTFLAGS (\Answered \Flagged \Deleted \Seen \Draft \*)
+
+IMAP server supports server side sorting and threading.
+
+Site URL: http://www.dovecot.org
+
+              imap_server_type = dovecot
+         default_folder_prefix = <none> (is set to empty string)
+                  trash_folder = Trash
+                   sent_folder = Sent
+                  draft_folder = Drafts
+            show_prefix_option = false
+          default_sub_of_inbox = false
+show_contain_subfolders_option = false
+            optional_delimiter = detect
+                 delete_folder = false
+      force_username_lowercase = true
+
+
+--------------------
+'bincimap' settings:
+--------------------
+Preset is used with Binc IMAP server. Available since 1.5.1 and 1.4.6.
+Tested v.1.2.13 and 1.3.4
+
+CAPABILITY IMAP4rev1 STARTTLS AUTH=LOGIN AUTH=PLAIN (1.2.13)
+CAPABILITY IMAP4rev1 STARTTLS AUTH=LOGIN AUTH=PLAIN IDLE LITERAL+ NAMESPACE CHILDREN (1.3.4)
+
+PERMANENTFLAGS (\Answered \Flagged \Deleted \Seen \Draft) - 1.2.13
+PERMANENTFLAGS (\Answered \Flagged \Deleted \Seen \Draft \*) - 1.3.4
+
+IMAP server does not support server side sorting and threading. Plain text 
+logins are disabled by default. Due to available storage backend configuration 
+options it is impossible to create single preset, which covers all setups.
+
+Site URL: http://www.bincimap.org
+
+* Default (1.2.13) configuration with Maildir++ depot and / delimiter
+              imap_server_type = bincimap (is used to handle INBOX in folder management)
+         default_folder_prefix = INBOX/
+                  trash_folder = Trash
+                   sent_folder = Sent
+                  draft_folder = Drafts
+            show_prefix_option = false
+          default_sub_of_inbox = false
+show_contain_subfolders_option = false
+            optional_delimiter = / (can be set to 'detect')
+                 delete_folder = true
+      force_username_lowercase = false (depends on checkpassword)
+
+* Default (1.3.4) configuration with IMAPdir depot - same as dovecot ?
+              imap_server_type = bincimap
+         default_folder_prefix = <none> (is set to empty string)
+                  trash_folder = Trash
+                   sent_folder = Sent
+                  draft_folder = Drafts
+            show_prefix_option = false
+          default_sub_of_inbox = false
+show_contain_subfolders_option = false
+            optional_delimiter = / (can be set to 'detect')
+                 delete_folder = true
+      force_username_lowercase = false (depends on checkpassword)
+
+
+* Configuration with Maildir++ depot and . delimiter - use courier preset.