doc/presets.txt

   1 $Date$
   2
   3 This file lists the SquirrelMail settings set by option D in conf.pl
   4
   5 These can be used if the administrator can't run conf.pl and wants to
   6 change these settings manually.  These settings can be different if
   7 the IMAP server uses shared folders.
   8
   9 Possible server type values are:
  10  bincimap    = Binc IMAP server
  11  courier     = Courier IMAP server
  12  cyrus       = Cyrus IMAP server
  13  dovecot     = Dovecot Secure IMAP server
  14  exchange    = Microsoft Exchange IMAP server
  15  hmailserver = hMailServer
  16  macosx      = Mac OS X Mailserver
  17  mercury32   = Mercury/32
  18  uw          = University of Washington's IMAP server
  19
  20 -----------------
  21 default settings:
  22 -----------------
  23
  24               imap_server_type = other
  25          default_folder_prefix = <none> (is set to empty string)
  26                   trash_folder = INBOX.Trash
  27                    sent_folder = INBOX.Sent
  28                   draft_folder = INBOX.Drafts
  29             show_prefix_option = false
  30           default_sub_of_inbox = true
  31 show_contain_subfolders_option = false
  32             optional_delimiter = detect
  33                  delete_folder = false
  34       force_username_lowercase = false
  35
  36 -----------------
  37 'cyrus' settings:
  38 -----------------
  39 Server supports server side sorting since 2.0.4 version. euc-jp, euc-kr,
  40 tis-620, cp1251, cp1255 character sets are not supported by sorting functions
  41 (v.2.2.12).
  42
  43               imap_server_type = cyrus
  44          default_folder_prefix = <none> (is set to empty string)
  45                   trash_folder = INBOX.Trash
  46                    sent_folder = INBOX.Sent
  47                   draft_folder = INBOX.Drafts
  48             show_prefix_option = false
  49           default_sub_of_inbox = true
  50 show_contain_subfolders_option = false
  51             optional_delimiter = .
  52                  delete_folder = true
  53       force_username_lowercase = false
  54
  55 --------------
  56 'uw' settings:
  57 --------------
  58 Server supports server side sorting. Plain text logins are disabled by default.
  59
  60               imap_server_type = uw
  61          default_folder_prefix = mail/
  62                   trash_folder = Trash
  63                    sent_folder = Sent
  64                   draft_folder = Drafts
  65             show_prefix_option = true
  66           default_sub_of_inbox = false
  67 show_contain_subfolders_option = true
  68             optional_delimiter = /
  69                  delete_folder = true
  70       force_username_lowercase = true
  71
  72 --------------------
  73 'exchange' settings:
  74 --------------------
  75 Server does not support server side sorting.
  76
  77               imap_server_type = exchange
  78          default_folder_prefix = <none> (is set to empty string)
  79                   trash_folder = INBOX/Deleted Items
  80                    sent_folder = INBOX/Sent Items
  81                   draft_folder = Drafts
  82             show_prefix_option = false
  83           default_sub_of_inbox = true
  84 show_contain_subfolders_option = false
  85             optional_delimiter = detect
  86                  delete_folder = true
  87       force_username_lowercase = true
  88
  89 -------------------
  90 'courier' settings:
  91 -------------------
  92 Fast, scalable, enterprise IMAP server that uses Maildirs
  93
  94 Server supports server side sorting. SquirrelMail can issue IMAP commands
  95 that are supported only when courier-imap is compiled with --enable-unicode
  96 option.
  97
  98               imap_server_type = courier
  99          default_folder_prefix = INBOX.
 100                   trash_folder = Trash
 101                    sent_folder = Sent
 102                   draft_folder = Drafts
 103             show_prefix_option = false
 104           default_sub_of_inbox = false
 105 show_contain_subfolders_option = false
 106             optional_delimiter = .
 107                  delete_folder = true
 108       force_username_lowercase = false
 109
 110 ------------------
 111 'macosx' settings:
 112 ------------------
 113               imap_server_type = macosx
 114          default_folder_prefix = INBOX/
 115                   trash_folder = Trash
 116                    sent_folder = Sent
 117                   draft_folder = Drafts
 118             show_prefix_option = false
 119           default_sub_of_inbox = true
 120 show_contain_subfolders_option = false
 121             optional_delimiter = detect
 122                  delete_folder = true
 123       force_username_lowercase = false
 124
 125 -----------------------
 126 'hmailserver' settings:
 127 -----------------------
 128 Preset is used with hMailServer IMAP server. Available since SquirrelMail 1.5.1
 129 and 1.4.4. Open source email server for WinNT and later.
 130
 131               imap_server_type = hmailserver   (used in imap_search.php)
 132          default_folder_prefix = <none> (is set to empty string)
 133                   trash_folder = INBOX.Trash
 134                    sent_folder = INBOX.Sent
 135                   draft_folder = INBOX.Drafts
 136             show_prefix_option = false
 137           default_sub_of_inbox = true
 138 show_contain_subfolders_option = false
 139             optional_delimiter = detect
 140                  delete_folder = false
 141       force_username_lowercase = false
 142
 143 ---------------------
 144 'mercury32' settings:
 145 ---------------------
 146 Preset is used for Mercury Mail Transport System. Available since 1.5.0 and 1.4.6.
 147 Free email server for Win32 and Netware.
 148
 149 Comments:
 150 * Server side sorting and threading are not supported.
 151 * Message flags are not supported.
 152 * IMAP folders can store messages _or_ other folders.
 153 * Supports STARTTLS, if configured.
 154 * May have issues with 8bit IMAP folder names.
 155
 156 $imap_server_type variable is used to handle imap folder subscription
 157 differences.
 158
 159               imap_server_type = mercury32
 160          default_folder_prefix = <none> (is set to empty string)
 161                   trash_folder = Trash
 162                    sent_folder = Sent
 163                   draft_folder = Drafts
 164             show_prefix_option = false
 165           default_sub_of_inbox = true
 166 show_contain_subfolders_option = true
 167             optional_delimiter = detect
 168                  delete_folder = true
 169       force_username_lowercase = true
 170
 171 -------------------
 172 'dovecot' settings:
 173 -------------------
 174 Preset used for Dovecot Secure IMAP server. Available since 1.5.1 and 1.4.6.
 175
 176 There is no code specific to Dovecot IMAP server. Preset provides only a quick
 177 way to set correct folder settings. Preset works with any IMAP server that does
 178 not store IMAP folders under INBOX and IMAP folders can store messages and other
 179 folders. Preset can also be used with Bejy IMAP server.
 180
 181 IMAP server supports server side sorting and threading.
 182
 183               imap_server_type = dovecot
 184          default_folder_prefix = <none> (is set to empty string)
 185                   trash_folder = Trash
 186                    sent_folder = Sent
 187                   draft_folder = Drafts
 188             show_prefix_option = false
 189           default_sub_of_inbox = false
 190 show_contain_subfolders_option = false
 191             optional_delimiter = detect
 192                  delete_folder = false
 193       force_username_lowercase = true
 194
 195
 196 --------------------
 197 'bincimap' settings:
 198 --------------------
 199 Preset is used with Binc IMAP server. Available since 1.5.1 and 1.4.6.
 200
 201 IMAP server does not support server side sorting and threading. Plain text
 202 logins are disabled by default. Due to available storage backend configuration
 203 options it is impossible to create single preset, which covers all setups.
 204
 205 * Default (1.2.13) configuration with Maildir++ depot and / delimiter
 206               imap_server_type = bincimap (is used to handle INBOX in folder management)
 207          default_folder_prefix = INBOX/
 208                   trash_folder = Trash
 209                    sent_folder = Sent
 210                   draft_folder = Drafts
 211             show_prefix_option = false
 212           default_sub_of_inbox = false
 213 show_contain_subfolders_option = false
 214             optional_delimiter = / (can be set to 'detect')
 215                  delete_folder = true
 216       force_username_lowercase = false (depends on checkpassword)
 217
 218 * Default (1.3.4) configuration with IMAPdir depot - same as dovecot ?
 219               imap_server_type = bincimap
 220          default_folder_prefix = <none> (is set to empty string)
 221                   trash_folder = Trash
 222                    sent_folder = Sent
 223                   draft_folder = Drafts
 224             show_prefix_option = false
 225           default_sub_of_inbox = false
 226 show_contain_subfolders_option = false
 227             optional_delimiter = / (can be set to 'detect')
 228                  delete_folder = true
 229       force_username_lowercase = false (depends on checkpassword)
 230
 231
 232 * Configuration with Maildir++ depot and . delimiter - use courier preset.