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  cyrus       = Cyrus IMAP server
  10  uw          = University of Washington's IMAP server
  11  exchange    = Microsoft Exchange IMAP server
  12  courier     = Courier IMAP server
  13  macosx      = Mac OS X Mailserver
  14  hmailserver = hMailServer
  15  mercury32   = Mercury/32
  16  dovecot     = Dovecot Secure IMAP server
  17
  18 -----------------
  19 default settings:
  20 -----------------
  21
  22               imap_server_type = other
  23          default_folder_prefix = <none> (is set to empty string)
  24                   trash_folder = INBOX.Trash
  25                    sent_folder = INBOX.Sent
  26                   draft_folder = INBOX.Drafts
  27             show_prefix_option = false
  28           default_sub_of_inbox = true
  29 show_contain_subfolders_option = false
  30             optional_delimiter = detect
  31                  delete_folder = false
  32       force_username_lowercase = false
  33
  34 -----------------
  35 'cyrus' settings:
  36 -----------------
  37               imap_server_type = cyrus
  38          default_folder_prefix = <none> (is set to empty string)
  39                   trash_folder = INBOX.Trash
  40                    sent_folder = INBOX.Sent
  41                   draft_folder = INBOX.Drafts
  42             show_prefix_option = false
  43           default_sub_of_inbox = true
  44 show_contain_subfolders_option = false
  45             optional_delimiter = .
  46                  delete_folder = true
  47       force_username_lowercase = false
  48
  49 --------------
  50 'uw' settings:
  51 --------------
  52               imap_server_type = uw
  53          default_folder_prefix = mail/
  54                   trash_folder = Trash
  55                    sent_folder = Sent
  56                   draft_folder = Drafts
  57             show_prefix_option = true
  58           default_sub_of_inbox = false
  59 show_contain_subfolders_option = true
  60             optional_delimiter = /
  61                  delete_folder = true
  62       force_username_lowercase = true
  63
  64 --------------------
  65 'exchange' settings:
  66 --------------------
  67               imap_server_type = exchange
  68          default_folder_prefix = <none> (is set to empty string)
  69                   trash_folder = INBOX/Deleted Items
  70                    sent_folder = INBOX/Sent Items
  71                   draft_folder = Drafts
  72             show_prefix_option = false
  73           default_sub_of_inbox = true
  74 show_contain_subfolders_option = false
  75             optional_delimiter = detect
  76                  delete_folder = true
  77       force_username_lowercase = true
  78
  79 -------------------
  80 'courier' settings:
  81 -------------------
  82               imap_server_type = courier
  83          default_folder_prefix = INBOX.
  84                   trash_folder = Trash
  85                    sent_folder = Sent
  86                   draft_folder = Drafts
  87             show_prefix_option = false
  88           default_sub_of_inbox = false
  89 show_contain_subfolders_option = false
  90             optional_delimiter = .
  91                  delete_folder = true
  92       force_username_lowercase = false
  93
  94 ------------------
  95 'macosx' settings:
  96 ------------------
  97               imap_server_type = macosx
  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 = true
 104 show_contain_subfolders_option = false
 105             optional_delimiter = detect
 106                  delete_folder = true
 107       force_username_lowercase = false
 108
 109 -----------------------
 110 'hmailserver' settings:
 111 -----------------------
 112               imap_server_type = hmailserver   (used in imap_search.php)
 113          default_folder_prefix = <none> (is set to empty string)
 114                   trash_folder = INBOX.Trash
 115                    sent_folder = INBOX.Sent
 116                   draft_folder = INBOX.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 = false
 122       force_username_lowercase = false
 123
 124 ---------------------
 125 'mercury32' settings:
 126 ---------------------
 127 Preset is used for Mercury Mail Transport System. Available since 1.5.0
 128 Free email server for Win32 and Netware.
 129 Tested Win32 v.4.01b
 130 CAPABILITY IMAP4rev1 X-MERCURY
 131 PERMANENTFLAGS (\Deleted \Draft \Seen \Answered)
 132
 133 Comments:
 134 * Server side sorting and threading are not supported.
 135 * Message flags are not supported.
 136 * IMAP folders can store messages _or_ other folders.
 137 * Supports STARTTLS, if configured.
 138 * May have issues with 8bit IMAP folder names.
 139
 140 $imap_server_type variable is used to handle imap folder subscription
 141 differences.
 142
 143 Site URL: http://www.pmail.com
 144
 145               imap_server_type = mercury32
 146          default_folder_prefix = <none> (is set to empty string)
 147                   trash_folder = Trash
 148                    sent_folder = Sent
 149                   draft_folder = Drafts
 150             show_prefix_option = false
 151           default_sub_of_inbox = true
 152 show_contain_subfolders_option = true
 153             optional_delimiter = detect
 154                  delete_folder = true
 155       force_username_lowercase = true
 156
 157 -------------------
 158 'dovecot' settings:
 159 -------------------
 160 Preset used for Dovecot Secure IMAP server. Available since 1.5.1.
 161
 162 There is no code specific to Dovecot IMAP server. Preset provides only a quick
 163 way to set correct folder settings.
 164
 165 Tested v.0.99.14
 166
 167 CAPABILITY IMAP4rev1 SORT THREAD=REFERENCES MULTIAPPEND UNSELECT LITERAL+ IDLE
 168   CHILDREN LISTEXT LIST-SUBSCRIBED NAMESPACE
 169
 170 PERMANENTFLAGS (\Answered \Flagged \Deleted \Seen \Draft \*)
 171
 172 IMAP server supports server side sorting and threading.
 173
 174 Site URL: http://www.dovecot.org
 175
 176               imap_server_type = dovecot
 177          default_folder_prefix = <none> (is set to empty string)
 178                   trash_folder = Trash
 179                    sent_folder = Sent
 180                   draft_folder = Drafts
 181             show_prefix_option = false
 182           default_sub_of_inbox = false
 183 show_contain_subfolders_option = false
 184             optional_delimiter = detect
 185                  delete_folder = false
 186       force_username_lowercase = true
 187
 188
 189 --------------------
 190 'bincimap' settings:
 191 --------------------
 192
 193 Tested v.1.2.13 and 1.3.4
 194
 195 CAPABILITY IMAP4rev1 STARTTLS AUTH=LOGIN AUTH=PLAIN (1.2.13)
 196 CAPABILITY IMAP4rev1 STARTTLS AUTH=LOGIN AUTH=PLAIN IDLE LITERAL+ NAMESPACE CHILDREN (1.3.4)
 197
 198 PERMANENTFLAGS (\Answered \Flagged \Deleted \Seen \Draft) - 1.2.13
 199 PERMANENTFLAGS (\Answered \Flagged \Deleted \Seen \Draft \*) - 1.3.4
 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 Site URL: http://www.bincimap.org
 206
 207 * Default (1.2.13) configuration with Maildir++ depot and / delimiter
 208               imap_server_type = bincimap (is used to handle INBOX in folder management)
 209          default_folder_prefix = INBOX/
 210                   trash_folder = Trash
 211                    sent_folder = Sent
 212                   draft_folder = Drafts
 213             show_prefix_option = false
 214           default_sub_of_inbox = false
 215 show_contain_subfolders_option = false
 216             optional_delimiter = / (can be set to 'detect')
 217                  delete_folder = true
 218       force_username_lowercase = false (depends on checkpassword)
 219
 220 * Default (1.3.4) configuration with IMAPdir depot - same as dovecot ?
 221               imap_server_type = bincimap
 222          default_folder_prefix = <none> (is set to empty string)
 223                   trash_folder = Trash
 224                    sent_folder = Sent
 225                   draft_folder = Drafts
 226             show_prefix_option = false
 227           default_sub_of_inbox = false
 228 show_contain_subfolders_option = false
 229             optional_delimiter = / (can be set to 'detect')
 230                  delete_folder = true
 231       force_username_lowercase = false (depends on checkpassword)
 232
 233
 234 * Configuration with Maildir++ depot and . delimiter - use courier preset.