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