cyrus capability and permanent flags
[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
f965aa90 42CAPABILITY IMAP4 IMAP4rev1 ACL QUOTA LITERAL+ MAILBOX-REFERRALS NAMESPACE
43 UIDPLUS ID NO_ATOMIC_RENAME UNSELECT CHILDREN MULTIAPPEND BINARY SORT
44 THREAD=ORDEREDSUBJECT THREAD=REFERENCES ANNOTATEMORE IDLE LISTEXT
45 LIST-SUBSCRIBED X-NETSCAPE
46
47PERMANENTFLAGS (\Answered \Flagged \Draft \Deleted \Seen $MDNSent \*)
48
7d64a0e4 49 imap_server_type = cyrus
67a24f8a 50 default_folder_prefix = <none> (is set to empty string)
7d64a0e4 51 trash_folder = INBOX.Trash
52 sent_folder = INBOX.Sent
53 draft_folder = INBOX.Drafts
54 show_prefix_option = false
55 default_sub_of_inbox = true
56show_contain_subfolders_option = false
57 optional_delimiter = .
58 delete_folder = true
59 force_username_lowercase = false
60
61--------------
62'uw' settings:
63--------------
528ac05d 64Server supports server side sorting. Plain text logins are disabled by default.
65
66CAPABILITY IMAP4REV1 IDLE NAMESPACE MAILBOX-REFERRALS BINARY UNSELECT SCAN SORT
67 THREAD=REFERENCES THREAD=ORDEREDSUBJECT MULTIAPPEND LOGIN-REFERRALS STARTTLS
68 AUTH=LOGIN
69PERMANENTFLAGS (Seen \* \Answered \Flagged \Deleted \Draft \Seen)
70
7d64a0e4 71 imap_server_type = uw
72 default_folder_prefix = mail/
73 trash_folder = Trash
74 sent_folder = Sent
75 draft_folder = Drafts
76 show_prefix_option = true
77 default_sub_of_inbox = false
78show_contain_subfolders_option = true
79 optional_delimiter = /
80 delete_folder = true
81 force_username_lowercase = true
82
83--------------------
84'exchange' settings:
85--------------------
528ac05d 86Server does not support server side sorting.
7d64a0e4 87 imap_server_type = exchange
67a24f8a 88 default_folder_prefix = <none> (is set to empty string)
7d64a0e4 89 trash_folder = INBOX/Deleted Items
90 sent_folder = INBOX/Sent Items
91 draft_folder = Drafts
92 show_prefix_option = false
93 default_sub_of_inbox = true
94show_contain_subfolders_option = false
95 optional_delimiter = detect
96 delete_folder = true
97 force_username_lowercase = true
98
99-------------------
100'courier' settings:
101-------------------
528ac05d 102Fast, scalable, enterprise IMAP server that uses Maildirs
103
104CAPABILITY IMAP4rev1 UIDPLUS CHILDREN NAMESPACE THREAD=ORDEREDSUBJECT
105 THREAD=REFERENCES SORT QUOTA IDLE ACL ACL2=UNION
106
107PERMANENTFLAGS (\* \Draft \Answered \Flagged \Deleted \Seen)
108
109Recent (3.0.0+) versions support most of character sets used by SquirrelMail,
110if courier-imap is compiled with --enable-unicode option. Only koi8-u
111is not supported. Server can be compiled with custom number of supported
112character sets. Sorting can be disabled in imapd configuration. Capability
113string can be set in configuration. Supports CRAM-MD5, CRAM-SHA1 and
114CRAM-SHA256, if userdb or other backend stores passwords in plain text. Does
115not handle traditional mailbox files.
116
117Site URL: http://www.courier-mta.org/
118
7d64a0e4 119 imap_server_type = courier
120 default_folder_prefix = INBOX.
121 trash_folder = Trash
122 sent_folder = Sent
123 draft_folder = Drafts
124 show_prefix_option = false
125 default_sub_of_inbox = false
126show_contain_subfolders_option = false
127 optional_delimiter = .
128 delete_folder = true
129 force_username_lowercase = false
130
131------------------
132'macosx' settings:
133------------------
134 imap_server_type = macosx
135 default_folder_prefix = INBOX/
136 trash_folder = Trash
137 sent_folder = Sent
138 draft_folder = Drafts
139 show_prefix_option = false
140 default_sub_of_inbox = true
141show_contain_subfolders_option = false
142 optional_delimiter = detect
143 delete_folder = true
144 force_username_lowercase = false
145
946b11e9 146-----------------------
b39825f0 147'hmailserver' settings:
946b11e9 148-----------------------
2fcfa930 149Preset is used with hMailServer IMAP server. Available since SquirrelMail 1.5.1
150and 1.4.4. Open source email server for WinNT and later.
151
152Tested 4.1.1 (Build 140).
153CAPABILITY IMAP4 IMAP4rev1 QUOTA
154PERMANENTFLAGS (\Deleted \Seen \Draft \Answered \Flagged)
155
156Site URL: http://www.hmailserver.com/
157
b39825f0 158 imap_server_type = hmailserver (used in imap_search.php)
67a24f8a 159 default_folder_prefix = <none> (is set to empty string)
946b11e9 160 trash_folder = INBOX.Trash
161 sent_folder = INBOX.Sent
162 draft_folder = INBOX.Drafts
163 show_prefix_option = false
164 default_sub_of_inbox = true
165show_contain_subfolders_option = false
166 optional_delimiter = detect
167 delete_folder = false
168 force_username_lowercase = false
b39825f0 169
aae1fc46 170---------------------
171'mercury32' settings:
172---------------------
46729396 173Preset is used for Mercury Mail Transport System. Available since 1.5.0 and 1.4.6.
aae1fc46 174Free email server for Win32 and Netware.
175Tested Win32 v.4.01b
176CAPABILITY IMAP4rev1 X-MERCURY
177PERMANENTFLAGS (\Deleted \Draft \Seen \Answered)
178
179Comments:
180* Server side sorting and threading are not supported.
181* Message flags are not supported.
182* IMAP folders can store messages _or_ other folders.
183* Supports STARTTLS, if configured.
184* May have issues with 8bit IMAP folder names.
185
186$imap_server_type variable is used to handle imap folder subscription
187differences.
188
67a24f8a 189Site URL: http://www.pmail.com
190
7d64a0e4 191 imap_server_type = mercury32
67a24f8a 192 default_folder_prefix = <none> (is set to empty string)
aae1fc46 193 trash_folder = Trash
194 sent_folder = Sent
195 draft_folder = Drafts
7d64a0e4 196 show_prefix_option = false
197 default_sub_of_inbox = true
198show_contain_subfolders_option = true
199 optional_delimiter = detect
200 delete_folder = true
201 force_username_lowercase = true
202
67a24f8a 203-------------------
204'dovecot' settings:
205-------------------
46729396 206Preset used for Dovecot Secure IMAP server. Available since 1.5.1 and 1.4.6.
67a24f8a 207
208There is no code specific to Dovecot IMAP server. Preset provides only a quick
209way to set correct folder settings.
210
211Tested v.0.99.14
212
213CAPABILITY IMAP4rev1 SORT THREAD=REFERENCES MULTIAPPEND UNSELECT LITERAL+ IDLE
214 CHILDREN LISTEXT LIST-SUBSCRIBED NAMESPACE
215
216PERMANENTFLAGS (\Answered \Flagged \Deleted \Seen \Draft \*)
217
218IMAP server supports server side sorting and threading.
219
220Site URL: http://www.dovecot.org
221
222 imap_server_type = dovecot
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
229show_contain_subfolders_option = false
230 optional_delimiter = detect
231 delete_folder = false
232 force_username_lowercase = true
233
234
2beddb11 235--------------------
236'bincimap' settings:
237--------------------
46729396 238Preset is used with Binc IMAP server. Available since 1.5.1 and 1.4.6.
2beddb11 239Tested v.1.2.13 and 1.3.4
240
241CAPABILITY IMAP4rev1 STARTTLS AUTH=LOGIN AUTH=PLAIN (1.2.13)
242CAPABILITY IMAP4rev1 STARTTLS AUTH=LOGIN AUTH=PLAIN IDLE LITERAL+ NAMESPACE CHILDREN (1.3.4)
243
244PERMANENTFLAGS (\Answered \Flagged \Deleted \Seen \Draft) - 1.2.13
245PERMANENTFLAGS (\Answered \Flagged \Deleted \Seen \Draft \*) - 1.3.4
246
247IMAP server does not support server side sorting and threading. Plain text
248logins are disabled by default. Due to available storage backend configuration
249options it is impossible to create single preset, which covers all setups.
250
251Site URL: http://www.bincimap.org
252
253* Default (1.2.13) configuration with Maildir++ depot and / delimiter
254 imap_server_type = bincimap (is used to handle INBOX in folder management)
255 default_folder_prefix = INBOX/
256 trash_folder = Trash
257 sent_folder = Sent
258 draft_folder = Drafts
259 show_prefix_option = false
260 default_sub_of_inbox = false
261show_contain_subfolders_option = false
262 optional_delimiter = / (can be set to 'detect')
263 delete_folder = true
264 force_username_lowercase = false (depends on checkpassword)
265
266* Default (1.3.4) configuration with IMAPdir depot - same as dovecot ?
267 imap_server_type = bincimap
268 default_folder_prefix = <none> (is set to empty string)
269 trash_folder = Trash
270 sent_folder = Sent
271 draft_folder = Drafts
272 show_prefix_option = false
273 default_sub_of_inbox = false
274show_contain_subfolders_option = false
275 optional_delimiter = / (can be set to 'detect')
276 delete_folder = true
277 force_username_lowercase = false (depends on checkpassword)
278
279
280* Configuration with Maildir++ depot and . delimiter - use courier preset.