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               imap_server_type = uw
  60          default_folder_prefix = mail/
  61                   trash_folder = Trash
  62                    sent_folder = Sent
  63                   draft_folder = Drafts
  64             show_prefix_option = true
  65           default_sub_of_inbox = false
  66 show_contain_subfolders_option = true
  67             optional_delimiter = /
  68                  delete_folder = true
  69       force_username_lowercase = true
  70
  71 --------------------
  72 'exchange' settings:
  73 --------------------
  74 Server does not support server side sorting.
  75
  76               imap_server_type = exchange
  77          default_folder_prefix = <none> (is set to empty string)
  78                   trash_folder = INBOX/Deleted Items
  79                    sent_folder = INBOX/Sent Items
  80                   draft_folder = Drafts
  81             show_prefix_option = false
  82           default_sub_of_inbox = true
  83 show_contain_subfolders_option = false
  84             optional_delimiter = detect
  85                  delete_folder = true
  86       force_username_lowercase = true
  87
  88 -------------------
  89 'courier' settings:
  90 -------------------
  91 Fast, scalable, enterprise IMAP server that uses Maildirs
  92
  93 Server supports server side sorting. SquirrelMail can issue IMAP commands
  94 that are supported only when courier-imap is compiled with --enable-unicode
  95 option.
  96
  97               imap_server_type = courier
  98          default_folder_prefix = INBOX.
  99                   trash_folder = Trash
 100                    sent_folder = Sent
 101                   draft_folder = Drafts
 102             show_prefix_option = false
 103           default_sub_of_inbox = false
 104 show_contain_subfolders_option = false
 105             optional_delimiter = .
 106                  delete_folder = true
 107       force_username_lowercase = false
 108
 109 ------------------
 110 'macosx' settings:
 111 ------------------
 112               imap_server_type = macosx
 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 = true
 119 show_contain_subfolders_option = false
 120             optional_delimiter = detect
 121                  delete_folder = true
 122       force_username_lowercase = false
 123
 124 -----------------------
 125 'hmailserver' settings:
 126 -----------------------
 127 Preset is used with hMailServer IMAP server. Available since SquirrelMail 1.5.1
 128 and 1.4.4. Open source email server for WinNT and later.
 129
 130               imap_server_type = hmailserver   (used in imap_search.php)
 131          default_folder_prefix = <none> (is set to empty string)
 132                   trash_folder = INBOX.Trash
 133                    sent_folder = INBOX.Sent
 134                   draft_folder = INBOX.Drafts
 135             show_prefix_option = false
 136           default_sub_of_inbox = true
 137 show_contain_subfolders_option = false
 138             optional_delimiter = detect
 139                  delete_folder = false
 140       force_username_lowercase = false
 141
 142 ---------------------
 143 'mercury32' settings:
 144 ---------------------
 145 Preset is used for Mercury Mail Transport System. Available since 1.5.0 and 1.4.6.
 146 Free email server for Win32 and Netware.
 147
 148 Comments:
 149 * Server side sorting and threading are not supported.
 150 * Message flags are not supported.
 151 * IMAP folders can store messages _or_ other folders.
 152 * Supports STARTTLS, if configured.
 153 * May have issues with 8bit IMAP folder names.
 154
 155 $imap_server_type variable is used to handle imap folder subscription
 156 differences.
 157
 158               imap_server_type = mercury32
 159          default_folder_prefix = <none> (is set to empty string)
 160                   trash_folder = Trash
 161                    sent_folder = Sent
 162                   draft_folder = Drafts
 163             show_prefix_option = false
 164           default_sub_of_inbox = true
 165 show_contain_subfolders_option = true
 166             optional_delimiter = detect
 167                  delete_folder = true
 168       force_username_lowercase = true
 169
 170 -------------------
 171 'dovecot' settings:
 172 -------------------
 173 Preset used for Dovecot Secure IMAP server. Available since 1.5.1 and 1.4.6.
 174
 175 There is no code specific to Dovecot IMAP server. Preset provides only a quick
 176 way to set correct folder settings.
 177
 178 IMAP server supports server side sorting and threading.
 179
 180               imap_server_type = dovecot
 181          default_folder_prefix = <none> (is set to empty string)
 182                   trash_folder = Trash
 183                    sent_folder = Sent
 184                   draft_folder = Drafts
 185             show_prefix_option = false
 186           default_sub_of_inbox = false
 187 show_contain_subfolders_option = false
 188             optional_delimiter = detect
 189                  delete_folder = false
 190       force_username_lowercase = true
 191
 192
 193 --------------------
 194 'bincimap' settings:
 195 --------------------
 196 Preset is used with Binc IMAP server. Available since 1.5.1 and 1.4.6.
 197
 198 IMAP server does not support server side sorting and threading. Plain text
 199 logins are disabled by default. Due to available storage backend configuration
 200 options it is impossible to create single preset, which covers all setups.
 201
 202 * Default (1.2.13) configuration with Maildir++ depot and / delimiter
 203               imap_server_type = bincimap (is used to handle INBOX in folder management)
 204          default_folder_prefix = INBOX/
 205                   trash_folder = Trash
 206                    sent_folder = Sent
 207                   draft_folder = Drafts
 208             show_prefix_option = false
 209           default_sub_of_inbox = false
 210 show_contain_subfolders_option = false
 211             optional_delimiter = / (can be set to 'detect')
 212                  delete_folder = true
 213       force_username_lowercase = false (depends on checkpassword)
 214
 215 * Default (1.3.4) configuration with IMAPdir depot - same as dovecot ?
 216               imap_server_type = bincimap
 217          default_folder_prefix = <none> (is set to empty string)
 218                   trash_folder = Trash
 219                    sent_folder = Sent
 220                   draft_folder = Drafts
 221             show_prefix_option = false
 222           default_sub_of_inbox = false
 223 show_contain_subfolders_option = false
 224             optional_delimiter = / (can be set to 'detect')
 225                  delete_folder = true
 226       force_username_lowercase = false (depends on checkpassword)
 227
 228
 229 * Configuration with Maildir++ depot and . delimiter - use courier preset.