Merge of Steve Brown's patch
[squirrelmail.git] / doc / presets.txt
CommitLineData
7d64a0e4 1$Date$
2
598294a7 3This file lists SquirrelMail options set by D option in conf.pl
7d64a0e4 4
5It can be used if user can't run conf.pl and changes options manually.
6Settings can be different if IMAP server uses shared folders.
7
8Possible server values are:
46729396 9 bincimap = Binc IMAP server
10 courier = Courier IMAP server
b39825f0 11 cyrus = Cyrus IMAP server
46729396 12 dovecot = Dovecot Secure IMAP server
b39825f0 13 exchange = Microsoft Exchange IMAP server
b39825f0 14 hmailserver = hMailServer
46729396 15 macosx = Mac OS X Mailserver
b39825f0 16 mercury32 = Mercury/32
46729396 17 uw = University of Washington's IMAP server
7d64a0e4 18
19-----------------
20default settings:
21-----------------
22
23 imap_server_type = other
67a24f8a 24 default_folder_prefix = <none> (is set to empty string)
7d64a0e4 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
30show_contain_subfolders_option = false
31 optional_delimiter = detect
32 delete_folder = false
33 force_username_lowercase = false
34
35-----------------
36'cyrus' settings:
37-----------------
528ac05d 38Server supports server side sorting since 2.0.4 version. euc-jp, euc-kr,
39tis-620, cp1251, cp1255 character sets are not supported by sorting functions
40(v.2.2.12).
41
7d64a0e4 42 imap_server_type = cyrus
67a24f8a 43 default_folder_prefix = <none> (is set to empty string)
7d64a0e4 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
49show_contain_subfolders_option = false
50 optional_delimiter = .
51 delete_folder = true
52 force_username_lowercase = false
53
54--------------
55'uw' settings:
56--------------
528ac05d 57Server supports server side sorting. Plain text logins are disabled by default.
58
7d64a0e4 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
66show_contain_subfolders_option = true
67 optional_delimiter = /
68 delete_folder = true
69 force_username_lowercase = true
70
71--------------------
72'exchange' settings:
73--------------------
528ac05d 74Server does not support server side sorting.
8da3b983 75
7d64a0e4 76 imap_server_type = exchange
67a24f8a 77 default_folder_prefix = <none> (is set to empty string)
7d64a0e4 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
83show_contain_subfolders_option = false
84 optional_delimiter = detect
85 delete_folder = true
86 force_username_lowercase = true
87
88-------------------
89'courier' settings:
90-------------------
528ac05d 91Fast, scalable, enterprise IMAP server that uses Maildirs
92
8da3b983 93Server supports server side sorting. SquirrelMail can issue IMAP commands
94that are supported only when courier-imap is compiled with --enable-unicode
95option.
528ac05d 96
7d64a0e4 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
104show_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
119show_contain_subfolders_option = false
120 optional_delimiter = detect
121 delete_folder = true
122 force_username_lowercase = false
123
946b11e9 124-----------------------
b39825f0 125'hmailserver' settings:
946b11e9 126-----------------------
2fcfa930 127Preset is used with hMailServer IMAP server. Available since SquirrelMail 1.5.1
128and 1.4.4. Open source email server for WinNT and later.
129
b39825f0 130 imap_server_type = hmailserver (used in imap_search.php)
67a24f8a 131 default_folder_prefix = <none> (is set to empty string)
946b11e9 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
137show_contain_subfolders_option = false
138 optional_delimiter = detect
139 delete_folder = false
140 force_username_lowercase = false
b39825f0 141
aae1fc46 142---------------------
143'mercury32' settings:
144---------------------
46729396 145Preset is used for Mercury Mail Transport System. Available since 1.5.0 and 1.4.6.
aae1fc46 146Free email server for Win32 and Netware.
aae1fc46 147
148Comments:
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
156differences.
157
7d64a0e4 158 imap_server_type = mercury32
67a24f8a 159 default_folder_prefix = <none> (is set to empty string)
aae1fc46 160 trash_folder = Trash
161 sent_folder = Sent
162 draft_folder = Drafts
7d64a0e4 163 show_prefix_option = false
164 default_sub_of_inbox = true
165show_contain_subfolders_option = true
166 optional_delimiter = detect
167 delete_folder = true
168 force_username_lowercase = true
169
67a24f8a 170-------------------
171'dovecot' settings:
172-------------------
46729396 173Preset used for Dovecot Secure IMAP server. Available since 1.5.1 and 1.4.6.
67a24f8a 174
175There is no code specific to Dovecot IMAP server. Preset provides only a quick
176way to set correct folder settings.
177
67a24f8a 178IMAP server supports server side sorting and threading.
179
67a24f8a 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
187show_contain_subfolders_option = false
188 optional_delimiter = detect
189 delete_folder = false
190 force_username_lowercase = true
191
192
2beddb11 193--------------------
194'bincimap' settings:
195--------------------
46729396 196Preset is used with Binc IMAP server. Available since 1.5.1 and 1.4.6.
2beddb11 197
198IMAP server does not support server side sorting and threading. Plain text
199logins are disabled by default. Due to available storage backend configuration
200options it is impossible to create single preset, which covers all setups.
201
2beddb11 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
210show_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
223show_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.