doc/presets.txt

   1 $Date$
   2
   3 This file lists SquirrelMail options set by D option in conf.pl
   4
   5 It can be used if user can't run conf.pl and changes options manually.
   6 Settings can be different if IMAP server uses shared folders.
   7
   8 Possible server values are:
   9  bincimap    = Binc IMAP server
  10  courier     = Courier IMAP server
  11  cyrus       = Cyrus IMAP server
  12  dovecot     = Dovecot Secure IMAP server
  13  exchange    = Microsoft Exchange IMAP server
  14  hmailserver = hMailServer
  15  macosx      = Mac OS X Mailserver
  16  mercury32   = Mercury/32
  17  uw          = University of Washington's IMAP server
  18
  19 -----------------
  20 default settings:
  21 -----------------
  22
  23               imap_server_type = other
  24          default_folder_prefix = <none> (is set to empty string)
  25                   trash_folder = INBOX.Trash
  26                    sent_folder = INBOX.Sent
  27                   draft_folder = INBOX.Drafts
  28             show_prefix_option = false
  29           default_sub_of_inbox = true
  30 show_contain_subfolders_option = false
  31             optional_delimiter = detect
  32                  delete_folder = false
  33       force_username_lowercase = false
  34
  35 -----------------
  36 'cyrus' settings:
  37 -----------------
  38 Server supports server side sorting since 2.0.4 version. euc-jp, euc-kr,
  39 tis-620, cp1251, cp1255 character sets are not supported by sorting functions
  40 (v.2.2.12).
  41
  42               imap_server_type = cyrus
  43          default_folder_prefix = <none> (is set to empty string)
  44                   trash_folder = INBOX.Trash
  45                    sent_folder = INBOX.Sent
  46                   draft_folder = INBOX.Drafts
  47             show_prefix_option = false
  48           default_sub_of_inbox = true
  49 show_contain_subfolders_option = false
  50             optional_delimiter = .
  51                  delete_folder = true
  52       force_username_lowercase = false
  53
  54 --------------
  55 'uw' settings:
  56 --------------
  57 Server supports server side sorting. Plain text logins are disabled by default.
  58
  59 CAPABILITY IMAP4REV1 IDLE NAMESPACE MAILBOX-REFERRALS BINARY UNSELECT SCAN SORT
  60  THREAD=REFERENCES THREAD=ORDEREDSUBJECT MULTIAPPEND LOGIN-REFERRALS STARTTLS
  61  AUTH=LOGIN
  62 PERMANENTFLAGS (Seen \* \Answered \Flagged \Deleted \Draft \Seen)
  63
  64               imap_server_type = uw
  65          default_folder_prefix = mail/
  66                   trash_folder = Trash
  67                    sent_folder = Sent
  68                   draft_folder = Drafts
  69             show_prefix_option = true
  70           default_sub_of_inbox = false
  71 show_contain_subfolders_option = true
  72             optional_delimiter = /
  73                  delete_folder = true
  74       force_username_lowercase = true
  75
  76 --------------------
  77 'exchange' settings:
  78 --------------------
  79 Server does not support server side sorting.
  80               imap_server_type = exchange
  81          default_folder_prefix = <none> (is set to empty string)
  82                   trash_folder = INBOX/Deleted Items
  83                    sent_folder = INBOX/Sent Items
  84                   draft_folder = Drafts
  85             show_prefix_option = false
  86           default_sub_of_inbox = true
  87 show_contain_subfolders_option = false
  88             optional_delimiter = detect
  89                  delete_folder = true
  90       force_username_lowercase = true
  91
  92 -------------------
  93 'courier' settings:
  94 -------------------
  95 Fast, scalable, enterprise IMAP server that uses Maildirs
  96
  97 CAPABILITY IMAP4rev1 UIDPLUS CHILDREN NAMESPACE THREAD=ORDEREDSUBJECT
  98  THREAD=REFERENCES SORT QUOTA IDLE ACL ACL2=UNION
  99
 100 PERMANENTFLAGS (\* \Draft \Answered \Flagged \Deleted \Seen)
 101
 102 Recent (3.0.0+) versions support most of character sets used by SquirrelMail,
 103 if courier-imap is compiled with --enable-unicode option. Only koi8-u
 104 is not supported. Server can be compiled with custom number of supported
 105 character sets. Sorting can be disabled in imapd configuration. Capability
 106 string can be set in configuration. Supports CRAM-MD5, CRAM-SHA1 and
 107 CRAM-SHA256, if userdb or other backend stores passwords in plain text. Does
 108 not handle traditional mailbox files.
 109
 110 Site URL: http://www.courier-mta.org/
 111
 112               imap_server_type = courier
 113          default_folder_prefix = INBOX.
 114                   trash_folder = Trash
 115                    sent_folder = Sent
 116                   draft_folder = Drafts
 117             show_prefix_option = false
 118           default_sub_of_inbox = false
 119 show_contain_subfolders_option = false
 120             optional_delimiter = .
 121                  delete_folder = true
 122       force_username_lowercase = false
 123
 124 ------------------
 125 'macosx' settings:
 126 ------------------
 127               imap_server_type = macosx
 128          default_folder_prefix = INBOX/
 129                   trash_folder = Trash
 130                    sent_folder = Sent
 131                   draft_folder = Drafts
 132             show_prefix_option = false
 133           default_sub_of_inbox = true
 134 show_contain_subfolders_option = false
 135             optional_delimiter = detect
 136                  delete_folder = true
 137       force_username_lowercase = false
 138
 139 -----------------------
 140 'hmailserver' settings:
 141 -----------------------
 142 Preset is used with hMailServer IMAP server. Available since SquirrelMail 1.5.1
 143 and 1.4.4. Open source email server for WinNT and later.
 144
 145 Tested 4.1.1 (Build 140).
 146 CAPABILITY IMAP4 IMAP4rev1 QUOTA
 147 PERMANENTFLAGS (\Deleted \Seen \Draft \Answered \Flagged)
 148
 149 Site URL: http://www.hmailserver.com/
 150
 151               imap_server_type = hmailserver   (used in imap_search.php)
 152          default_folder_prefix = <none> (is set to empty string)
 153                   trash_folder = INBOX.Trash
 154                    sent_folder = INBOX.Sent
 155                   draft_folder = INBOX.Drafts
 156             show_prefix_option = false
 157           default_sub_of_inbox = true
 158 show_contain_subfolders_option = false
 159             optional_delimiter = detect
 160                  delete_folder = false
 161       force_username_lowercase = false
 162
 163 ---------------------
 164 'mercury32' settings:
 165 ---------------------
 166 Preset is used for Mercury Mail Transport System. Available since 1.5.0 and 1.4.6.
 167 Free email server for Win32 and Netware.
 168 Tested Win32 v.4.01b
 169 CAPABILITY IMAP4rev1 X-MERCURY
 170 PERMANENTFLAGS (\Deleted \Draft \Seen \Answered)
 171
 172 Comments:
 173 * Server side sorting and threading are not supported.
 174 * Message flags are not supported.
 175 * IMAP folders can store messages _or_ other folders.
 176 * Supports STARTTLS, if configured.
 177 * May have issues with 8bit IMAP folder names.
 178
 179 $imap_server_type variable is used to handle imap folder subscription
 180 differences.
 181
 182 Site URL: http://www.pmail.com
 183
 184               imap_server_type = mercury32
 185          default_folder_prefix = <none> (is set to empty string)
 186                   trash_folder = Trash
 187                    sent_folder = Sent
 188                   draft_folder = Drafts
 189             show_prefix_option = false
 190           default_sub_of_inbox = true
 191 show_contain_subfolders_option = true
 192             optional_delimiter = detect
 193                  delete_folder = true
 194       force_username_lowercase = true
 195
 196 -------------------
 197 'dovecot' settings:
 198 -------------------
 199 Preset used for Dovecot Secure IMAP server. Available since 1.5.1 and 1.4.6.
 200
 201 There is no code specific to Dovecot IMAP server. Preset provides only a quick
 202 way to set correct folder settings.
 203
 204 Tested v.0.99.14
 205
 206 CAPABILITY IMAP4rev1 SORT THREAD=REFERENCES MULTIAPPEND UNSELECT LITERAL+ IDLE
 207   CHILDREN LISTEXT LIST-SUBSCRIBED NAMESPACE
 208
 209 PERMANENTFLAGS (\Answered \Flagged \Deleted \Seen \Draft \*)
 210
 211 IMAP server supports server side sorting and threading.
 212
 213 Site URL: http://www.dovecot.org
 214
 215               imap_server_type = dovecot
 216          default_folder_prefix = <none> (is set to empty string)
 217                   trash_folder = Trash
 218                    sent_folder = Sent
 219                   draft_folder = Drafts
 220             show_prefix_option = false
 221           default_sub_of_inbox = false
 222 show_contain_subfolders_option = false
 223             optional_delimiter = detect
 224                  delete_folder = false
 225       force_username_lowercase = true
 226
 227
 228 --------------------
 229 'bincimap' settings:
 230 --------------------
 231 Preset is used with Binc IMAP server. Available since 1.5.1 and 1.4.6.
 232 Tested v.1.2.13 and 1.3.4
 233
 234 CAPABILITY IMAP4rev1 STARTTLS AUTH=LOGIN AUTH=PLAIN (1.2.13)
 235 CAPABILITY IMAP4rev1 STARTTLS AUTH=LOGIN AUTH=PLAIN IDLE LITERAL+ NAMESPACE CHILDREN (1.3.4)
 236
 237 PERMANENTFLAGS (\Answered \Flagged \Deleted \Seen \Draft) - 1.2.13
 238 PERMANENTFLAGS (\Answered \Flagged \Deleted \Seen \Draft \*) - 1.3.4
 239
 240 IMAP server does not support server side sorting and threading. Plain text
 241 logins are disabled by default. Due to available storage backend configuration
 242 options it is impossible to create single preset, which covers all setups.
 243
 244 Site URL: http://www.bincimap.org
 245
 246 * Default (1.2.13) configuration with Maildir++ depot and / delimiter
 247               imap_server_type = bincimap (is used to handle INBOX in folder management)
 248          default_folder_prefix = INBOX/
 249                   trash_folder = Trash
 250                    sent_folder = Sent
 251                   draft_folder = Drafts
 252             show_prefix_option = false
 253           default_sub_of_inbox = false
 254 show_contain_subfolders_option = false
 255             optional_delimiter = / (can be set to 'detect')
 256                  delete_folder = true
 257       force_username_lowercase = false (depends on checkpassword)
 258
 259 * Default (1.3.4) configuration with IMAPdir depot - same as dovecot ?
 260               imap_server_type = bincimap
 261          default_folder_prefix = <none> (is set to empty string)
 262                   trash_folder = Trash
 263                    sent_folder = Sent
 264                   draft_folder = Drafts
 265             show_prefix_option = false
 266           default_sub_of_inbox = false
 267 show_contain_subfolders_option = false
 268             optional_delimiter = / (can be set to 'detect')
 269                  delete_folder = true
 270       force_username_lowercase = false (depends on checkpassword)
 271
 272
 273 * Configuration with Maildir++ depot and . delimiter - use courier preset.